解讀ASP.NET 5 & MVC6系列（9）：日志框架 原文:解讀ASP.NET 5 & MVC6系列（9）：日志框架

框架介紹

在之前的.NET中，微軟還沒有提供過像樣的日志框架，目前能用的一些框架比如Log4Net、NLog、CommonLogging使用起來多多少少都有些費(fèi)勁，和java的SLF4J根本無法相比。但在新版的ASP.NET5中，可謂是牛氣沖天，微軟提供的Microsoft.Framework.Logging框架集可謂就是.NET版的SLF4J，提供相應(yīng)的接口，其它第三方組件可以根據(jù)接口實(shí)現(xiàn)自己的實(shí)現(xiàn)。

ILoggerFactory接口

ILoggerFactory接口是日志的入庫點(diǎn)，在系統(tǒng)中通過依賴注入可以獲取該接口的實(shí)例，并根據(jù)該示例創(chuàng)建日志記錄器ILogger來記錄日志，示例如下：

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

或者，你也可以在Startup.cs的Configure方法中，從loggerfactory參數(shù)中獲取上述示例。

ILoggerFactory接口的定義如下：

public interface ILoggerFactory {//日志最小記錄級(jí)別LogLevel MinimumLevel { get; set; }//創(chuàng)建日志記錄實(shí)例ILogger CreateLogger(string categoryName); //一般是根據(jù)功能模塊或類名進(jìn)行分類void AddProvider(ILoggerProvider provider); // 添加日志記錄provider（如第三方實(shí)現(xiàn)） }

在該接口的實(shí)現(xiàn)中，我們可以設(shè)置日志的最小記錄基本，其類別如下：

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

也可以添加第三方實(shí)現(xiàn)的Provider，比如添加一個(gè)控制臺(tái)版本的實(shí)現(xiàn)：

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

然后通過CreateLogger方法創(chuàng)建日志記錄器實(shí)例，最后再記錄日志。

ILoggerProvider和ILogger

所有的第三方實(shí)現(xiàn)都需要實(shí)現(xiàn)ILoggerProvider接口和ILogger接口，其中接口很簡單，就是實(shí)現(xiàn)創(chuàng)建ILogger接口的方法即可，代碼如下：

public interface ILoggerProvider {ILogger CreateLogger(string name); //創(chuàng)建給定類別的ILgger實(shí)例 }

而ILogger的實(shí)現(xiàn)，也相對(duì)簡單，除了實(shí)現(xiàn)通用的日志記錄方法以外，還需要實(shí)現(xiàn)一個(gè)日志級(jí)別判斷的方法以及一個(gè)作用域創(chuàng)建方法，接口定義如下：

public interface ILogger {//支持大多數(shù)日志記錄的通用方法，其它訪問通過擴(kuò)展方法進(jìn)行完善void Log(LogLevel logLevel, int eventId, object state, Exception exception, Func<object, Exception, string> formatter);//判斷是否可以記錄給定的日志級(jí)別bool IsEnabled(LogLevel logLevel);//開啟一個(gè)邏輯操作作用域IDisposable BeginScopeImpl(object state); }

實(shí)現(xiàn)了上述兩個(gè)接口，即可通過factory的AddProvider方法，將該provider添加到實(shí)例中，達(dá)到記錄日志的目的。ASP.NET 5中目前的默認(rèn)實(shí)現(xiàn)了4中日志記錄Provider，分別是：Console、NLog、Serilog、Trace，注冊(cè)這些Provider的時(shí)候，均可以使用擴(kuò)展方法，實(shí)例如下：

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的擴(kuò)展方法

為了方便記錄日志，微軟在Microsoft.Framework.Logging.LoggerExtensions上，針對(duì)6個(gè)級(jí)別的日志記錄均定義了6個(gè)如下形式的擴(kuò)展方法，實(shí)例如下：

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()規(guī)則.

所以使用的時(shí)候，我們可以使用像LogDebug()、LogError()這樣的方法來進(jìn)行快速記錄日志。另外，該類還為Warning、Error、Critical三個(gè)級(jí)別，又分別定義了2個(gè)擴(kuò)展方法，示例如下：

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

有些這些擴(kuò)展方法，使用起來估計(jì)打遍天下無敵手了。

總結(jié)

通過基于接口的編程機(jī)制和DI依賴注入機(jī)制，我們可以很容易實(shí)現(xiàn)第三方日志provider的擴(kuò)展，從而將日志記錄到我們想記錄的任意地方，如MongoDB等NoSQL數(shù)據(jù)庫。

同步與推薦

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

posted on 2015-05-27 10:49 NET未來之路 閱讀(...) 評(píng)論(...) 編輯 收藏

轉(zhuǎn)載于:https://www.cnblogs.com/lonelyxmas/p/4532785.html

總結(jié)

以上是生活随笔為你收集整理的解读ASP.NET 5 MVC6系列（9）：日志框架的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。