解讀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數據庫。

同步與推薦

本文已同步至目錄索引：解讀ASP.NET 5 & MVC6系列