解讀ASP.NET 5 & MVC6系列教程(9):日志框架
框架介紹
在之前的.NET中,微軟還沒有提供過像樣的日志框架,目前能用的一些框架比如Log4Net、NLog、CommonLogging使用起來多多少少都有些費勁,和java的SLF4J根本無法相比。但在新版的ASP.NET5中,可謂是牛氣沖天,微軟提供的Microsoft.Framework.Logging框架集可謂就是.NET版的SLF4J,提供相應(yīng)的接口,其它第三方組件可以根據(jù)接口實現(xiàn)自己的實現(xiàn)。
ILoggerFactory接口
ILoggerFactory
接口是日志的入庫點,在系統(tǒng)中通過依賴注入可以獲取該接口的實例,并根據(jù)該示例創(chuàng)建日志記錄器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參數(shù)中獲取上述示例。
ILoggerFactory
接口的定義如下:
public interface ILoggerFactory { //日志最小記錄級別 LogLevel MinimumLevel { get; set; } //創(chuàng)建日志記錄實例 ILogger CreateLogger(string categoryName); //一般是根據(jù)功能模塊或類名進行分類 void AddProvider(ILoggerProvider provider); // 添加日志記錄provider(如第三方實現(xiàn)) }
在該接口的實現(xiàn)中,我們可以設(shè)置日志的最小記錄基本,其類別如下:
public enum LogLevel { Debug = 1, Verbose = 2, Information = 3, Warning = 4, Error = 5, Critical = 6, }
也可以添加第三方實現(xiàn)的Provider,比如添加一個控制臺版本的實現(xiàn):
public static ILoggerFactory AddConsole(this ILoggerFactory factory) { factory.AddProvider(new ConsoleLoggerProvider((category, logLevel) => logLevel >= LogLevel.Information)); return factory; }
然后通過CreateLogger方法創(chuàng)建日志記錄器實例,最后再記錄日志。
ILoggerProvider和ILogger
所有的第三方實現(xiàn)都需要實現(xiàn)ILoggerProvider接口和ILogger接口,其中接口很簡單,就是實現(xiàn)創(chuàng)建ILogger接口的方法即可,代碼如下:
public interface ILoggerProvider { ILogger CreateLogger(string name); //創(chuàng)建給定類別的ILgger實例 }
而ILogger的實現(xiàn),也相對簡單,除了實現(xiàn)通用的日志記錄方法以外,還需要實現(xiàn)一個日志級別判斷的方法以及一個作用域創(chuàng)建方法,接口定義如下:
public interface ILogger { //支持大多數(shù)日志記錄的通用方法,其它訪問通過擴展方法進行完善 void Log(LogLevel logLevel, int eventId, object state, Exception exception, Func<object, Exception, string> formatter); //判斷是否可以記錄給定的日志級別 bool IsEnabled(LogLevel logLevel); //開啟一個邏輯操作作用域 IDisposable BeginScopeImpl(object state); }
實現(xiàn)了上述兩個接口,即可通過factory
的AddProvider
方法,將該provider添加到實例中,達到記錄日志的目的。ASP.NET 5中目前的默認實現(xiàn)了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()規(guī)則.
所以使用的時候,我們可以使用像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)
有些這些擴展方法,使用起來估計打遍天下無敵手了。
總結(jié)
通過基于接口的編程機制和DI依賴注入機制,我們可以很容易實現(xiàn)第三方日志provider的擴展,從而將日志記錄到我們想記錄的任意地方,如MongoDB等NoSQL數(shù)據(jù)庫。
相關(guān)文章
在ASP.NET 2.0中操作數(shù)據(jù)之三十一:使用DataList來一行顯示多條記錄
ASP.NET 2.0中DataList默認情況使用單列多行的table來顯示項,本文介紹通過設(shè)置RepeatColumns屬性為每行的列數(shù)就可以達到顯示多條記錄這個目的。2016-05-05在ASP.NET 2.0中操作數(shù)據(jù)之六十一:在事務(wù)里對數(shù)據(jù)庫修改進行封裝
事務(wù)的最主要的一個作用就是保證數(shù)據(jù)的完整性,本文主要介紹ASP.NET 2.0中使用事務(wù)對修改數(shù)據(jù)進行封裝,這些包含事務(wù)的命令要么都執(zhí)行成功要么都執(zhí)行失敗。2016-05-05在ASP.NET 2.0中操作數(shù)據(jù)之一:創(chuàng)建一個數(shù)據(jù)訪問層
本文主要介紹創(chuàng)建數(shù)據(jù)訪問層的具體步驟,從配置數(shù)據(jù)庫連接到插入,更新和刪除數(shù)據(jù)的具體實現(xiàn)方法,希望對大家有所幫助。2016-04-04在ASP.NET 2.0中操作數(shù)據(jù)之六十六:在TableAdapters中使用現(xiàn)有的存儲過程
雖然通過TableAdapter向?qū)Э梢宰詣拥纳纱鎯^程,但是在某些時候我們需要使用現(xiàn)有的存儲過程。本文將講解如何在Visual Studio環(huán)境里手動添加存儲過程,并引導(dǎo)TableAdapter的方法使用這些存儲過程。2016-05-05在ASP.NET 2.0中操作數(shù)據(jù)之四十三:DataList和Repeater數(shù)據(jù)排序(二)
上篇已經(jīng)介紹了DropDownList隱式使用ViewState,本文主要介紹詳細介紹直接使用ViewState存儲排序的條件,并配合上一頁、下一頁按鈕,實現(xiàn)DataList和Repeater自定義排序的功能。2016-05-05在ASP.NET 2.0中操作數(shù)據(jù)之七十三:用Managed Code創(chuàng)建存儲過程和用戶自定義函數(shù)(上部分)
Microsoft SQL Server 2005整合了Common Language Runtime (CLR),它允許用managed code來創(chuàng)建數(shù)據(jù)庫對象,本文主要介紹了如何使用managed code創(chuàng)建存儲過程。2016-05-05在ASP.NET 2.0中操作數(shù)據(jù)之二十八:GridView里的Button
本文主要介紹ASP.NET 2.0在GridView,DetailsView,FormView都可以包含Buttons,LinkButtons,或ImageButtons.這些button被點擊時,并激發(fā)FormView和DetailsView的ItemCommand事件,GridView的RowCommand事件,根據(jù)CommandName的值來判斷哪個button被點擊了,執(zhí)行相應(yīng)的代碼。2016-05-05使用.Net6中的WebApplication打造最小API
本文詳細講解了使用.Net6中的WebApplication打造最小API,文中通過示例代碼介紹的非常詳細。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-12-12