黑馬程序員--Log4j日誌管理系統簡單使用說明

               ------- android培訓java培訓、期待與您交流! ----------  

  通常,我們都提供一個名爲 log4j.properties的文件,在第一次調用到Log4J時,Log4J會在類路徑(../web-inf/class/當然也可以放到其它任何目錄,只要該目錄被包含到類路徑中即可)中定位這個文件,並讀入這個文件完成的配置。這個配置文件告訴Log4J以什麼樣的格式、把什麼樣的信息、輸出到什麼地方。

  Log4j有三個主要的組件:Loggers(記錄器)Appenders(輸出源)Layouts(佈局),這裏可簡單理解爲日誌類別,日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個組件可以輕鬆的記錄信息的類型和級別,並可以在運行時控制日誌輸出的樣式和位置。下面對三個組件分別進行說明:

  

  1 Loggers

  Loggers組件在此係統中被分爲五個級別:DEBUGINFOWARNERRORFATAL。這五個級別是有順序的,DEBUG < INFO < WARN < ERROR < FATAL,分別用來指定這條日誌信息的重要程度,明白這一點很重要,這裏Log4j有一個規則:假設Loggers級別爲P,如果在Loggers中發生了一個級別QP高,則可以啓動,否則屏蔽掉。

假設你定義的級別是info,那麼errorwarn的日誌可以顯示而比他低的debug信息就不顯示了。

  

  Java程序舉例來說:

  

  //建立Logger的一個實例,命名爲“com.foo

   Logger logger =Logger.getLogger("com.foo"); //"com.foo"是實例進行命名,也可以任意

  //設置logger的級別。通常不在程序中設置logger的級別。一般在配置文件中設置。

  logger.setLevel(Level.INFO);

  Loggerbarlogger = Logger.getLogger("com.foo.Bar");

  //下面這個請求可用,因爲WARN >= INFO

  logger.warn("Lowfuel level.");

  //下面這個請求不可用,因爲DEBUG < INFO

  logger.debug("Startingsearch for nearest gas station.");

  //命名爲“com.foo.bar”的實例barlogger會繼承實例“com.foo”的級別。因此,下面這個請求可用,因爲INFO >= INFO

  barlogger.info("Locatednearest gas station.");

  //下面這個請求不可用,因爲DEBUG < INFO

  barlogger.debug("Exitinggas station search");

  這裏“是否可用”的意思是能否輸出Logger信息。

    在對Logger實例進行命名時,沒有限制,可以取任意自己感興趣的名字。一般情況下建議以類的所在位置來命名Logger實例,這是目前來講比較有效的Logger命名方式。這樣可以使得每個類建立自己的日誌信息,便於管理。比如:

  

  staticLogger logger = Logger.getLogger(ClientWithLog4j.class.getName());

  

  2Appenders

  禁用與使用日誌請求只是Log4j其中的一個小小的地方,Log4j日誌系統允許把日誌輸出到不同的地方,如控制檯(Console)、文件(Files)、根據天數或者文件大小產生新的文件、以流的形式發送到其它地方等等。

  

  其語法表示爲:

  

  org.apache.log4j.ConsoleAppender(控制檯)

  org.apache.log4j.FileAppender(文件)

  org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌文件)

   org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件)

  org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)

  

  配置時使用方式爲:

  log4j.appender.appenderName= fully.qualified.name.of.appender.class

  log4j.appender.appenderName.option1= value1

  …

   log4j.appender.appenderName.option = valueN

  這樣就爲日誌的輸出提供了相當大的便利。

  

  3Layouts

  有時用戶希望根據自己的喜好格式化自己的日誌輸出。Log4j可以在Appenders的後面附加Layouts來完成這個功能。Layouts提供了四種日誌輸出樣式,如根據HTML樣式、自由指定樣式、包含日誌級別與信息的樣式和包含日誌時間、線程、類別等信息的樣式等等。

  

  其語法表示爲:

  

  org.apache.log4j.HTMLLayout(以HTML表格形式佈局),

  org.apache.log4j.PatternLayout(可以靈活地指定佈局模式),

  org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串),

  org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息)

  

  配置時使用方式爲:

  

  log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class

  log4j.appender.appenderName.layout.option1= value1

  …

  log4j.appender.appenderName.layout.option= valueN

 

4 . Log4j的配置  

  

  以上是從原理方面說明Log4j的使用方法,在具體Java編程使用Log4j可以參照以下示例:

  

  1、建立Logger實例:

  語法表示:publicstatic Logger getLogger( String name)

  實際使用:staticLogger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;

  

  2、讀取配置文件:

  獲得了Logger的實例之後,接下來將配置Log4j使用環境:

  語法表示:

  BasicConfigurator.configure():自動快速地使用缺省Log4j環境。

  PropertyConfigurator.configure(StringconfigFilename):讀取使用Java的特性文件編寫的配置文件。

  DOMConfigurator.configure(Stringfilename):讀取XML形式的配置文件。

  實際使用:

    PropertyConfigurator.configure("ServerWithLog4j.properties");

  

  3、插入日誌信息

  完成了以上連個步驟以後,下面就可以按日誌的不同級別插入到你要記錄日誌的任何地方了。

  語法表示:

  Logger.debug(Objectmessage);//調試信息

  Logger.info(Objectmessage);//一般信息

  Logger.warn(Objectmessage);//警告信息

  Logger.error(Objectmessage);//錯誤信息

  Logger.fatal(Objectmessage);//致命錯誤信息

 

  實際使用:logger.info("ServerSocketbefore accept: " + server);

  

 5. 配置過程

 

 在實際編程時,要使Log4j真正在系統中運行事先還要對配置文件進行定義。定義步驟就是對LoggerAppenderLayout的分別使用。

   Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是java propertieskey=value)【Java特性文件(鍵=值)】。下面我們介紹使用Java特性文件做爲配置文件的方法

   具體如下:

  

  1、配置根Logger,其語法爲:

  log4j.rootLogger= [ level ] , appenderName1, appenderName2,

        level : 是日誌記錄的優先級,分爲OFFFATALERRORWARNINFODEBUGALL或者您定義的級別。Log4j建議只使用四個級別,優先級從高到低分別是ERRORWARNINFODEBUG。通過在這裏定義的級別,您可以控制到應用程序中相應級別的日誌信息的開關。比如在這裏定義了INFO級別,則應用程序中所有DEBUG級別的日誌信息將不被打印出來。

       appenderName:就是指定日誌信息輸出到哪個地方。您可以同時指定多個輸出目的地。

   例如:log4j.rootLoggerinfo,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:指定可以產生的滾動文件的最大數。

 

實際應用:

  log4j.appender.A1=org.apache.log4j.ConsoleAppender//這裏指定了日誌輸出的第一個位置A1是控制檯ConsoleAppender

  

  3、配置日誌信息的格式,其語法爲:

  A.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文件和行號

   實際應用:

     log4j.appender.A1.layout=org.apache.log4j.PatternLayout

 

      B . log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-ddHH:mm:ssS} %c %m%n

          這裏需要說明的就是日誌信息格式中幾個符號所代表的含義:

          X: X信息輸出時左對齊;

                   %p:輸出日誌信息優先級,即DEBUGINFOWARNERRORFATAL,

                   %d:輸出日誌時間點的日期或時間,默認格式爲ISO8601,也可以在其後指定格式,比如:%d{yyy MMM ddHH:mm:ss,SSS},輸出類似:20021018 221028921

                   %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組件說明的一個簡化;下面給出一個具體配置例子,在程序中可以參照執行:

  log4j.rootLogger=INFO,A1B2

  log4j.appender.A1=org.apache.log4j.ConsoleAppender

  log4j.appender.A1.layout=org.apache.log4j.PatternLayout

  log4j.appender.A1.layout.ConversionPattern=%-4r%-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

   根據上面的日誌格式,某一個程序的輸出結果如下:

  0  INFO 2003-06-13 13:23:46968 ClientWithLog4j Client socket:Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]

        16  DEBUG2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j,Fri Jun 13 13:23:46 CST 2003'

  16  DEBUG 2003-06-13 13:23:46984ClientWithLog4j GOOD

  16  DEBUG 2003-06-13 13:23:46984ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'

  16  DEBUG 2003-06-13 13:23:46984ClientWithLog4j HELP

  16  DEBUG 2003-06-13 13:23:46984ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'

  16  DEBUG 2003-06-13 13:23:46984ClientWithLog4j QUIT

 

     4. # 當輸出信息於回滾文件時

 

         log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   //指定以文件的方式輸出日誌

          log4j.appender.ROLLING_FILE.Threshold=ERROR

          log4j.appender.ROLLING_FILE.File=rolling.log  //文件位置,也可以用變量${java.home}rolling.log

          log4j.appender.ROLLING_FILE.Append=true

          log4j.appender.ROLLING_FILE.MaxFileSize=10KB  //文件最大尺寸

          log4j.appender.ROLLING_FILE.MaxBackupIndex=1  //備份數

          log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout

          log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c-%-4r [%t] %-5p %c %x - %m%n   

 

××××××××××××××××××××××××××××××××××××××××××××××××

 

6. Log4j比較全面的配置

 

 LOG4J的配置之簡單使它遍及於越來越多的應用中了:Log4J配置文件實現了輸出到控制檯、文件、回滾文件、發送日誌郵件、輸出到數據庫日誌表、自定義標籤等全套功能。擇其一二使用就夠用了,

 

 log4j.rootLogger=DEBUG,CONSOLE,A1,im

 log4j.addivity.org.apache=true

 

 # 應用於控制檯

 

 log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

 log4j.appender.Threshold=DEBUG

 log4j.appender.CONSOLE.Target=System.out

 log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

 log4j.appender.CONSOLE.layout.ConversionPattern=[framework]%d - %c -%-4r [%t] %-5p %c %x - %m%n

 #log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]n%c[CATEGORY]%n%m[MESSAGE]%n%n

 

 #應用於文件

 

 log4j.appender.FILE=org.apache.log4j.FileAppender

 log4j.appender.FILE.File=file.log

 log4j.appender.FILE.Append=false

 log4j.appender.FILE.layout=org.apache.log4j.PatternLayout

 log4j.appender.FILE.layout.ConversionPattern=[framework]%d - %c -%-4r [%t] %-5p %c %x - %m%n

 #Use this layout for LogFactor 5 analysis

 

 # 應用於文件回滾

 

 log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender

 log4j.appender.ROLLING_FILE.Threshold=ERROR

 log4j.appender.ROLLING_FILE.File=rolling.log  //文件位置,也可以用變量${java.home}rolling.log

 log4j.appender.ROLLING_FILE.Append=true       //true:添加  false:覆蓋

 log4j.appender.ROLLING_FILE.MaxFileSize=10KB   //文件最大尺寸

 log4j.appender.ROLLING_FILE.MaxBackupIndex=1  //備份數

 log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout

 log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework]%d - %c -%-4r [%t] %-5p %c %x - %m%n

 

 

 #應用於socket

 log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender

 log4j.appender.SOCKET.RemoteHost=localhost

 log4j.appender.SOCKET.Port=5001

 log4j.appender.SOCKET.LocationInfo=true

 #Set up for Log Facter 5

 log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout

 log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n

 

 

 #Log Factor 5 Appender

 log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender

 log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

 

 # 發送日誌給郵件

 

 log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender

 log4j.appender.MAIL.Threshold=FATAL

 log4j.appender.MAIL.BufferSize=10

 [email protected]

 log4j.appender.MAIL.SMTPHost=www.wusetu.com

 log4j.appender.MAIL.Subject=Log4J Message

 [email protected]

 log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout

 log4j.appender.MAIL.layout.ConversionPattern=[framework]%d - %c -%-4r [%t] %-5p %c %x - %m%n

 

 # 用於數據庫

 log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender

 log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test

 log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver

 log4j.appender.DATABASE.user=root

 log4j.appender.DATABASE.password=

 log4j.appender.DATABASE.sql=INSERT INTO LOG4J(Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')

 log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout

 log4j.appender.DATABASE.layout.ConversionPattern=[framework]%d - %c -%-4r [%t] %-5p %c %x - %m%n

 

 

 log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender

 log4j.appender.A1.File=SampleMessages.log4j

 log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'

 log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

 

 #自定義Appender

 

 log4j.appender.im =net.cybercorlin.util.logger.appender.IMAppender

 

 log4j.appender.im.host = mail.cybercorlin.net

 log4j.appender.im.username = username

 log4j.appender.im.password = password

 log4j.appender.im.recipient [email protected]

 

 log4j.appender.im.layout=org.apache.log4j.PatternLayout

 log4j.appender.im.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

 

 

 

本文來自CSDN博客,轉載請標明出處:http://blog.csdn.net/samlei/archive/2009/06/25/4296961.aspx

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章