DailyRollingFileAppender的基本使用

houxian1103發表於2020-11-07

DailyRollingFileAppender是日誌記錄軟體包Log4J中的一個Appender,它能夠按一定的頻度滾動日誌記錄檔案。

我們可以按下面的方式配置DailyRollingFileAppender:

log4j.rootCategory=INFO,file
log4j.appender.file=org.apache.log4j.DailyRollingFileAppender
log4j.appender.file.DatePattern='.'yyyy-MM-dd
log4j.appender.file.File=run.log
log4j.appender.file.Append=true
log4j.appender.file.Threshold=INFO
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%c %x - %m%n   

在DailyRollingFileAppender中可以指定monthly(每月)、 weekly(每週)、daily(每天)、half-daily(每半天)、hourly(每小時)和minutely(每分鐘)六個頻度,這是通過為 DatePattern選項賦予不同的值來完成的。DatePattern選項的有效值為:

  • '.'yyyy-MM,對應monthly(每月)
  • '.'yyyy-ww,對應weekly(每週)
  • '.'yyyy-MM-dd,對應daily(每天)
  • '.'yyyy-MM-dd-a,對應half-daily(每半天)
  • '.'yyyy-MM-dd-HH,對應hourly(每小時)
  • '.'yyyy-MM-dd-HH-mm,對應minutely(每分鐘)

DatePattern中不用處理的文字要放到單引號(')中,如上面的(.)。如果您對此有疑問可以查閱SimpleDateFormat的文件。DailyRollingFileAppender中使用這個類來處理DatePattern。

DatePattern格式化之後的文字作為檔名字的字尾。DailyRollingFileAppender不支援格式化之後的文字作為檔名字的字首。

DailyRollingFileAppender在每一個日誌事件(LoggingEvent)附加(append)之前檢查是否需要附加。也就是說如果在一個滾動區間中沒有任何日誌記錄,那麼這個區間的日誌記錄檔案就不會形成。

在實際程式設計時,要使Log4j真正在系統中執行事先還要對配置檔案進行定義。定義步驟就是對Logger、Appender及Layout的分別使用。Log4j支援兩種配置檔案格式,一種是XML格式的檔案,一種是java properties(key=value)【Java特性檔案(鍵=值)】。(這裡只說明properties檔案)

1、配置根Logger

其語法為:
      log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
      level : 是日誌記錄的優先順序,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別,優先順序從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的級別,您可以控制到應用程式中相應級別的日誌資訊的開關。比如在這裡定 義了INFO級別,則應用程式中所有DEBUG級別的日誌資訊將不被列印出來。appenderName:就是指定日誌資訊輸出到哪個地方(這個appenderName其實就是你自己定義的appender的名稱)。您可以同時指定多個輸出目的地。
     例如:log4j.rootLogger=info,A1,B2,C3

2、配置日誌資訊輸出目的地

 其語法為:
      log4j.appender.appenderName = fully.qualified.name.of.appender.class  //
      "fully.qualified.name.of.appender.class" 可以指定下面五個目的地中的一個:

          1.org.apache.log4j.ConsoleAppender(控制檯)
          2.org.apache.log4j.FileAppender(檔案)
          3.org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌檔案)
          4.org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候產生一個新的檔案)
          5.org.apache.log4j.WriterAppender(將日誌資訊以流格式傳送到任意指定的地方)

             1.ConsoleAppender選項
                    Threshold=WARN:指定日誌訊息的輸出最低層次。
                    ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
                    Target=System.err:預設情況下是:System.out,指定輸出控制檯
              2.FileAppender 選項
                    Threshold=WARN:指定日誌訊息的輸出最低層次。
                    ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
                    File=mylog.txt:指定訊息輸出到mylog.txt檔案。
                    Append=false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
            3.DailyRollingFileAppender 選項
                    Threshold=WARN:指定日誌訊息的輸出最低層次。
                    ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
                    File=mylog.txt:指定訊息輸出到mylog.txt檔案。
                    Append=false:預設值是true,即以追加的方式將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
                    DatePattern=''.''yyyy-ww:每週滾動一次檔案,即每週產生一個新的檔案。當然也可以指定按月、周、天、時和分。即對應的格式如下:
                    1)''.''yyyy-MM: 每月
                    2)''.''yyyy-ww: 每週 
                    3)''.''yyyy-MM-dd: 每天
                    4)''.''yyyy-MM-dd-a: 每天兩次
                    5)''.''yyyy-MM-dd-HH: 每小時
                    6)''.''yyyy-MM-dd-HH-mm: 每分鐘
            4.RollingFileAppender 選項
                    Threshold=WARN:指定日誌訊息的輸出最低層次。
                    ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
                    File=mylog.txt:指定訊息輸出到mylog.txt檔案。
                    Append=false:預設值是true,即將訊息增加到指定檔案中,false指將訊息覆蓋指定的檔案內容。
                    MaxFileSize=100KB: 字尾可以是KB, MB 或者是 GB. 在日誌檔案到達該大小時,將會自動滾動,即將原來的內容移到mylog.log.1檔案。
                    MaxBackupIndex=2:指定可以產生的滾動檔案的最大數。

3、配置日誌資訊的格式

其語法為:
  1). log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
              "fully.qualified.name.of.layout.class" 可以指定下面4個格式中的一個:
           1.org.apache.log4j.HTMLLayout(以HTML表格形式佈局),
         2.org.apache.log4j.PatternLayout(可以靈活地指定佈局模式),
         3.org.apache.log4j.SimpleLayout(包含日誌資訊的級別和資訊字串),
         4.org.apache.log4j.TTCCLayout(包含日誌產生的時間、執行緒、類別等等資訊)
                   1.HTMLLayout 選項
                      LocationInfo=true:預設值是false,輸出java檔名稱和行號
                      Title=my app file: 預設值是 Log4J Log Messages.
                   2.PatternLayout 選項
                      ConversionPattern=%m%n :指定怎樣格式化指定的訊息。
                   3.XMLLayout  選項
                      LocationInfo=true:預設值是false,輸出java檔案和行號
        2). log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ss} %c %m%n
           這裡需要說明的就是日誌資訊格式中幾個符號所代表的含義:
           -X號: X資訊輸出時左對齊;
                   %p: 輸出日誌資訊優先順序,即DEBUG,INFO,WARN,ERROR,FATAL,
                   %d: 輸出日誌時間點的日期或時間,預設格式為ISO8601,也可以在其後指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類似:2002年10月18日 22:10:28,921
                   %r: 輸出自應用啟動到輸出該log資訊耗費的毫秒數
                   %c: 輸出日誌資訊所屬的類目,通常就是所在類的全名
                   %t: 輸出產生該日誌事件的執行緒名
                   %l: 輸出日誌事件的發生位置,相當於%C.%M(%F:%L)的組合,包括類目名、發生的執行緒,以及在程式碼中的行數。舉例:Testlog4.main(TestLog4.java:10)
                   %x: 輸出和當前執行緒相關聯的NDC(巢狀診斷環境),尤其用到像java servlets這樣的多客戶多執行緒的應用中。
                   %%: 輸出一個"%"字元
                   %F: 輸出日誌訊息產生時所在的檔名稱
                   %L: 輸出程式碼中的行號
                   %m: 輸出程式碼中指定的訊息,產生的日誌具體資訊
                   %n: 輸出一個回車換行符,Windows平臺為"
",Unix平臺為"
"輸出日誌資訊換行
            可以在%與模式字元之間加上修飾符來控制其最小寬度、最大寬度、和文字的對齊方式。如:
                     1)%20c:指定輸出category的名稱,最小的寬度是20,如果category的名稱小於20的話,預設的情況下右對齊。
                     2)%-20c:指定輸出category的名稱,最小的寬度是20,如果category的名稱小於20的話,"-"號指定左對齊。
                     3)%.30c:指定輸出category的名稱,最大的寬度是30,如果category的名稱大於30的話,就會將左邊多出的字元截掉,但小於30的話也不會有空格。
                     4)%20.30c:如果category的名稱小於20就補空格,並且右對齊,如果其名稱長於30字元,就從左邊交遠銷出的字元截掉。