基于.NetCore3.1系列 —— 日志记录之自定义日志组件

时间 2020-08-12

标签基于 netcore3.1 netcore 系列日志记录自定义组件繁體版

原文原文链接

1、前言

在上一篇中，咱们经过学习了解在.net core 中内置的日志记录中的几大核心要素，在日志工厂记录器(ILoggerFactory)中实现将日志记录提供器(ILoggerProvider)对象均可以集成到Logger对象组合中，这样的话，咱们就能够经过基于ILoggerProvider自定义日志记录程序集成到Logger中，再建立写日志定义Ilogger，自定义日志记录器实现日志的输出方式，这样实现自定义日志记录工具。git

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

因此下文咱们经过自定义的方式实现ILogger、ILoggerProvider两个接口来实现咱们本身想要的日志记录程序，实现自定义输出目标方式。（下文只是简单的根据接口自定义实现输出日志记录到控制台的demo）json

2、开始

2.1 自定义Logger

建立一个自定义Logger，目的是将指定的等级日志输出到控制台。因此咱们建立一个ExtensionLogger的类，指定输出的日志等级。因此在这以前，咱们须要配置一下输入日志的等级，所以咱们须要增长一个等级的配置类ExtensionsConfiguration。c#

在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()接口方法，将日志输出到指定目标，这里是输出到控制台，在设置了日志等级的状况条件下，当知足条件后，才能输出对应的日志。app

2.2 自定义LoggerProvider

在建立了日志输出记录后，咱们同时须要提供一个日志程序来增长和建立上面的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,来建立上面的日志记录。ide

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();
        });
    }

在此以前，咱们能够清空默认的配置，而后根据日志等级，在控制台中输出对应的日志记录。

2.4 效果

在等级为Information状况下，输出效果以下：

这个就是咱们经过自定义的方式实现的按日志等级输出的记录。

3、拓展

3.1 写入本地文件

第一步：为LoggerFactory扩张一个方法，提供增长日志写文件方式的入口。相关的配置来自appsettings.json

第二步：实现咱们的logger提供程序，实现ILoggerProvider接口，关键方法CreateLogger，建立真正写日志的logger。对当前的logger能够作适当的缓存，配置logger

第三步：实现咱们的logger，实现ILogger接口。真正将log写入file。

这里能够参考网友的资料：.Net Core Logger 实现log写入本地文件系统

4、总结

上文中，咱们经过自定义的方式实现了根据日志等级将日志记录输出到指定目标的方式，在这种基础上，咱们能够根据具体的需求作完善修改，实现本身的日志记录输出方式。
除了咱们经过自定义的方式以外，咱们也能够借用第三方日志框架组件程序进行使用，根据拓展方法进行调用，在后续中咱们会使用第三方日志记录程序来实现日志记录的输出。
若是有不对的或不理解的地方，但愿你们能够多多指正，提出问题，一块儿讨论,不断学习,共同进步。
官方源码和参考资料
本文项目源码下载