log4j介紹以及使用教程

來源:互聯網
上載者:User

標籤:

一、介紹

  Log4j是Apache的一個開放原始碼項目,通過使用Log4j,我們可以控制日誌資訊輸送的目的地是控制台、檔案、GUI組件、甚至是套接 口服務 器、NT的事件記錄器、UNIX Syslog守護進程等;我們也可以控制每一條日誌的輸出格式;通過定義每一條日誌資訊的層級,我們能夠更加細緻地控制日誌的產生過程。 
  Log4j由三個重要的組件構成:日誌資訊的優先順序,日誌資訊的輸出目的地,日誌資訊的輸出格式。

  日誌資訊的優先順序從高到低有ERROR、 WARN、 INFO、DEBUG,分別用來指定這條日誌資訊的重要程度;

  日誌資訊的輸出目的地指定了日誌將列印到控制台還是檔案中;

  日誌的輸出格式則控制了日誌資訊的顯 示內容。

二、設定檔詳解

  首先聲明:log4j可以有兩種方式進行配置,一種基於log4j.properties(本文重點講解),另一種基於log4j.xml.(不作講解,有需要的自行研究)

  其實我們也可以完全不使用設定檔,而是在代碼中配置Log4j環境。但是,使用設定檔將使我們的應用程式更加靈活。

  下面我們介紹使用properties格式做為設定檔的方法:

    樣本: 
      log4j.rootLogger=INFO, D 
      log4j.appender.D=org.apache.log4j.ConsoleAppender 
      log4j.appender.D.layout=org.apache.log4j.PatternLayout 
      log4j.appender.D.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n 

    rootLogger:日誌的根

    appender:日誌的輸出方式

1. 配置根Logger,其文法為:
  log4j.rootLogger = [ level ] , appenderName, appenderName, … 
其中,level 是日誌記錄的優先順序,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的層級。Log4j建議只使用四個層級,優 先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的層級,您可以控制到應用程式中相應層級的日誌資訊的開關。比如在這裡定 義了INFO層級,則應用程式中所有DEBUG層級的日誌資訊將不被列印出來。 
appenderName就是指定日誌資訊輸出到哪個地方。您可以同時指定多個輸出目的地。 

2. 配置日誌資訊輸出目的地Appender,其文法為:
log4j.appender.appenderName = fully.qualified.name.of.appender.class 
log4j.appender.appenderName.option1 = value1 
… 
log4j.appender.appenderName.option = valueN 
其中,Log4j提供的appender有以下幾種: 
  org.apache.log4j.ConsoleAppender(控制台), 
  org.apache.log4j.FileAppender(檔案), 
  org.apache.log4j.DailyRollingFileAppender(每天產生一個記錄檔), 
  org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候產生一個新的檔案), 
  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. 配置日誌資訊的布局,其文法為:
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 
log4j.appender.appenderName.layout.option1 = value1 
… 
log4j.appender.appenderName.layout.option = valueN 
其中,Log4j提供的layout有以下幾種: 
org.apache.log4j.HTMLLayout(以HTML表格形式布局), 
org.apache.log4j.PatternLayout(可以靈活地指定配置模式), 
org.apache.log4j.SimpleLayout(包含日誌資訊的層級和資訊字串), 
org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等資訊) 
 

HTMLLayout選項

 LocationInfo=true:輸出java檔案名稱和行號,預設值是false。Title=My Logging: 預設值是Log4J Log Messages。PatternLayout選項 ConversionPattern=%m%n:設定以怎樣的格式顯示訊息。在設定檔中可以通過log4j.appender.A1.layout.ConversionPattern設定日誌輸出格式。 
 

各種格式化說明如下:

 %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平台為”\r\n”,Unix平台為”\n”輸出日誌資訊換行 
可以在%與模式字元之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊。如: 
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字元,就從左邊交遠銷出的字元截掉。 

log4j介紹以及使用教程

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.