在.NET 6中使用日誌元件log4net的方法
本文將簡單介紹在.NET 6中使用log4net的方法,具體見下文範例。
1.首先新建一個ASP.NET Core空專案
2.通過Nuget包管理器安裝下面兩個包
log4net
Microsoft.Extensions.Logging.Log4Net.AspNetCore
3.在專案根目錄下新建log4net的配置檔案log4net.config,並將其設定為始終複製。
<?xml version="1.0" encoding="utf-8" ?> <log4net> <!--根配置--> <root> <!--日誌級別:可選值: ERROR > WARN > INFO > DEBUG --> <level value="ERROR"/> <level value="WARN"/> <level value="INFO"/> <level value="DEBUG"/> <appender-ref ref="ErrorLog" /> <appender-ref ref="WarnLog" /> <appender-ref ref="InfoLog" /> <appender-ref ref="DebugLog" /> </root> <!-- 錯誤 Error.log--> <appender name="ErrorLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,可以是相對路徑或絕對路徑--> <param name="File" value="C:\logs\"/> <!--檔名,按日期生成資料夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Error.log""/> <!--追加到檔案--> <appendToFile value="true"/> <!--建立日誌檔案的方式,可選值:Date[日期],檔案大小[Size],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個檔案--> <staticLogFileName value="false"/> <!--單個檔案大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的檔案數,設為"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="[%d{HH:mm:ss}]%m%n"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="ERROR" /> <param name="LevelMax" value="ERROR" /> </filter> </appender> <!-- 警告 Warn.log--> <appender name="WarnLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,可以是相對路徑或絕對路徑--> <param name="File" value="C:\logs\"/> <!--檔名,按日期生成資料夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Warn.log""/> <!--追加到檔案--> <appendToFile value="true"/> <!--建立日誌檔案的方式,可選值:Date[日期],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個檔案--> <staticLogFileName value="false"/> <!--單個檔案大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的檔案數,設為"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="[%d{HH:mm:ss}]%m%n"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="WARN" /> <param name="LevelMax" value="WARN" /> </filter> </appender> <!-- 資訊 Info.log--> <appender name="InfoLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,可以是相對路徑或絕對路徑--> <param name="File" value="C:\logs\"/> <!--檔名,按日期生成資料夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Info.log""/> <!--追加到檔案--> <appendToFile value="true"/> <!--建立日誌檔案的方式,可選值:Date[日期],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個檔案--> <staticLogFileName value="false"/> <!--單個檔案大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的檔案數,設為"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="[%d{HH:mm:ss}]%m%n"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="INFO" /> <param name="LevelMax" value="INFO" /> </filter> </appender> <!-- 除錯 Debug.log--> <appender name="DebugLog" type="log4net.Appender.RollingFileAppender"> <!--目錄路徑,可以是相對路徑或絕對路徑--> <param name="File" value="C:\logs\"/> <!--檔名,按日期生成資料夾--> <param name="DatePattern" value="/yyyy-MM-dd/"Debug.log""/> <!--追加到檔案--> <appendToFile value="true"/> <!--建立日誌檔案的方式,可選值:Date[日期],混合[Composite]--> <rollingStyle value="Composite"/> <!--寫到一個檔案--> <staticLogFileName value="false"/> <!--單個檔案大小。單位:KB|MB|GB--> <maximumFileSize value="200MB"/> <!--最多保留的檔案數,設為"-1"則不限--> <maxSizeRollBackups value="-1"/> <!--日誌格式--> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="[%d{HH:mm:ss}]%m%n"/> </layout> <filter type="log4net.Filter.LevelRangeFilter"> <param name="LevelMin" value="DEBUG" /> <param name="LevelMax" value="DEBUG" /> </filter> </appender> </log4net>
log4net配置引數此處不多贅述,只針對日誌的輸出格式引數conversionPattern
配置做簡要說明。
%M 輸出日誌方法名 %m 輸出日誌訊息內容 %p 輸出優先順序,即DEBUG,INFO,WARN,ERROR,FATAL %r 輸出自應用啟動到輸出該log資訊耗費的毫秒數 %c 輸出所屬的類目,通常就是所在類的全名 %t 輸出產生該日誌事件的執行緒名 %n 輸出一個換行符 %l或%L 輸出日誌事件的發生位置,包括類目名、發生的執行緒,以及在程式碼中的行數。 %c 輸出日誌資訊所屬的類的全名 %d 輸出完整的日誌時間點的日期時間,支援自定義格式。比如:%d{HH:mm:ss},輸出類似:22:10:28 %f 輸出日誌資訊所屬的類的類名
4.在Program中使用log4net輸出自定義日誌內容
using log4net; var builder = WebApplication.CreateBuilder(args); //注入Log4Net builder.Services.AddLogging(cfg => { cfg.AddLog4Net(); //預設的配置檔案路徑是在根目錄,且檔名為log4net.config //如果檔案路徑或名稱有變化,需要重新設定其路徑或名稱 //比如在專案根目錄下建立一個名為cfg的資料夾,將log4net.config檔案移入其中,並改名為log.config //則需要使用下面的程式碼來進行配置 //cfg.AddLog4Net(new Log4NetProviderOptions() //{ // Log4NetConfigFileName = "cfg/log.config",// Watch = true //}); }); var app = buildhttp://www.cppcns.comewww.cppcns.comr.Build(); //訪問根頁面時 app.MapGet("/",(ILogger<Program> logger) => { logger.LogInformation("logger:測試一下Log4Net=》Info"); return "Hello World!"; }); //訪問test頁面時 app.MapGet("/test",() => { var log = LogManager.GetLogger(typeof(Program)); log.Info("log:這是一條普通日誌資訊"); }); app.Run();
5.將專案執行起來,即可發現日誌檔案已生成
6.擴充套件使用:使用簡單工廠模式IOC注入到自定義類中使用
新建一個ITestLog4Net
介面檔案,併為其定義一個Log
方法。
並且新建一yQVBZcvF個TestLog4Net
的自定義類,繼承於ITestLog4Net
,並實現該Log
方法。
在Program中注入我們的自定義類TestLog4Net
builder.Services.AddTransient<ITestLog4Net,TestLog4Net>();
testLog4Net.Log();
使用方法
var testLog4Net = app.Services.GetServ客棧ice<ITestLog4Net>()!;
或者
var services = new ServiceCollection()!;
var provider = services.BuildServiceProvider()!;
var testLog4Net = provider.GetService<ITestLog4Net>()!;
testLog4Net.Log();
其中,使用下面這種寫法,將會收到一個編譯警告資訊。
warning ASP0000: Calling 'BuildServiceProvider' from application code results in an additional copy of singleton services being created. Consider alternatives such as dependency injecting services as parameters to 'Configure'.
推薦使用上面的寫法,百度之後,得到的答案是:不要通過呼叫BuildServiceProvider()這個方法應該只被 Host 呼叫一次。重複的服務提供者可能會導致一些意想不到的錯誤。如果有哪位大佬知道具體原因,請告知一下,謝謝!
Tips:程式碼中的感嘆號!表示該物件不會為空,一定要確保該物件不會為空才能這樣寫,這是C#10中的新特性。
到此這篇關於在.NET 6中使用日誌元件log4net的文章就介紹到這了。希望對大家的學習有所幫助,也希望大家多多支援我們。