.net Core 3.1 中使用 Log4Net 作日志记录

  • ​​1、安装包-NuGet​​
  • ​​2、Programer 中注册 Log4Net服务​​
  • ​​3、Startup.cs 中注入 Log4Net​​
  • ​​4、封装一个Loghelper封装类​​
  • ​​4.1、定义 ILogHelper 接口​​
  • ​​4.2、定义 LogHelper 接口实现类，实现ILogHelper接口​​
  • ​​5、Log4net.config 配置文件​​
  • ​​6、TestController​​
  • ​​结束​​

  在asp.net core中已经内置了日志系统，并提供了各种内置和第三方日志记录提供程序的日志记录接口，在进行应用开发中，可以进行统一配置，并且利用第三方日志框架相结合，更加有效的实现日志记录

1、安装包-NuGet

Log4Net ：​​Microsoft.Extensions.Logging.Log4Net.AspNetCore​​​ ILogger 所在包： ​​Microsoft.Extensions.Logging.Abstractions​​

2、Programer 中注册 Log4Net服务

public static IHostBuilder CreateHostBuilder(string[] args) =>
    Host.CreateDefaultBuilder(args)
        .UseServiceProviderFactory(new AutofacServiceProviderFactory())
        .ConfigureWebHostDefaults(webBuilder =>
        {
            webBuilder.UseStartup<Startup>()
            
            .ConfigureLogging((hostingContext, builder) =>
            {
                //该方法需要引入Microsoft.Extensions.Logging名称空间
                builder.AddFilter("System", LogLevel.Error); //过滤掉系统默认的一些日志
                builder.AddFilter("Microsoft", LogLevel.Error);//过滤掉系统默认的一些日志

                //添加Log4Net
                var path = Path.Combine(Directory.GetCurrentDirectory(), "Log4net.config");
                //不带参数：表示log4net.config的配置文件就在应用程序根目录下，也可以指定配置文件的路径
                //需要添加nuget包：Microsoft.Extensions.Logging.Log4Net.AspNetCore
                builder.AddLog4Net(path);
            });
        });

3、Startup.cs 中注入 Log4Net

// 注意在CreateDefaultBuilder中，添加Autofac服务工厂
/// <summary>
/// 自定义容器服务注册
/// </summary>
/// <param name="builder"></param>
public void ConfigureContainer(ContainerBuilder builder)
{
    // 业务逻辑层 所在程序集命名空间
    Assembly service = Assembly.Load("WebAPI.Services");
    // 接口层 所在程序集命名空间
    Assembly repository = Assembly.Load("WebAPI.IService");
    // 自动注入
    builder.RegisterAssemblyTypes(service, repository).Where(t => t.Name.EndsWith("Service")).AsImplementedInterfaces();

    // 注入Log4Net
    builder.RegisterType<LogHelper>().As<ILogHelper>().SingleInstance();
}

4、封装一个Loghelper封装类

4.1、定义 ILogHelper 接口

public interface ILogHelper
{
    public void LogErr(string throwMsg, Exception ex);
    public void LogErr(string errkey, string errmsg);
    public void LogInfo(string key, string msg);
    public void LogInfo(string msg);
}

4.2、定义 LogHelper 接口实现类，实现ILogHelper接口

using System;
using Microsoft.Extensions.Logging;
using WebAPI.IService;

namespace WebAPI.Services
{
    public class LogHelper : ILogHelper //<T>
    {
        private readonly ILogger<LogHelper> _logger;
        
        // 构造函数依赖注入
        public LogHelper(ILogger<LogHelper> logger)
        {
            _logger = logger;
        }

        public void LogErr(string throwMsg, Exception ex)
        {
            var errorMsg = $"【抛出信息】：{throwMsg} \r\n<br/>【异常类型】：{ex.GetType().Name} \r\n<br/>【异常信息】：{ex.Message} \r\n<br/>【堆栈调用】：\r\n<br/>{ex}";
            _logger.LogError(errorMsg);
        }

        public void LogErr(string errkey, string errmsg)
        {
            _logger.LogError(errkey + ":" + errmsg);
        }

        public void LogInfo(string key, string msg)
        {
            _logger.LogInformation(key + ":" + msg);
        }

        public void LogInfo(string msg)
        {
            _logger.LogInformation(msg);
        }
    }
}

5、Log4net.config 配置文件

  • 网上有很多栗子，可以去参考有针对性地完善
<?xml version="1.0" encoding="utf-8"?>
<log4net>
  <!-- 将日志以回滚文件的形式写到文件中 -->
  <!-- 按日期切分日志文件，并将日期作为日志文件的名字 -->
  
  <!--Error-->
  <appender name="ErrorLog" type="log4net.Appender.RollingFileAppender">
    <file value="Log\\LogError\\"/>
    <appendToFile value="true" />
    <rollingStyle value="Date" />
    <!--日期的格式，每天换一个文件记录，如不设置则永远只记录一天的日志，需设置-->
    <datePattern value="yyyyMMdd".html"" />
    <!--日志文件名是否为静态-->
    <StaticLogFileName value="false"/>
    <!--多线程时采用最小锁定-->
    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    <!--布局（向用户显示最后经过格式化的输出信息）-->
    <layout type="log4net.Layout.PatternLayout">
      <ConversionPattern value="<HR COLOR=red">>%n【异常时间】：%d [%t] <BR">>%n【异常级别】：%-5p <BR">>%n%m <BR">>"  />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <levelMin value="ERROR" />
      <levelMax value="FATAL" />
    </filter>
  </appender>
  <!--Error-->

  <!--Info-->
  <appender name="InfoLog" type="log4net.Appender.RollingFileAppender">
    <!--定义文件存放位置-->
    <file value="Log\\LogInfo\\"/>
    <appendToFile value="true" />
    <rollingStyle value="Date" />
    <!--日志文件名是否为静态-->
    <StaticLogFileName value="false"/>
    <!--日期的格式，每天换一个文件记录，如不设置则永远只记录一天的日志，需设置-->
    <datePattern value="yyyyMMdd".html"" />
    <!--多线程时采用最小锁定-->
    <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
    <!--布局（向用户显示最后经过格式化的输出信息）-->
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="<HR COLOR=#DDD">>%n【日志时间】：%d [%t] <BR">>%n【日志级别】：%-5p <BR">>%n%m <BR">>%n <BR">>"  />
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <levelMin value="DEBUG" />
      <levelMax value="WARN" />
    </filter>
  </appender>
  <!--Info-->

  <root>
    <!-- 控制级别，由低到高：ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF -->
    <!-- 比如定义级别为INFO，则INFO级别向下的级别，比如DEBUG日志将不会被记录 -->
    <!-- 如果没有定义LEVEL的值，则缺省为DEBUG -->
    <level value="ALL" />
    <!-- 按日期切分日志文件，并将日期作为日志文件的名字 -->
    <appender-ref ref="ErrorLog" />
    <appender-ref ref="InfoLog" />
  </root>
</log4net>

6、TestController

private readonly ITestService _testService;
private readonly ILogger<TestController> _logger;
private readonly ILogHelper _logHelper;

public TestController(ITestService testService, ILogger<TestController> logger, ILogHelper logHelper)
{
    _testService = testService;
    _logger = logger;
    _logHelper = logHelper;
}
  • Demo 的结构

结束

我们的日志记录文件分为两种类型，分别记录在不同的文件中

.net Core 3.1 中使用 Log4Net 作日志记录_log4net

  • 经过测试我们可以得到

info 日志类型

.net Core 3.1 中使用 Log4Net 作日志记录_logging_02


Error 日志类型

.net Core 3.1 中使用 Log4Net 作日志记录_log4net_03


案例中使用到了 Autofac 进行服务的注入，如果不是很了解的小伙伴可以去这篇文章查看，进行简单的学习：

Autofac替换.net Core原有的IOC容器