項目源文件下載https://files.cnblogs.com/files/ckym/Log4NetTestSourceCode.zip Log4net是一款非常好用的日誌記錄的框架,使用它可以實現將日誌輸出到控制台,文件,資料庫等功能 網上有很多log4net的使用教程,一些非常簡陋,一些又很深 ...
項目源文件下載https://files.cnblogs.com/files/ckym/Log4NetTestSourceCode.zip
Log4net是一款非常好用的日誌記錄的框架,使用它可以實現將日誌輸出到控制台,文件,資料庫等功能
網上有很多log4net的使用教程,一些非常簡陋,一些又很深奧,我學習使用log4net的時候查閱了很多資料,為了可以記住相關功能的實現方式,故記錄這篇文章,僅用於初學者使用此文檔來進行學習,如有錯誤,請大神不吝賜教,更多深入用法和原理請大家查詢相關文檔。
- 1. 新建一個控制台應用程式(Core)
- 2. 在Nuget中安裝log4net完成之後新建一個log4net的配置文件,配置文件示例如下
<?xml version="1.0" encoding="utf-8" ?>
<log4net>
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
<layout type="log4net.Layout.PatternLayout" value="%date [%thread] %-5level %logger - %message%newline" />
</appender>
<appender name="FileAppender" type="log4net.Appender.FileAppender">
<file value="log-file.log" />
<appendToFile value="true" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
</layout>
</appender>
<appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="Log/" />
<appendToFile value="true" />
<rollingStyle value="Composite" />
<staticLogFileName value="false" />
<datePattern value="yyyyMMdd'.log'" />
<maxSizeRollBackups value="10" />
<maximumFileSize value="1MB" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
</layout>
</appender>
<!-- name屬性指定其名稱,type則是log4net.Appender命名空間的一個類的名稱,意思是,指定使用哪種介質-->
<appender name="ADONetAppender" type="MicroKnights.Logging.AdoNetAppender, log4net.AdoNetAppender">
<!--日誌緩存寫入條數 設置為0時只要有一條就立刻寫到資料庫-->
<bufferSize value="1" />
<!--日誌資料庫連接串-->
<connectionType value="System.Data.SqlClient.SqlConnection, System.Data" />
<connectionString value="Data Source=(localdb)\MSSQLLocalDB;Initial Catalog=SCTest;Integrated Security=True;Connect Timeout=30;Encrypt=False;TrustServerCertificate=False;ApplicationIntent=ReadWrite;MultiSubnetFailover=False;" />
<!--日誌資料庫腳本-->
<commandText value="INSERT INTO Sys_Logs (ID,CreateTime,CreateUser,LogLevel,Message,UserIP) VALUES (4,@CreateTime,@CreateUser,@LogLevel,@CustomMessage,@UserIP)" />
<!--日誌時間LogDate -->
<parameter>
<parameterName value="@CreateTime" />
<dbType value="DateTime" />
<layout type="log4net.Layout.RawTimeStampLayout" />
</parameter>
<parameter>
<parameterName value="@LogLevel" />
<dbType value="String" />
<size value="200" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%p" />
</layout>
</parameter>
<parameter>
<parameterName value="@CustomMessage" />
<dbType value="String" />
<size value="3000" />
<layout type="Log4NetTest.CustomLayout,Log4NetTest">
<conversionPattern value="%CustomMessage{CustomMessage}" />
</layout>
</parameter>
<!--自定義UserName -->
<parameter>
<parameterName value="@CreateUser" />
<dbType value="String" />
<size value="30" />
<layout type="Log4NetTest.CustomLayout,Log4NetTest" >
<conversionPattern value = "%CreateUser{CreateUser}"/>
</layout>
</parameter>
<parameter>
<parameterName value="@UserIP" />
<dbType value="String" />
<size value="20" />
<layout type="Log4NetTest.CustomLayout,Log4NetTest" >
<conversionPattern value = "%UserIP{UserIP}"/>
</layout>
</parameter>
</appender>
<!-- Setup the root category, add the appenders and set the default level -->
<root>
<level value="ALL" />
<appender-ref ref="ConsoleAppender" />
<appender-ref ref="FileAppender" />
<appender-ref ref="RollingLogFileAppender" />
<appender-ref ref="ADONetAppender" />
</root>
</log4net>
接著在App.config中添加如下行
<configuration>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler,log4net" />
</configuration>
然後再Main文件中添加如下代碼
ILoggerRepository repository = LogManager.CreateRepository("MyCustomRepository");
//BasicConfigurator.Configure(repository);//簡單配置,只能寫日誌到控制台
//讀取配置文件的方式實現
//var log4NetConfig = new XmlDocument();
//log4NetConfig.Load(File.OpenRead("log4net.config"));
//XmlConfigurator.Configure(repository, log4NetConfig["log4net"]);
//直接使用文件的方式
//註意,要求所有的配置文件必須放置在Debug文件夾下麵,否則會造成程式不報錯,但是也不能正確寫入文件的問題
XmlConfigurator.Configure(repository, new FileInfo("log4net.config"));
ILog log = LogManager.GetLogger(repository.Name,"MyCustomLogger");
//log.Debug("This is a Log info From Log4net Test");
//log.Info("NETCorelog4net log");
//log.Info("test log");
//log.Error("error");
//log.Info("linezero");
//記錄日誌到資料庫
CustomLogInfo logInfo = new CustomLogInfo() { ID = new Random().Next(1, 100), Message = "This is a Log info By Log4Net", CreateUser = "SC", UserIP = Dns.GetHostAddresses(Dns.GetHostName())[0].ToString() };
log.Debug(logInfo);
Console.WriteLine("日誌記錄完成!");
Console.ReadKey();
根據註釋取消或者註釋掉相關的代碼,點擊運行,可以看到日誌輸出到文件,或者控制台,或者資料庫文件
異常處理:
- 找不到AdoNetAppender
在使用log4net2.0.8的時候我們運行會發現報錯,因為2.0.8的版本沒有提供AdoNetAppender,所以需要我們自己去實現,源代碼在項目中可以找到,其他資料庫,例如MySql,Oracle等資料庫一樣的實現方式
- 實現自定義的轉換器和佈局,這個可以參考原代碼的實現和註釋,即可實現相關的功能(註意需要反射的只是).
下麵是輸出的日誌模板的一下縮寫對應的關係,可以參考,這些是log4net中自帶的轉換器實現的。
1)NewLinePatternConverter
作用:換行;通配符:%newline,%n
2)LoggerPatternConverter
作用:顯示Logger名;通配符:%logger,%c
3)TypeNamePatternConverter
作用:顯示類名;通配符:%C,%class,%type
4)DatePatternConverter
作用:顯示時間;通配符:%d,%date
5)ExceptionPatternConverter
作用:異常信息;通配符:%exception
6)LineLocationPatternConverter
作用:語句所在的行號;通配符:%L,%line
7)MessagePatternConverter
作用:信息內容;通配符:%message,%m
8)LevelPatternConverter
作用:消息等級;通配符:%level,%p