基於.NetCore3.1系列 —— 日誌記錄之自定義日誌元件
阿新 • • 發佈:2020-08-12
# 一、前言
回顧:[日誌記錄之日誌核心要素揭祕](https://www.cnblogs.com/i3yuan/p/13442509.html)
在上一篇中,我們通過學習瞭解在.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`中,
```c#
public class ExtensionsConfiguration
{
///
/// 日誌等級
///
public LogLevel LogLevel { get; set; } = LogLevel.Warning;
}
```
再自定義日誌記錄類`ExtensionLogger`,實現介面`ILogger`,
```c#
public class ExtensionsLogger : ILogger
{
private readonly ExtensionsConfiguration _config;
public ExtensionsLogger(ExtensionsConfiguration extensionsConfiguration)
{
_config = extensionsConfiguration;
}
public IDisposable BeginScope(TState state)
{
return null;
}
public bool IsEnabled(LogLevel logLevel)
{
return logLevel == _config.LogLevel;
}
public void Log(LogLevel logLevel, EventId eventId, TState state,
Exception exception, Func formatter)
{
if (!IsEnabled(logLevel))
{
return;
}
Console.WriteLine($" {logLevel} - {eventId.Id} : " + formatter(state, exception));
}
}
```
根據`ILogger`介面實現,其中實現`Log()`介面方法,將日誌輸出到指定目標,這裡是輸出到控制檯,在設定了日誌等級的情況條件下,當滿足條件後,才能輸出對應的日誌。
## 2.2 自定義LoggerProvider
在建立了日誌輸出記錄後,我們同時需要提供一個日誌程式來增加和建立上面的`Logger`記錄,所以我們通過自定義日誌提供器類`ExtensionsLoggerProvider`,實現`ILoggerProvider`類。
```c#
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`方法呼叫配置日誌記錄。
```c#
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`情況下,輸出效果如下:
![](https://img2020.cnblogs.com/blog/1576550/202008/1576550-20200810224124542-1281485756.png)
這個就是我們通過自定義的方式實現的按日誌等級輸出的記錄。
# 三、拓展
## 3.1 寫入本地檔案
第一步:為LoggerFactory擴張一個方法,提供增加日誌寫檔案方式的入口。相關的配置來自appsettings.json
第二步:實現我們的logger提供程式,實現ILoggerProvider介面,關鍵方法CreateLogger,建立真正寫日誌的logger。對當前的logger可以做適當的快取,配置logger
第三步:實現我們的logger,實現ILogger介面。真正將log寫入file。
> 這裡可以參考網友的資料 :[.Net Core Logger 實現log寫入本地檔案系統](https://www.cnblogs.com/calvinK/p/5673218.html)
# 四、總結
1. 上文中,我們通過自定義的方式實現了根據日誌等級將日誌記錄輸出到指定目標的方式,在這種基礎上,我們可以根據具體的需求做完善修改,實現自己的日誌記錄輸出方式。
2. 除了我們通過自定義的方式之外,我們也可以借用第三方日誌框架元件程式進行使用,根據拓展方法進行呼叫,在後續中我們會使用第三方日誌記錄程式來實現日誌記錄的輸出。
3. 如果有不對的或不理解的地方,希望大家可以多多指正,提出問題,一起討論,不斷學習,共同進步。
4. 官方[原始碼](https://github.com/dotnet/extensions/tree/master/src/Logging) 和 [參考資料](https://docs.microsoft.com/zh-cn/aspnet/core/fundamentals/logging/?view=aspnetcore-3.1)
5. 本文[專案原始碼下載](https://files-cdn.cnblogs.com/files/i3yuan/Logging.C