框架介紹
在之前的.NET中，微軟還沒(méi)有提供過(guò)像樣的日志框架，目前能用的一些框架比如Log4Net、NLog、CommonLogging使用起來(lái)多多少少都有些費(fèi)勁，和java的SLF4J根本無(wú)法相比。但在新版的ASP.NET5中，可謂是牛氣沖天，微軟提供的Microsoft.Framework.Logging框架集可謂就是.NET版的SLF4J，提供相應(yīng)的接口，其它第三方組件可以根據(jù)接口實(shí)現(xiàn)自己的實(shí)現(xiàn)。
ILoggerFactory接口
ILoggerFactory接口是日志的入庫(kù)點(diǎn)，在系統(tǒng)中通過(guò)依賴注入可以獲取該接口的實(shí)例，并根據(jù)該示例創(chuàng)建日志記錄器ILogger來(lái)記錄日志，示例如下：
var factory = ServiceProvider.GetRequiredServiceILoggerFactory>();
var logger1 = factory.CreateLogger(typeof(HomeController).FullName); //CreateLogger
var logger2 = factory.CreateLoggerHomeController>(); //CreateLogger
logger1.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;
}
然后通過(guò)CreateLogger方法創(chuàng)建日志記錄器實(shí)例，最后再記錄日志。
ILoggerProvider和ILogger
所有的第三方實(shí)現(xiàn)都需要實(shí)現(xiàn)ILoggerProvider接口和ILogger接口，其中接口很簡(jiǎn)單，就是實(shí)現(xiàn)創(chuàng)建ILogger接口的方法即可，代碼如下：
public interface ILoggerProvider
{
ILogger CreateLogger(string name); //創(chuàng)建給定類別的ILgger實(shí)例
}
而ILogger的實(shí)現(xiàn)，也相對(duì)簡(jiǎn)單，除了實(shí)現(xiàn)通用的日志記錄方法以外，還需要實(shí)現(xiàn)一個(gè)日志級(jí)別判斷的方法以及一個(gè)作用域創(chuàng)建方法，接口定義如下：
public interface ILogger
{
//支持大多數(shù)日志記錄的通用方法，其它訪問(wèn)通過(guò)擴(kuò)展方法進(jìn)行完善
void Log(LogLevel logLevel, int eventId, object state, Exception exception, Funcobject, Exception, string> formatter);
//判斷是否可以記錄給定的日志級(jí)別
bool IsEnabled(LogLevel logLevel);
//開(kāi)啟一個(gè)邏輯操作作用域
IDisposable BeginScopeImpl(object state);
}
實(shí)現(xiàn)了上述兩個(gè)接口，即可通過(guò)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()這樣的方法來(lái)進(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ò)展方法，使用起來(lái)估計(jì)打遍天下無(wú)敵手了。
總結(jié)
通過(guò)基于接口的編程機(jī)制和DI依賴注入機(jī)制，我們可以很容易實(shí)現(xiàn)第三方日志provider的擴(kuò)展，從而將日志記錄到我們想記錄的任意地方，如MongoDB等NoSQL數(shù)據(jù)庫(kù)。
您可能感興趣的文章:- 解讀ASP.NET 5 & MVC6系列教程（7）：依賴注入
- 解讀ASP.NET 5 & MVC6系列教程（8）：Session與Caching
- 解讀ASP.NET 5 & MVC6系列教程（10）：Controller與Action
- 解讀ASP.NET 5 & MVC6系列教程（11）：Routing路由
- 解讀ASP.NET 5 & MVC6系列教程（12）：基于Lamda表達(dá)式的強(qiáng)類型Routing實(shí)現(xiàn)
- 解讀ASP.NET 5 & MVC6系列教程（13）：TagHelper
- 解讀ASP.NET 5 & MVC6系列教程（14）：View Component
- 解讀ASP.NET 5 & MVC6系列教程（15）：MvcOptions配置
- 解讀ASP.NET 5 & MVC6系列教程（16）：自定義View視圖文件查找邏輯
- 解讀ASP.NET 5 & MVC6系列教程（17）：MVC中的其他新特性
