解讀ASP.NET 5 & MVC6系列教程（9）：日誌架構_自學過程

架構介紹

在之前的.NET中，微軟還沒有提供過像樣的日誌架構，目前能用的一些架構比如Log4Net、NLog、CommonLogging使用起來多多少少都有些費勁，和java的SLF4J根本無法相比。但在新版的ASP.NET5中，可謂是牛氣衝天，微軟提供的Microsoft.Framework.Logging框架組可謂就是.NET版的SLF4J，提供相應的介面，其它第三方組件可以根據介面實現自己的實現。

ILoggerFactory介面

ILoggerFactory介面是日誌的入庫點，在系統中通過依賴注入可以擷取該介面的執行個體，並根據該樣本建立日誌記錄器ILogger來記錄日誌，樣本如下：

var factory = ServiceProvider.GetRequiredService<ILoggerFactory>(); var logger1 = factory.CreateLogger(typeof(HomeController).FullName); //CreateLogger var logger2 = factory.CreateLogger<HomeController>(); //CreateLogger logger1.Log(LogLevel.Information, 1, null, null, null); // 日誌記錄 logger1.LogInformation("123"); // 擴充方法 logger1.LogError("123"); // 擴充方法

或者，你也可以在Startup.cs的Configure方法中，從loggerfactory參數中擷取上述樣本。

ILoggerFactory介面的定義如下：

public interface ILoggerFactory{ //日誌最小記錄層級 LogLevel MinimumLevel { get; set; } //建立日誌記錄執行個體 ILogger CreateLogger(string categoryName); //一般是根據功能模組或類名進行分類 void AddProvider(ILoggerProvider provider); // 添加日誌記錄provider（如第三方實現）}

在該介面的實現中，我們可以設定日誌的最小記錄基本，其類別如下：

public enum LogLevel{ Debug = 1, Verbose = 2, Information = 3, Warning = 4, Error = 5, Critical = 6,}

也可以添加第三方實現的Provider，比如添加一個控制台版本的實現：

public static ILoggerFactory AddConsole(this ILoggerFactory factory){ factory.AddProvider(new ConsoleLoggerProvider((category, logLevel) => logLevel >= LogLevel.Information)); return factory;}

然後通過CreateLogger方法建立日誌記錄器執行個體，最後再記錄日誌。

ILoggerProvider和ILogger

所有的第三方實現都需要實現ILoggerProvider介面和ILogger介面，其中介面很簡單，就是實現建立ILogger介面的方法即可，代碼如下：

public interface ILoggerProvider{ ILogger CreateLogger(string name); //建立給定類別的ILgger執行個體}

而ILogger的實現，也相對簡單，除了實現通用的日誌記錄方法以外，還需要實現一個記錄層級判斷的方法以及一個範圍建立方法，介面定義如下：

public interface ILogger{ //支援大多數日誌記錄的通用方法，其它訪問通過擴充方法進行完善 void Log(LogLevel logLevel, int eventId, object state, Exception exception, Func<object, Exception, string> formatter); //判斷是否可以記錄給定的記錄層級 bool IsEnabled(LogLevel logLevel); //開啟一個邏輯操作範圍 IDisposable BeginScopeImpl(object state);}

實現了上述兩個介面，即可通過factory的AddProvider方法，將該provider添加到執行個體中，達到記錄日誌的目的。ASP.NET 5中目前的預設實現了4中日誌記錄Provider，分別是：Console、NLog、Serilog、Trace，註冊這些Provider的時候，均可以使用擴充方法，執行個體如下：

loggerfactory.AddConsole()loggerfactory.AddNLog(new NLog.LogFactory())loggerfactory.AddSerilog(new LoggerConfiguration())var testSwitch = new SourceSwitch("TestSwitch", "Level will be set to warning for this test");factory.AddTraceSource(testSwitch, new ConsoleTraceListener());

ILogger的擴充方法

為了方便記錄日誌，微軟在Microsoft.Framework.Logging.LoggerExtensions上，針對6個層級的日誌記錄均定義了6個如下形式的擴充方法，執行個體如下：

public static void LogInformation(this ILogger logger, string message)public static void LogInformation(this ILogger logger, int eventId, string message)public static void LogInformation(this ILogger logger, string format, params object[] args)public static void LogInformation(this ILogger logger, int eventId, string format, params object[] args)public static void LogInformation(this ILogger logger, ILogValues state, Exception error = null)public static void LogInformation(this ILogger logger, int eventId, ILogValues state, Exception error = null)// 其它Debug、Verbose、Warning、Error、Critical也都遵循LogXXXX()規則.

所以使用的時候，我們可以使用像LogDebug()、LogError()這樣的方法來進行快速記錄日誌。另外，該類還為Warning、Error、Critical三個層級，又分別定義了2個擴充方法，樣本如下：

public static void LogWarning(this ILogger logger, string message, Exception error)public static void LogWarning(this ILogger logger, int eventId, string message, Exception error)

有些這些擴充方法，使用起來估計打遍天下無敵手了。

總結

通過基於介面的編程機制和DI依賴注入機制，我們可以很容易實現第三方日誌provider的擴充，從而將日誌記錄到我們想記錄的任意地方，如MongoDB等NoSQL資料庫。