基於.NetCore3.1系列 —— 日誌記錄之自定義日誌組件
- 2020 年 8 月 11 日
- 筆記
- aspnetcore源碼, DotCore/C#, Logging
一、前言
在上一篇中，我們通過學習了解在.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寫入本地文件系統
四、總結
-
上文中，我們通過自定義的方式實現了根據日誌等級將日誌記錄輸出到指定目標的方式，在這種基礎上，我們可以根據具體的需求做完善修改，實現自己的日誌記錄輸出方式。
-
除了我們通過自定義的方式之外，我們也可以借用第三方日誌框架組件程序進行使用，根據拓展方法進行調用，在後續中我們會使用第三方日誌記錄程序來實現日誌記錄的輸出。
-
如果有不對的或不理解的地方，希望大家可以多多指正，提出問題，一起討論,不斷學習,共同進步。
-
本文項目源碼下載
