一、前言

回顧：日志記錄之日志核心要素揭秘

在上一篇中，我們通過(guò)學(xué)習(xí)了解在.net core 中內(nèi)置的日志記錄中的幾大核心要素，在日志工廠記錄器(ILoggerFactory)中實(shí)現(xiàn)將日志記錄提供器(ILoggerProvider)對(duì)象都可以集成到Logger對(duì)象組合中，這樣的話，我們就可以通過(guò)基于ILoggerProvider自定義日志記錄程序集成到Logger中，再創(chuàng)建寫(xiě)日志定義Ilogger，自定義日志記錄器實(shí)現(xiàn)日志的輸出方式，這樣實(shí)現(xiàn)自定義日志記錄工具。

在這個(gè)過(guò)程中，日志記錄器ILogger中的Log()方法會(huì)記錄執(zhí)行日志，通過(guò)在ILoggerFactory產(chǎn)生的是ILogger類型（也就是我們最終使用的Logger），其Log()方法是依次調(diào)用Logger中包含的LoggerInformation[]數(shù)組中的ILogger。而ILoggerProvider產(chǎn)生的為各類不同的XxxLogger（也就是上面說(shuō)的Logger中的LoggerInformation數(shù)組包含的如ConsoleLogger、DebugLogger），其Log()方法是把日志寫(xiě)到具體的目標(biāo)上去，所以我們自定義的日志程序也可以在日志記錄器工廠中實(shí)現(xiàn)添加日志程序，達(dá)到將日志寫(xiě)到具體目標(biāo)的作用。

所以下文我們通過(guò)自定義的方式實(shí)現(xiàn)ILogger、ILoggerProvider兩個(gè)接口來(lái)實(shí)現(xiàn)我們自己想要的日志記錄程序，實(shí)現(xiàn)自定義輸出目標(biāo)方式。（下文只是簡(jiǎn)單的根據(jù)接口自定義實(shí)現(xiàn)輸出日志記錄到控制臺(tái)的demo）

二、開(kāi)始

2.1 自定義Logger

創(chuàng)建一個(gè)自定義Logger，目的是將指定的等級(jí)日志輸出到控制臺(tái)。所以我們創(chuàng)建一個(gè)ExtensionLogger的類，指定輸出的日志等級(jí)。所以在這之前，我們需要配置一下輸入日志的等級(jí)，因此我們需要增加一個(gè)等級(jí)的配置類ExtensionsConfiguration。

在ExtensionsConfiguration中，

public class ExtensionsConfiguration
{
    /// <summary>
    /// 日志等級(jí)
    /// </summary>
    public LogLevel LogLevel { get; set; } = LogLevel.Warning;
}

再自定義日志記錄類ExtensionLogger，實(shí)現(xiàn)接口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));
        
    }
}

根據(jù)ILogger接口實(shí)現(xiàn)，其中實(shí)現(xiàn)Log()接口方法，將日志輸出到指定目標(biāo)，這里是輸出到控制臺(tái)，在設(shè)置了日志等級(jí)的情況條件下，當(dāng)滿足條件后，才能輸出對(duì)應(yīng)的日志。

2.2 自定義LoggerProvider

在創(chuàng)建了日志輸出記錄后，我們同時(shí)需要提供一個(gè)日志程序來(lái)增加和創(chuàng)建上面的Logger記錄，所以我們通過(guò)自定義日志提供器類ExtensionsLoggerProvider,實(shí)現(xiàn)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接口實(shí)現(xiàn)自定義類，實(shí)現(xiàn)方法CreateLogger,來(lái)創(chuàng)建上面的日志記錄。

2.3 使用

在Startup.cs中,通過(guò)Configure方法調(diào)用配置日志記錄。

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

        app.UseAuthorization();

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

在此之前，我們可以清空默認(rèn)的配置，然后根據(jù)日志等級(jí)，在控制臺(tái)中輸出對(duì)應(yīng)的日志記錄。

2.4 效果

在等級(jí)為Information情況下，輸出效果如下：

這個(gè)就是我們通過(guò)自定義的方式實(shí)現(xiàn)的按日志等級(jí)輸出的記錄。

三、拓展

3.1 寫(xiě)入本地文件

第一步：為L(zhǎng)oggerFactory擴(kuò)張一個(gè)方法，提供增加日志寫(xiě)文件方式的入口。相關(guān)的配置來(lái)自appsettings.json

第二步：實(shí)現(xiàn)我們的logger提供程序，實(shí)現(xiàn)ILoggerProvider接口，關(guān)鍵方法CreateLogger，創(chuàng)建真正寫(xiě)日志的logger。對(duì)當(dāng)前的logger可以做適當(dāng)?shù)木彺?，配置logger

第三步：實(shí)現(xiàn)我們的logger，實(shí)現(xiàn)ILogger接口。真正將log寫(xiě)入file。

這里可以參考網(wǎng)友的資料 ：.Net Core Logger 實(shí)現(xiàn)log寫(xiě)入本地文件系統(tǒng)

四、總結(jié)

• 上文中，我們通過(guò)自定義的方式實(shí)現(xiàn)了根據(jù)日志等級(jí)將日志記錄輸出到指定目標(biāo)的方式，在這種基礎(chǔ)上，我們可以根據(jù)具體的需求做完善修改，實(shí)現(xiàn)自己的日志記錄輸出方式。

• 除了我們通過(guò)自定義的方式之外，我們也可以借用第三方日志框架組件程序進(jìn)行使用，根據(jù)拓展方法進(jìn)行調(diào)用，在后續(xù)中我們會(huì)使用第三方日志記錄程序來(lái)實(shí)現(xiàn)日志記錄的輸出。

• 如果有不對(duì)的或不理解的地方，希望大家可以多多指正，提出問(wèn)題，一起討論,不斷學(xué)習(xí),共同進(jìn)步。

• 官方源碼 和 參考資料

• 本文項(xiàng)目源碼下載

到此這篇關(guān)于.Net Core自定義日志組件的文章就介紹到這了。希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論