C#實現Log4Net日志分類和自動維護實例

2020-01-24 02:19:08

字體：大中小

來源：轉載

供稿：網友

本文實例講述了C#實現Log4Net日志分類和自動維護的實現方法。分享給大家供大家參考。具體實現方法如下：

一、背景

在程序中，我們調試運行時信息，Log4Net是一個不錯的解決方案。不知道是我用的不好，用到最后反而都不想看日志了。原因是因為我n個功能使用的默認的Logger來記錄日志，這樣以來，所有功能記錄的信息都依賴同一個配置，于是所有的信息都在一個文件中，有時候查找起來，極其不方便。

我想，能不能按照功能分類呢？如果通過配置不同的logger，然后功能根據不同的LoggerName加載Ilog實例，是可以做到。但由于這些功能的log配置差異性極小，也許僅僅就是文件名不同。于是想通過代碼進行配置。

二、解決方案

想來這樣的需求應該也算正常，但經過查找，發現在log4j中有相關的咨詢，但看不懂，只能自己下載log4net的源碼，看看它的運行原理。

如果我們需要通過配置不同的ILog，流程是這樣的，首先要創建一個ILoggerRepository，通過它來進行日志等級的配置，和各種Appender，接著通過LogManager在ILoggerRepository獲取一個Ilog對象，就可以寫日志了。代碼如下:

復制代碼代碼如下:

public static ILog GetLogger(string repositoryName = "")
{
if (string.IsNullOrEmpty(repositoryName)) return LogManager.GetLogger("Defalut");

    ILoggerRepository repository = null;
    try
    {
repository = LogManager.GetRepository(repositoryName);
    }
    catch (Exception) { }

//找到直接返回ilog
if (repository != null)
return LogManager.GetLogger(repositoryName, "Defalut");

    //未找到則創建，多線程下很有可能創建時，就存在了
    try
    {
repository = LogManager.CreateRepository(repositoryName);
    }
    catch (Exception)
    {
repository = LogManager.GetRepository(repositoryName);
    }

//配置日志等級讀取Appsettings默認配置
var appSet = ConfigurationManager.AppSettings.AllKeys;

    //查找日志等級
    const string logLevel = "LogLevel";
    var hasSettings = Array.IndexOf(appSet, logLevel);
    if (hasSettings > -1)
    {
var level = ConfigurationManager.AppSettings[logLevel].ToLower();
if (level == "all") repository.Threshold = Level.All;
else if (level == "debug") repository.Threshold = Level.Debug;
else if (level == "info") repository.Threshold = Level.Info;
else if (level == "warn") repository.Threshold = Level.Warn;
else if (level == "error") repository.Threshold = Level.Error;
else if (level == "fatal") repository.Threshold = Level.Fatal;
else if (level == "off") repository.Threshold = Level.Off;
    }
    else repository.Threshold = Level.All;

    //查找輸出Appender
    const string logAppender = "LogAppender";
    hasSettings = Array.IndexOf(appSet, logAppender);
    if (hasSettings > -1)
    {
var appenders = ConfigurationManager.AppSettings[logAppender].ToLower().Split(',');
foreach (var appender in appenders)
{
     if (appender == "rollingfile") LoadRollingFileAppender(repository);
     else if (appender == "console") LoadConsoleAppender(repository);
     else if(appender == "trace") LoadTraceAppender(repository);
}
    }
    else LoadRollingFileAppender(repository);

return LogManager.GetLogger(repositoryName, "Default");
}

Log4net 會自動維護ILog和ILoggerRepository，所以不用保存，通過LogManger獲取即可。但是我沒有找到方法來查找指定的ILoggerRepository是否存在，所以在上述代碼中通過try catch進行判斷。由于我們是通過代碼方式配置log4net，但仍舊希望通過配置來設置日志等級和輸出類型，所以我選擇在Appsettings文件中進行配置，一次配置，針對所有的ILoggerRepository都生效。之所以不是針對每一個功能進行配置，主要是由于配置麻煩，而且如果真要這么做，直接在log4net中配置不同的logger，通過loggername引用，可能會更好些。

三、日志維護

于是接下來的問題是，如何刪除日志？

log4net可以配置RollingFileAppender，翻譯過來是滾動文件。通過設置MaximumFileSize和MaxSizeRollBackups 2個參數可以完成這樣的目的，該日志文件每達到一定大小就會產生一個新文件，文件最大總數則為MaxSizeRollBackups，但前提的是文件名一致。

比如我們采用如下配置：

復制代碼代碼如下:

<!--RollingFileAppender:輸出到文件中-->
<appender name="SysAppender" type="log4net.Appender.RollingFileAppender">
      <!--日志的路徑-->
      <file value="Logs/" />
      <!--是否覆蓋，默認是追加true-->
      <appendToFile value="true"/>
      <!--不占用日志文件進程-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <rollingStyle value="Composite"/>
      <!--文件名稱-->
      <DatePattern value="yyyy-MM-dd HH'時.log'"></DatePattern>
      <!--設置無限備份=-1 ，最大備份數為1000-->
      <param name="MaxSizeRollBackups" value="1000"/>
      <!--每個文件的大小-->
      <param name="MaximumFileSize" value="500KB"/>
      <!--名稱是否可以更改 為false為可以更改-->
      <param name="StaticLogFileName" value="false"/>
      <layout type="log4net.Layout.PatternLayout">
        <!--輸出格式-->
        <conversionPattern value="%n【記錄時間】%date%n【描述】%message%n"/>
      </layout>
</appender>

效果則是日志以小時為單位，每小時最大備份總數為1000，每到500kb后形成日志文件。當隨著天數的增加，文件也開始變多，需要我們自己去清理。所以上述配置可以稍微改下:

復制代碼代碼如下:

<!--RollingFileAppender:輸出到文件中-->
<appender name="SysAppender" type="log4net.Appender.RollingFileAppender">
      <!--日志的路徑-->
      <file value="Logs/日志.log" />
      <!--是否覆蓋，默認是追加true-->
      <appendToFile value="true"/>
      <!--不占用日志文件進程-->
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <rollingStyle value="Composite"/>
      <!--文件名稱-->
      <DatePattern value="yyyy-MM-dd HH'時.log'"></DatePattern>
      <!--設置無限備份=-1 ，最大備份數為1000-->
      <param name="MaxSizeRollBackups" value="1000"/>
      <!--每個文件的大小-->
      <param name="MaximumFileSize" value="500KB"/>
      <!--名稱是否可以更改 為false為可以更改-->
      <param name="StaticLogFileName" value="true"/>
      <layout type="log4net.Layout.PatternLayout">
        <!--輸出格式-->
        <conversionPattern value="%n【記錄時間】%date%n【描述】%message%n"/>
      </layout>
</appender>