解讀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系列