C#使用Log4net實現(xiàn)將日志輸出到控制臺或者文本文檔

更新時間：2024年03月13日 08:35:35 作者：全棧小5

Log4net?是一個穩(wěn)定且功能豐富的日志庫,已經存在多年并且被廣泛使用,這篇文章主要為大家介紹了如何使用Log4net實現(xiàn)將日志輸出到控制臺或者文本文檔,感興趣的可以了解下

背景

最近在最一些并發(fā)方式的測試，發(fā)現(xiàn)自己之前封裝的一個日志插件報錯，盡管在寫日志時已經通過鎖的方式進行了優(yōu)化，但是依然無法解決并發(fā)時同一個文件同時訪問情況，會頻繁出現(xiàn)報錯提示xxx.txt文件正在被另一個進程訪問而不無法操作。

基于這個原因，暫時沒有想好很好的優(yōu)化方案，從而考慮使用第三方優(yōu)秀日志插件來解決并發(fā)情況。

插件簡介

Log4net 是一個穩(wěn)定且功能豐富的日志庫，已經存在多年并且被廣泛使用。

它支持多種輸出目標和格式，可以滿足各種日志記錄需求。

Log4net 具有靈活的配置選項，允許你根據(jù)需要定制日志記錄行為。

插件安裝

在項目中添加對 Log4net 的引用?？梢允褂?NuGet 包管理器來安裝 Log4net。

選擇一個合適版本進行安裝，博主這里選擇最新版本安裝。

配置文件

日志類型

在 log4net 中，日志類型一般分為以下幾種，對應不同的日志級別：

1.DEBUG

最詳細的日志級別，通常用于打印一些調試信息，僅在開發(fā)和調試階段使用，生產環(huán)境中通常不會記錄 DEBUG 級別的日志。

2.INFO

用于記錄程序正常運行時的重要信息，比如服務啟動、關鍵流程開始或結束等。對于用戶而言，通常不需要關注 INFO 級別的日志，但這些日志對于開發(fā)人員來說非常重要。

3.WARN

表明潛在的問題，但不會影響系統(tǒng)正常運行，比如某個接口請求參數(shù)不合法，程序采取了默認值處理；或者磁盤空間不足，但系統(tǒng)仍然能夠正常運行。WARN 級別的日志用于提示開發(fā)人員和運維人員需要注意的問題。

4.ERROR

用于記錄錯誤事件，但不會導致程序終止。比如捕獲到了一個異常，程序進行了相應的處理，不會導致程序崩潰。ERROR 級別的日志通常需要開發(fā)人員及時關注并處理。

5.FATAL

表示嚴重的錯誤事件，可能導致程序終止。比如未捕獲的異常、數(shù)據(jù)庫連接失敗等致命錯誤。FATAL 級別的日志表示系統(tǒng)出現(xiàn)了嚴重的錯誤，需要立即處理。

文件詳情

此配置文件內容，按日志級別創(chuàng)建文件，按時間年月日時來創(chuàng)建文件名，同一小時內超過10M文件大小則拆分文件保存。

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
    <!--定義日志級別-->
    <root>
        <level value="FATAL"/>
        <level value="ERROR"/>
        <level value="WARN"/>
        <level value="INFO"/>
        <level value="DEBUG"/>
        <appender-ref ref="FATALAppender" />
        <appender-ref ref="ERRORAppender" />
        <appender-ref ref="WARNAppender" />
        <appender-ref ref="INFOAppender" />
        <appender-ref ref="DebugAppender" />
    </root>

    <!--嚴重錯誤日志-->
    <appender name="FATALAppender" type="log4net.Appender.RollingFileAppender">
        <file type="log4net.Util.PatternString" value="logs\Fatal\%date{yyyyMMddHH}.log" />

        <appendToFile value="true" />
        <rollingStyle value="Size" />
        <staticLogFileName value="false"/>
        <maximumFileSize value="100KB"/>
        <maxSizeRollBackups value="-1"/>

        <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%date [%thread] %-5level %logger - %message - %line" />
        </layout>
    </appender>

    <!--調試日志-->
    <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
        <file type="log4net.Util.PatternString" value="logs\Debug\%date{yyyyMMddHH}.log" />

        <appendToFile value="true" />
        <rollingStyle value="Size" />
        <staticLogFileName value="false"/>
        <maximumFileSize value="100KB"/>
        <maxSizeRollBackups value="-1"/>

        <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%date [%thread] %-5level %logger - %message - %line" />
        </layout>
    </appender>
</log4net>

通過使用不同級別的日志記錄，開發(fā)人員和運維人員可以更好地了解系統(tǒng)的運行情況，及時發(fā)現(xiàn)潛在問題，并采取相應的措施進行處理。

日志設置

命名空間

using log4net;
using log4net.Config;
using System.Reflection;

實例化

// 日志插件
var logRepository = LogManager.GetRepository(Assembly.GetEntryAssembly());
XmlConfigurator.Configure(logRepository, new FileInfo(Path.Combine(AppContext.BaseDirectory, "log4net.config")));

日志調用

private static readonly ILog log = LogManager.GetLogger(typeof(SqlHelper));

public void Test()
{    
    log.Fatal("Fatal message");
    log.Debug("Debug message");
    log.Info("Info message");
    log.Warn("Warn message");
    log.Error("Error message");
}

輸出控制臺

根據(jù)上面默認配置文件信息，日志信息輸出到控制臺里。

使用的類型是log4net.Appender.ConsoleAppender

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
        <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
            <layout type="log4net.Layout.PatternLayout">
                <conversionPattern value="%date [%thread] %-5level %logger - %message%line" />
            </layout>
        </appender>

        <root>
            <level value="DEBUG" />
            <appender-ref ref="ConsoleAppender" />
        </root>
</log4net>

輸出文本文檔

根據(jù)上面默認配置文件信息，日志信息輸出到文本文檔里。

使用的類型是log4net.Appender.Appender.RollingFileAppender

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
    <!--定義日志級別-->
    <root>
        <level value="DEBUG"/>
        <appender-ref ref="DebugAppender" />
    </root>
 
    <!--調試日志-->
    <appender name="DebugAppender" type="log4net.Appender.RollingFileAppender">
        <file type="log4net.Util.PatternString" value="logs\Debug\%date{yyyyMMddHH}.log" />

        <appendToFile value="true" />
        <rollingStyle value="Size" />
        <staticLogFileName value="false"/>
        <maximumFileSize value="100KB"/>
        <maxSizeRollBackups value="-1"/>

        <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
        <layout type="log4net.Layout.PatternLayout">
            <conversionPattern value="%date [%thread] %-5level %logger - %message - %line" />
        </layout>
    </appender>
</log4net>