基于Log4Net本地日志服务简单实现

其他 2019-04-11 00:08:05 阅读次数: 0

背景

  1. 项目开发中，我们或多或少会使用诸如NLog，Log4Net，Kafka+ELK等等日志套件；

  2. 基于关注点分离原则，业务开发的时候不应该关注日志具体实现；并且后续能方便切换其他日志套件；

  3. 这里先实现基于文件的日志服务，在下一篇将实现基于Kafka+ELK；

  4. 具体源码：MasterChief

  5. Nuget：Install-Package MasterChief.DotNet.Core.Log

  6. 欢迎Star，欢迎Issues；

日志接口定义

/// <summary>
///     日志记录接口
/// </summary>
public interface ILogService
{
    #region Methods
 
    /// <summary>
    ///     Debug记录
    /// </summary>
    /// <param name="message">日志信息</param>
    void Debug(string message);
 
    /// <summary>
    ///     Debug记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    void Debug(string message, Exception ex);
 
    /// <summary>
    ///     Error记录
    /// </summary>
    /// <param name="message">日志信息</param>
    void Error(string message);
 
    /// <summary>
    ///     Error记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    void Error(string message, Exception ex);
 
    /// <summary>
    ///     Fatal记录
    /// </summary>
    /// <param name="message">日志信息</param>
    void Fatal(string message);
 
    /// <summary>
    ///     Fatal记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    void Fatal(string message, Exception ex);
 
    /// <summary>
    ///     Info记录
    /// </summary>
    /// <param name="message">日志信息</param>
    void Info(string message);
 
    /// <summary>
    ///     Info记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    void Info(string message, Exception ex);
 
    /// <summary>
    ///     Warn记录
    /// </summary>
    /// <param name="message">日志信息</param>
    void Warn(string message);
 
    /// <summary>
    ///     Warn记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    void Warn(string message, Exception ex);
 
    #endregion Methods
}

基于Log4Net本地文件日志服务实现

/// <summary>
///     基于Log4Net的文件日志记录
/// </summary>
public sealed class FileLogService : ILogService
{
    #region Constructors
 
    static FileLogService()
    {
        DebugLogger = LogManager.GetLogger(DebugLoggerName);
        InfoLogger = LogManager.GetLogger(InfoLoggerName);
        WarnLogger = LogManager.GetLogger(WarnLoggerName);
        ErrorLogger = LogManager.GetLogger(ErrorLoggerName);
        FatalLogger = LogManager.GetLogger(FatalLoggerName);
    }
 
    #endregion Constructors
 
    #region Fields
 
    /// <summary>
    ///     The debug logger name
    /// </summary>
    public const string DebugLoggerName = "DEBUG_FileLogger";
 
    /// <summary>
    ///     The error logger name
    /// </summary>
    public const string ErrorLoggerName = "ERROR_FileLogger";
 
    /// <summary>
    ///     The fatal logger name
    /// </summary>
    public const string FatalLoggerName = "FATAL_FileLogger";
 
    /// <summary>
    ///     The information logger name
    /// </summary>
    public const string InfoLoggerName = "INFO_FileLogger";
 
    /// <summary>
    ///     The warn logger name
    /// </summary>
    public const string WarnLoggerName = "WARN_FileLogger";
 
    /// <summary>
    ///     The debug logger
    /// </summary>
    public static readonly ILog DebugLogger;
 
    /// <summary>
    ///     The error logger
    /// </summary>
    public static readonly ILog ErrorLogger;
 
    /// <summary>
    ///     The fatal logger
    /// </summary>
    public static readonly ILog FatalLogger;
 
    /// <summary>
    ///     The information logger
    /// </summary>
    public static readonly ILog InfoLogger;
 
    /// <summary>
    ///     The warn logger
    /// </summary>
    public static readonly ILog WarnLogger;
 
    #endregion Fields
 
    #region Methods
 
    /// <summary>
    ///     Debug记录
    /// </summary>
    /// <param name="message">日志信息</param>
    public void Debug(string message)
    {
        if (DebugLogger.IsDebugEnabled) DebugLogger.Debug(message);
    }
 
    /// <summary>
    ///     Debug记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    public void Debug(string message, Exception ex)
    {
        if (DebugLogger.IsDebugEnabled) DebugLogger.Debug(message, ex);
    }
 
    /// <summary>
    ///     Error记录
    /// </summary>
    /// <param name="message">日志信息</param>
    public void Error(string message)
    {
        if (ErrorLogger.IsErrorEnabled) ErrorLogger.Error(message);
    }
 
    /// <summary>
    ///     Error记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    public void Error(string message, Exception ex)
    {
        if (ErrorLogger.IsErrorEnabled) ErrorLogger.Error(message, ex);
    }
 
    /// <summary>
    ///     Fatal记录
    /// </summary>
    /// <param name="message">日志信息</param>
    public void Fatal(string message)
    {
        if (FatalLogger.IsFatalEnabled) FatalLogger.Fatal(message);
    }
 
    /// <summary>
    ///     Fatal记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    public void Fatal(string message, Exception ex)
    {
        if (FatalLogger.IsFatalEnabled) FatalLogger.Fatal(message, ex);
    }
 
    /// <summary>
    ///     Info记录
    /// </summary>
    /// <param name="message">日志信息</param>
    public void Info(string message)
    {
        if (InfoLogger.IsInfoEnabled) InfoLogger.Info(message);
    }
 
    /// <summary>
    ///     Info记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    public void Info(string message, Exception ex)
    {
        if (InfoLogger.IsInfoEnabled) InfoLogger.Info(message, ex);
    }
 
    /// <summary>
    ///     Warn记录
    /// </summary>
    /// <param name="message">日志信息</param>
    public void Warn(string message)
    {
        if (WarnLogger.IsWarnEnabled) WarnLogger.Warn(message);
    }
 
    /// <summary>
    ///     Warn记录
    /// </summary>
    /// <param name="message">日志信息</param>
    /// <param name="ex">异常信息</param>
    public void Warn(string message, Exception ex)
    {
        if (WarnLogger.IsWarnEnabled) WarnLogger.Warn(message, ex);
    }
 
    #endregion Methods
}

Log4Net 配置文件

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler" />
  </configSections>
  <log4net>
    <!-- FileLogger -->
    <logger name="FATAL_FileLogger">
      <level value="ALL" />
      <appender-ref ref="FATAL_FileAppender" />
    </logger>
    <logger name="ERROR_FileLogger">
      <level value="ALL" />
      <appender-ref ref="ERROR_FileAppender" />
    </logger>
    <logger name="WARN_FileLogger">
      <level value="ALL" />
      <appender-ref ref="WARN_FileAppender" />
    </logger>
    <logger name="INFO_FileLogger">
      <level value="ALL" />
      <appender-ref ref="INFO_FileAppender" />
    </logger>
    <logger name="DEBUG_FileLogger">
      <level value="ALL" />
      <appender-ref ref="DEBUG_FileAppender" />
    </logger>
    <!-- AdoNetLogger -->
    <!--<logger name="AdoNetLogger">
      <level value="ALL" />
      <appender-ref ref="AdoNetAppender" />
    </logger>-->
    <!-- ConsoleLogger -->
    <logger name="ConsoleLogger">
      <level value="ALL" />
      <appender-ref ref="ColoredConsoleAppender" />
    </logger>
 
    <!--使用Rolling方式记录日志按照日来记录日志-->
    <appender name="FATAL_FileAppender" type="log4net.Appender.RollingFileAppender">
      <!--文件名,可以相对路径,也可以绝对路径,这里只给定了文件夹-->
      <file value=".\log\\FATAL\\" />
      <!--是否增加文件-->
      <appendToFile value="true" />
      <maxSizeRollBackups value="5" />
      <!--日志追加类型,Date为按日期增加文件,Size为按大小-->
      <rollingStyle value="Date" />
      <!--最小锁定模型以允许多个进程可以写入同一个文件,解决文件独占问题-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!--最大文件大小-->
      <maximumFileSize value="10MB" />
      <!--文件命名格式,非日期参数化要进行转义,如自定义文件后缀-->
      <datePattern value="yyyyMM\\yyyy-MM-dd&quot;.log&quot;" />
      <!--是否固定文件名-->
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="---------------------------------------------------%newline发生时间：%date %newline事件级别：%-5level %newline事件来源：%logger%newline日志内容：%message%newline" />
      </layout>
    </appender>
    <appender name="ERROR_FileAppender" type="log4net.Appender.RollingFileAppender">
      <!--文件名,可以相对路径,也可以绝对路径,这里只给定了文件夹-->
      <file value=".\log\\ERROR\\" />
      <!--是否增加文件-->
      <appendToFile value="true" />
      <maxSizeRollBackups value="5" />
      <!--日志追加类型,Date为按日期增加文件,Size为按大小-->
      <rollingStyle value="Date" />
      <!--最小锁定模型以允许多个进程可以写入同一个文件,解决文件独占问题-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!--最大文件大小-->
      <maximumFileSize value="10MB" />
      <!--文件命名格式,非日期参数化要进行转义,如自定义文件后缀-->
      <datePattern value="yyyyMM\\yyyy-MM-dd&quot;.log&quot;" />
      <!--是否固定文件名-->
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="---------------------------------------------------%newline发生时间：%date %newline事件级别：%-5level %newline事件来源：%logger%newline日志内容：%message%newline" />
      </layout>
    </appender>
    <appender name="WARN_FileAppender" type="log4net.Appender.RollingFileAppender">
      <!--文件名,可以相对路径,也可以绝对路径,这里只给定了文件夹-->
      <file value=".\log\\WARN\\" />
      <!--是否增加文件-->
      <appendToFile value="true" />
      <maxSizeRollBackups value="5" />
      <!--日志追加类型,Date为按日期增加文件,Size为按大小-->
      <rollingStyle value="Date" />
      <!--最小锁定模型以允许多个进程可以写入同一个文件,解决文件独占问题-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!--最大文件大小-->
      <maximumFileSize value="10MB" />
      <!--文件命名格式,非日期参数化要进行转义,如自定义文件后缀-->
      <datePattern value="yyyyMM\\yyyy-MM-dd&quot;.log&quot;" />
      <!--是否固定文件名-->
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="---------------------------------------------------%newline发生时间：%date %newline事件级别：%-5level %newline事件来源：%logger%newline日志内容：%message%newline" />
      </layout>
    </appender>
    <appender name="INFO_FileAppender" type="log4net.Appender.RollingFileAppender">
      <!--文件名,可以相对路径,也可以绝对路径,这里只给定了文件夹-->
      <file value=".\log\\INFO\\" />
      <!--是否增加文件-->
      <appendToFile value="true" />
      <maxSizeRollBackups value="5" />
      <!--日志追加类型,Date为按日期增加文件,Size为按大小-->
      <rollingStyle value="Date" />
      <!--最小锁定模型以允许多个进程可以写入同一个文件,解决文件独占问题-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!--最大文件大小-->
      <maximumFileSize value="10MB" />
      <!--文件命名格式,非日期参数化要进行转义,如自定义文件后缀-->
      <datePattern value="yyyyMM\\yyyy-MM-dd&quot;.log&quot;" />
      <!--是否固定文件名-->
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="---------------------------------------------------%newline发生时间：%date %newline事件级别：%-5level %newline事件来源：%logger%newline日志内容：%message%newline" />
      </layout>
    </appender>
    <appender name="DEBUG_FileAppender" type="log4net.Appender.RollingFileAppender">
      <!--文件名,可以相对路径,也可以绝对路径,这里只给定了文件夹-->
      <file value=".\log\\DEBUG\\" />
      <!--是否增加文件-->
      <appendToFile value="true" />
      <maxSizeRollBackups value="5" />
      <!--日志追加类型,Date为按日期增加文件,Size为按大小-->
      <rollingStyle value="Date" />
      <!--最小锁定模型以允许多个进程可以写入同一个文件,解决文件独占问题-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <!--最大文件大小-->
      <maximumFileSize value="10MB" />
      <!--文件命名格式,非日期参数化要进行转义,如自定义文件后缀-->
      <datePattern value="yyyyMM\\yyyy-MM-dd&quot;.log&quot;" />
      <!--是否固定文件名-->
      <staticLogFileName value="false" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="---------------------------------------------------%newline发生时间：%date %newline事件级别：%-5level %newline事件来源：%logger%newline日志内容：%message%newline" />
      </layout>
    </appender>
    <!--使用AdoNetAppender方式记录日志按照日来记录日志-->
    <!--<appender name="AdoNetAppender" type="log4net.Appender.AdoNetAppender">
      <bufferSize value="1" />
      <connectionType value="System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
      <connectionString value="DATABASE=Sample;SERVER=.\SQLEXPRESS;UID=sa;PWD=sasa;Connect Timeout=15;" />
      <commandText value="INSERT INTO [Log4Net] ([Date],[Host],[Thread],[Level],[Logger],[Message],[Exception]) VALUES (@log_date, @host, @thread, @log_level, @logger, @message, @exception)" />
      <parameter>
        <parameterName value="@log_date" />
        <dbType value="DateTime" />
        <layout type="log4net.Layout.RawTimeStampLayout" />
      </parameter>
      <parameter>
        <parameterName value="@thread" />
        <dbType value="String" />
        <size value="255" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%thread" />
        </layout>
      </parameter>
 
      <parameter>
        <parameterName value="@host" />
        <dbType value="String" />
        <size value="50" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%property{log4net:HostName}" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@log_level" />
        <dbType value="String" />
        <size value="50" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%level" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@logger" />
        <dbType value="String" />
        <size value="255" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%logger" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@message" />
        <dbType value="String" />
        <size value="4000" />
        <layout type="log4net.Layout.PatternLayout">
          <conversionPattern value="%message" />
        </layout>
      </parameter>
      <parameter>
        <parameterName value="@exception" />
        <dbType value="String" />
        <size value="4000" />
        <layout type="log4net.Layout.ExceptionLayout" />
      </parameter>
    </appender>-->
    <!--使用ConsoleAppender方式记录日志按照日来记录日志-->
    <appender name="ColoredConsoleAppender" type="log4net.Appender.ColoredConsoleAppender">
      <mapping>
        <level value="INFO" />
        <foreColor value="White, HighIntensity" />
        <backColor value="Green" />
      </mapping>
      <mapping>
        <level value="DEBUG" />
        <foreColor value="White, HighIntensity" />
        <backColor value="Blue" />
      </mapping>
      <mapping>
        <level value="WARN" />
        <foreColor value="Yellow, HighIntensity" />
        <backColor value="Purple" />
      </mapping>
      <mapping>
        <level value="ERROR" />
        <foreColor value="Yellow, HighIntensity" />
        <backColor value="Red" />
      </mapping>
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="---------------------------------------------------%newline发生时间：%date %newline事件级别：%-5level%newline事件来源：%logger%newline事件行号：%line%newline日志内容：%message%newline" />
      </layout>
    </appender>
    <appender name="UdpAppender" type="log4net.Appender.UdpAppender">
      <remoteAddress value="127.0.0.1" />
      <remotePort value="7071" />
      <layout type="log4net.Layout.XmlLayoutSchemaLog4j" />
    </appender>
    <root>
      <appender-ref ref="UdpAppender" />
    </root>
  </log4net>
</configuration>

怎么使用

private IKernel _kernel = null;
private ILogService _logService = null;
 
[TestInitialize]
public void SetUp()
{
    _kernel = new StandardKernel(new LogModule());
    Assert.IsNotNull(_kernel);
 
    _logService = _kernel.Get<ILogService>();
}
 
[TestMethod()]
public void DebugTest()
{
    _logService.Debug("DebugTest");
}

结语

  1. 整个实现很简单，就是业务或者功能不依赖具体实现类，这也是开发中最基本原则；
  2. 小弟不才，大佬轻拍；

猜你喜欢

转载自www.cnblogs.com/MeetYan/p/10687029.html
今日推荐
基于大语言模型的开源知识库问答系统 MaxKB GitHub Star 数量突破 5,000 个！
美国拟限制 AI 大模型出口中国和俄罗斯
苹果将与 OpenAI 达成协议，将 ChatGPT 应用于 iPhone
openKylin 社区生态委员会第六次会议圆满召开
阿里云正式发布通义千问 2.5
Python 3.13 发布首个 Beta：实验性自由线程模式和 JIT、改进交互式解释器
Stack Overflow 拿我的代码去训练 AI 大模型，还封了我的账号
Pop!_OS 的 COSMIC 桌面完成 App Store 上架工作
《2024 年一季度互联网投融资运行情况》研究报告
报告：Django 仍然是 74% 开发者的首选
15 年前上了“FFmpeg 耻辱柱”，今天他还得谢谢咱——腾讯QQPlayer一雪前耻？
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
周排行
记一下去大梅沙的准备（2018-05-26）
Spring 注解 事务
基于HTTP协议的客户端缓存
阿里云rds 备份和还原
[PHP] 几个拖慢 PHP 程序/API 运行速度的点
python 代码风格------------PEP8规则
js控制json生成菜单——自制菜单（一）
将字符串: 'k:1|k1:2|k2:3|k3:4 ' ,处理成 python 字典: {'k':1, 'k1':2, ...}
微信小程序转支付宝小程序
Qt551.窗口滚动条
每日归档
更多
2024-05-13(18)
2024-05-12(0)
2024-05-11(38)
2024-05-10(38)
2024-05-09(35)
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022