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

在此以前，咱們能夠清空默認的配置，而後根據日誌等級，在控制檯中輸出對應的日誌記錄。