解讀ASP.NET 5 MVC6系列教程

  框架介紹

解讀ASP.NET 5 MVC6系列教程

在之前的中,微軟還沒有提供過像樣的日誌框架,目前能用的一些框架比如Log4Net、NLog、CommonLogging使用起來多多少少都有些費勁,和java的SLF4J根本無法相比。但在新版的5中,可謂是牛氣沖天,微軟提供的ing框架集可謂就是版的SLF4J,提供相應的接口,其它第三方組件可以根據接口實現自己的實現。

  ILoggerFactory接口

ILoggerFactory接口是日誌的入庫點,在系統中通過依賴注入可以獲取該接口的實例,並根據該示例創建日誌記錄器ILogger來記錄日誌,示例如下:

var factory = equiredService(); var logger1 = teLogger(typeof(HomeController)Name); //CreateLogger var logger2 = teLogger(); //CreateLogger (rmation, 1, null, null, null); // 日誌記錄 nformation("123"); // 擴展方法 rror("123"); // 擴展方法

或者,你也可以在的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){ rovider(new ConsoleLoggerProvider((category, logLevel) => logLevel >= rmation)); 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, Funcformatter); //判斷是否可以記錄給定的日誌級別 bool IsEnabled(LogLevel logLevel); //開啓一個邏輯操作作用域 IDisposable BeginScopeImpl(object state);}

實現了上述兩個接口,即可通過factory的AddProvider方法,將該provider添加到實例中,達到記錄日誌的目的。 5中目前的默認實現了4中日誌記錄Provider,分別是:Console、NLog、Serilog、Trace,註冊這些Provider的時候,均可以使用擴展方法,實例如下:

onsole()Log(new actory())erilog(new LoggerConfiguration())var testSwitch = new SourceSwitch("TestSwitch", "Level will be set to warning for this test");raceSource(testSwitch, new ConsoleTraceListener());

  ILogger的擴展方法

爲了方便記錄日誌,微軟在erExtensions上,針對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數據庫。