.NetCore日志记录之自定义日志组件

2022-06-15 18:49:18 来源：易采站长站作者：

一、前言

回顾：日志记录之日志核心要素揭秘

在上一篇中，我们通过学习了解在.net>ILoggerFactory)中实现将日志记录提供器(ILoggerProvider)对象都可以集成到Logger对象组合中，这样的话，我们就可以通过基于ILoggerProvider自定义日志记录程序集成到Logger中，再创建写日志定义Ilogger，自定义日志记录器实现日志的输出方式，这样实现自定义日志记录工具。

在这个过程中，日志记录器ILogger中的Log()方法会记录执行日志，通过在ILoggerFactory产生的是ILogger类型（也就是我们最终使用的Logger），其Log()方法是依次调用Logger中包含的LoggerInformation[]数组中的ILogger。而ILoggerProvider产生的为各类不同的XxxLogger（也就是上面说的Logger中的LoggerInformation数组包含的如ConsoleLogger、DebugLogger），其Log()方法是把日志写到具体的目标上去，所以我们自定义的日志程序也可以在日志记录器工厂中实现添加日志程序，达到将日志写到具体目标的作用。

所以下文我们通过自定义的方式实现ILogger、ILoggerProvider两个接口来实现我们自己想要的日志记录程序，实现自定义输出目标方式。（下文只是简单的根据接口自定义实现输出日志记录到控制台的demo）

二、开始

2.1>

创建一个自定义Logger，目的是将指定的等级日志输出到控制台。所以我们创建一个ExtensionLogger的类，指定输出的日志等级。所以在这之前，我们需要配置一下输入日志的等级，因此我们需要增加一个等级的配置类ExtensionsConfiguration。

在ExtensionsConfiguration中，

public class ExtensionsConfiguration
{
    /// <summary>
    /// 日志等级
    /// </summary>
    public LogLevel LogLevel { get; set; } = LogLevel.Warning;
}

再自定义日志记录类ExtensionLogger，实现接口ILogger,

public class ExtensionsLogger : ILogger
{
    private readonly ExtensionsConfiguration _config;
    public ExtensionsLogger(ExtensionsConfiguration extensionsConfiguration)
    {
        _config = extensionsConfiguration;
    }

    public IDisposable BeginScope<TState>(TState state)
    {
        return null;
    }

    public bool IsEnabled(LogLevel logLevel)
    {
        return logLevel == _config.LogLevel;
    }

    public void Log<TState>(LogLevel logLevel, EventId eventId, TState state,
        Exception exception, Func<TState, Exception, string> formatter)
    {
        if (!IsEnabled(logLevel))
        {
            return;
        }
        Console.WriteLine($" {logLevel} - {eventId.Id} : " + formatter(state, exception));
        
    }
}

根据ILogger接口实现，其中实现Log()接口方法，将日志输出到指定目标，这里是输出到控制台，在设置了日志等级的情况条件下，当满足条件后，才能输出对应的日志。

2.2>

在创建了日志输出记录后，我们同时需要提供一个日志程序来增加和创建上面的Logger记录，所以我们通过自定义日志提供器类ExtensionsLoggerProvider,实现ILoggerProvider类。

public class ExtensionsLoggerProvider : ILoggerProvider
{
    private readonly ExtensionsConfiguration _config;

    public ExtensionsLoggerProvider(ExtensionsConfiguration extensionsConfiguration)
    {
        _config = extensionsConfiguration;
    }

    public ILogger CreateLogger(string categoryName)
    {
        return new ExtensionsLogger(_config);
    }

    public void Dispose()
    {
    }
}

基于ILoggerProvider接口实现自定义类，实现方法CreateLogger,来创建上面的日志记录。

2.3>

在Startup.cs中,通过Configure方法调用配置日志记录。

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env , ILoggerFactory loggerFactory)
    {
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        // 注入ILogggerFactory,然后配置参数
        //添加日志等级
        loggerFactory.AddProvider(new ExtensionsLoggerProvider(new ExtensionsConfiguration { LogLevel= LogLevel.Warning }));
        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllers();
        });
    }

在此之前，我们可以清空默认的配置，然后根据日志等级，在控制台中输出对应的日志记录。