.Net Core紀錄檔記錄之自定義紀錄檔元件

2022-06-15 18:01:17

一、前言

在上一篇中，我們通過學習瞭解在.net core 中內建的紀錄檔記錄中的幾大核心要素，在紀錄檔工廠記錄器(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

建立一個自定義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 自定義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,來建立上面的紀錄檔記錄。

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.1 寫入本地檔案

第一步：為LoggerFactory擴張一個方法，提供增加紀錄檔寫檔案方式的入口。相關的設定來自appsettings.json

第二步：實現我們的logger提供程式，實現ILoggerProvider介面，關鍵方法CreateLogger，建立真正寫紀錄檔的logger。對當前的logger可以做適當的快取，設定logger

第三步：實現我們的logger，實現ILogger介面。真正將log寫入file。

這裡可以參考網友的資料：.Net Core Logger 實現log寫入本地檔案系統

四、總結

上文中，我們通過自定義的方式實現了根據紀錄檔等級將紀錄檔記錄輸出到指定目標的方式，在這種基礎上，我們可以根據具體的需求做完善修改，實現自己的紀錄檔記錄輸出方式。
除了我們通過自定義的方式之外，我們也可以借用第三方紀錄檔框架元件程式進行使用，根據拓展方法進行呼叫，在後續中我們會使用第三方紀錄檔記錄程式來實現紀錄檔記錄的輸出。
如果有不對的或不理解的地方，希望大家可以多多指正，提出問題，一起討論,不斷學習,共同進步。
官方原始碼和參考資料
本文專案原始碼下載

到此這篇關於.Net Core自定義紀錄檔元件的文章就介紹到這了。希望對大家的學習有所幫助，也希望大家多多支援it145.com。