一、前言
在項目開發的過程中，日志是必不可少的一部分，可以幫我們定位異常，分析錯誤原因等功能，log4net是.Net下一個非常優秀的開源日志記錄組件。log4net記錄日志的功能非常強大。它可以將日志分不同的等級，以不同的格式，輸出到不同的媒介。本文主要是介紹在前幾篇已經創建好的項目里加上日志處理機制
二、安裝並使用log4net
1.使用nuget安裝log4net
2.log4net的用法類似下面的代碼：
[Route("log4")] [HttpGet] public IHttpActionResult Log() { // 通過LogManager的靜態方法GetLogger生成一個Ilog對象 ILog log = LogManager.GetLogger(typeof(IndexController)); // 下面是日志處理 log.Debug("測試debug", new Exception("debug異常")); log.Info("測試Info", new Exception("Info異常")); log.Warn("測試Warn", new Exception("Warn異常")); log.Error("測試Error", new Exception("Error異常")); log.Fatal("測試Fatal", new Exception("Fatal異常")); return Ok("已經寫入日志"); }
3.運行項目，瀏覽器調用請求
三、通過autofac解耦Ilog對象
1.我們用autofac的Module方式去注冊log4net組件，項目AutoFac目錄下新建Module文件夾，並新建LoggingModule類
public class LoggingModule : Autofac.Module { private static void InjectLoggerProperties(object instance) { var instanceType = instance.GetType(); // Get all the injectable properties to set. // If you wanted to ensure the properties were only UNSET properties, // here's where you'd do it. var properties = instanceType .GetProperties(BindingFlags.Public | BindingFlags.Instance) .Where(p => p.PropertyType == typeof(ILog) && p.CanWrite && p.GetIndexParameters().Length == 0); // Set the properties located. foreach (var propToSet in properties) { propToSet.SetValue(instance, LogManager.GetLogger(instanceType), null); } } private static void OnComponentPreparing(object sender, PreparingEventArgs e) { e.Parameters = e.Parameters.Union( new[] { new ResolvedParameter( (p, i) => p.ParameterType == typeof(ILog), (p, i) => LogManager.GetLogger(p.Member.DeclaringType) ), }); } protected override void AttachToComponentRegistration(IComponentRegistry componentRegistry, IComponentRegistration registration) { registration.Preparing += OnComponentPreparing; // Handle properties. registration.Activated += (sender, e) => InjectLoggerProperties(e.Instance); } }
這段代碼為autofac官網里提供的，參考地址：http://autofaccn.readthedocs.io/en/latest/examples/log4net.html?highlight=module
2.ContainerBuilerCommon下注冊module
public static IContainer GetWebApiContainer() { var builder = new ContainerBuilder(); // 注冊webapi的所有控制器 builder.RegisterApiControllers(Assembly.GetExecutingAssembly()); // 注冊一個用於測試的組件。 builder.RegisterType<Person>(); //注冊日志組件 builder.RegisterModule<LoggingModule>(); return builder.Build(); }
3.控制器通過構造函數注入Ilog
private ILog _log; public IndexController(ILog log, Person person) { _person = person; _log = log; }
4.新建get請求
[Route("autolog4")] [HttpGet] public IHttpActionResult AutoLog() { // 通過LogManager的靜態方法GetLogger生成一個Ilog對象 _log.Debug("測試debug", new Exception("debug異常")); _log.Info("測試Info", new Exception("Info異常")); _log.Warn("測試Warn", new Exception("Warn異常")); _log.Error("測試Error", new Exception("Error異常")); _log.Fatal("測試Fatal", new Exception("Fatal異常")); return Ok("已經寫入日志"); }
5.現在編譯程序后用postman工具的get方法訪問接口：http://localhost:xxx/api/autolog4，程序是運行正常的 。但現在日志即沒有寫入到某個文件、數據庫或是發送到郵件里，也沒有輸出到控制台上。這就是log4net的設計的好處，在程序里你只管做日志的處理，如調用ILog的Debug()、Info()、Warn()、Error()、Fatal()，至於日志是由什么機制去處理（如寫入文件，寫入數據庫等）是由另一個流程來控制，即log4net的配置文件。如果程序里沒有log4net的配置文件，程序也能正常運行。
四、配置Log4net
1.新建Log4net.config，代碼如下
<?xml version="1.0" encoding="utf-8"?> <configuration> <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/> </configSections> <system.web> <compilation debug="true" targetFramework="4.5.2" /> <httpRuntime targetFramework="4.5.2" /> </system.web> <log4net> <!--錯誤日志：：：記錄錯誤日志--> <!--按日期分割日志文件 一天一個--> <!-- appender 定義日志輸出方式 將日志以回滾文件的形式寫到文件中。--> <appender name="ErrorAppender" type="log4net.Appender.RollingFileAppender"> <!--保存路徑：下面路徑項目啟動的時候自動在C盤中創建log、logError文件--> <file value="log/error/error_" /> <!-- 如果想在本項目中添加路徑，那就直接去掉C:\\ 只設置log\\LogError 項目啟動中默認創建文件 --> <appendToFile value="true"/> <!--按照何種方式產生多個日志文件(日期[Date],文件大小[Size],混合[Composite])--> <rollingStyle value="Date"/> <!--這是按日期產生文件夾--> <datePattern value="yyyy-MM-dd'.log'"/> <!--是否只寫到一個文件中--> <staticLogFileName value="false"/> <!--保留的log文件數量 超過此數量后 自動刪除之前的 好像只有在 按Size分割時有效 設定值value="－1"為不限文件數--> <param name="MaxSizeRollBackups" value="100"/> <!--每個文件的大小。只在混合方式與文件大小方式下使用。超出大小后在所有文件名后自動增加正整數重新命名，數字最大的最早寫入。可用的單位:KB|MB|GB。不要使用小數,否則會一直寫入當前日志--> <maximumFileSize value="50M" /> <!-- layout 控制Appender的輸出格式，也可以是xml 一個Appender只能是一個layout--> <layout type="log4net.Layout.PatternLayout"> <!--每條日志末尾的文字說明--> <!--輸出格式 模板--> <!-- <param name="ConversionPattern" value="記錄時間：%date 線程ID:[%thread] 日志級別：%-5level 記錄類：%logger 操作者ID：%property{Operator} 操作類型：%property{Action}%n 當前機器名:%property%n當前機器名及登錄用戶：%username %n 記錄位置：%location%n 消息描述：%property{Message}%n 異常：%exception%n 消息：%message%newline%n%n" />--> <!--樣例：2008-03-26 13:42:32,111 [10] INFO Log4NetDemo.MainClass [(null)] - info--> <!--<conversionPattern value="%newline %n記錄時間：%date %n線程ID:[%thread] %n日志級別： %-5level %n錯誤描述：%message%newline %n"/>--> <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝ %n【日志級別】%-5level %n【記錄時間】%date %n【執行時間】[%r]毫秒 %n【出錯文件】%F %n【出錯行號】%L %n【出錯的類】%logger 屬性[%property{NDC}] %n【錯誤描述】%message %n【錯誤詳情】%newline"/> </layout> <filter type="log4net.Filter.LevelRangeFilter,log4net"> <levelMin value="ERROR" /> <levelMax value="FATAL" /> </filter> </appender> <!--DEBUG：：：記錄DEBUG日志--> <!--按日期分割日志文件 一天一個--> <!-- appender 定義日志輸出方式 將日志以回滾文件的形式寫到文件中。--> <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender"> <!--保存路徑：下面路徑項目啟動的時候自動在C盤中創建log、logError文件--> <file value="log/debug/debug_" /> <!-- 如果想在本項目中添加路徑，那就直接去掉C:\\ 只設置log\\LogError 項目啟動中默認創建文件 --> <appendToFile value="true"/> <!--按照何種方式產生多個日志文件(日期[Date],文件大小[Size],混合[Composite])--> <rollingStyle value="Date"/> <!--這是按日期產生文件夾--> <datePattern value="yyyy-MM-dd'.log'"/> <!--是否只寫到一個文件中--> <staticLogFileName value="false"/> <!--保留的log文件數量 超過此數量后 自動刪除之前的 好像只有在 按Size分割時有效 設定值value="－1"為不限文件數--> <param name="MaxSizeRollBackups" value="100"/> <!--每個文件的大小。只在混合方式與文件大小方式下使用。超出大小后在所有文件名后自動增加正整數重新命名，數字最大的最早寫入。可用的單位:KB|MB|GB。不要使用小數,否則會一直寫入當前日志--> <maximumFileSize value="50M" /> <!-- layout 控制Appender的輸出格式，也可以是xml 一個Appender只能是一個layout--> <layout type="log4net.Layout.PatternLayout"> <!--每條日志末尾的文字說明--> <!--輸出格式 模板--> <!-- <param name="ConversionPattern" value="記錄時間：%date 線程ID:[%thread] 日志級別：%-5level 記錄類：%logger 操作者ID：%property{Operator} 操作類型：%property{Action}%n 當前機器名:%property%n當前機器名及登錄用戶：%username %n 記錄位置：%location%n 消息描述：%property{Message}%n 異常：%exception%n 消息：%message%newline%n%n" />--> <!--樣例：2008-03-26 13:42:32,111 [10] INFO Log4NetDemo.MainClass [(null)] - info--> <!--<conversionPattern value="%newline %n記錄時間：%date %n線程ID:[%thread] %n日志級別： %-5level %n錯誤描述：%message%newline %n"/>--> <conversionPattern value="%n＝＝＝＝＝＝＝＝＝＝ %n【日志級別】%-2level %n【記錄時間】%date %n【執行時間】[%r]毫秒 %n【debug文件】%F %n【debug行號】%L %n【debug類】%logger 屬性[%property{NDC}] %n【debug描述】%message"/> </layout> <filter type="log4net.Filter.LevelRangeFilter,log4net"> <levelMin value="DEBUG" /> <levelMax value="WARN" /> </filter> </appender> <!--Set root logger level to DEBUG and its only appender to A1--> <root> <!--控制級別，由低到高: ALL|DEBUG|INFO|WARN|ERROR|FATAL|OFF--> <level value="ALL" /> <appender-ref ref="DebugAppender" /> <appender-ref ref="ErrorAppender" /> </root> </log4net> </configuration>
2.properties下的AssemblyInfo.cs文件里添加以下代碼：
[assembly: XmlConfigurator(Watch = true, ConfigFile = "Log4Net.config")]
3.運行程序，調用日志請求，log4net會在項目主目錄下的log文件夾生成日志文件
DEBUG日志:
ERROR日志:
