LOG4J

出自 华夏文化百科
前往： 導覽、 搜尋


簡介

在強調可重用組件開發的今天，除了自己從頭到尾開發一個可重用的日誌操作類外，Apache為我們提供了一個強有力的日誌操作包-Log4j。 Log4j是Apache的一個開放原始碼項目，通過使用Log4j，我們可以控制日誌信息輸送的目的地是控制台、文件、GUI組件、甚至是套接口伺服器、NT的事件記錄器、UNIX Syslog守護進程等；我們也可以控制每一條日誌的輸出格式；通過定義每一條日誌信息的級別，我們能夠更加細緻地控制日誌的生成過程。最令人感興趣的就是，這些可以通過一個配置文件來靈活地進行配置，而不需要修改應用的代碼。 此外，通過Log4j其他語言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其語法和用法與在Java程序中一樣，使得多語言分布式系統得到一個統一一致的日誌組件模塊。而且，通過使用各種第三方擴展，您可以很方便地將Log4j集成到J2EE、JINI甚至是SNMP應用中。說明：下面分為三部分，第一部分講解如何配置log4j，第二部分為對log4j.properties配置文件中的各個屬性的講解，第三部分為對log4j的詳細講解，如果只想配置上log4j，那麼只需要看前兩個部分就可以，如果想對log4j深入了解，則還需看第三部分。


一、Log4j配置

第一步：加入log4j-1.2.8.jar到lib下。第二步：在CLASSPATH下建立log4j.properties。內容如下：1 log4j.rootCategory=INFO, stdout , R2 3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout5 log4j.appender.stdout.layout.ConversionPattern=【QC】 %p 【%t】 %C.%M(%L) | %m%n6 7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender8 log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log9 log4j.appender.R.layout=org.apache.log4j.PatternLayout10 log4j.appender.R.layout.ConversionPattern=%d-【TS】 %p %t %c - %m%n11 12 log4j.logger.com.neusoft=DEBUG13 log4j.logger.com.opensymphony.oscache=ERROR14 log4j.logger.net.sf.navigator=ERROR15 log4j.logger.org.apache.commons=ERROR16 log4j.logger.org.apache.struts=WARN17 log4j.logger.org.displaytag=ERROR18 log4j.logger.org.springframework=DEBUG19 log4j.logger.com.ibatis.db=WARN20 log4j.logger.org.apache.velocity=FATAL21 22 log4j.logger.com.canoo.webtest=WARN23 24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN25 log4j.logger.org.hibernate=DEBUG26 log4j.logger.org.logicalcobwebs=WARN第三步：相應的修改其中屬性，修改之前就必須知道這些都是幹什麼的，在第二部分講解。第四步：在要輸出日誌的類中加入相關語句：定義屬性：protected final Log log = LogFactory.getLog(getClass());在相應的方法中：if (log.isDebugEnabled()){log.debug(「System …..」);}


二、Log4j說明

1 log4j.rootCategory=INFO, stdout , R此句為將等級為INFO的日誌信息輸出到stdout和R這兩個目的地，stdout和R的定義在下面的代碼，可以任意起名。等級可分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF則不打出任何信息，如果配置為INFO這樣只顯示INFO, WARN, ERROR的log信息，而DEBUG信息不會被顯示，具體講解可參照第三部分定義配置文件中的logger。3 log4j.appender.stdout=org.apache.log4j.ConsoleAppender此句為定義名為stdout的輸出端是哪種類型，可以是org.apache.log4j.ConsoleAppender（控制台）， org.apache.log4j.FileAppender（文件）， org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件），org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）具體講解可參照第三部分定義配置文件中的Appender。4 log4j.appender.stdout.layout=org.apache.log4j.PatternLayout此句為定義名為stdout的輸出端的layout是哪種類型，可以是org.apache.log4j.HTMLLayout（以HTML表格形式布局）， org.apache.log4j.PatternLayout（可以靈活地指定布局模式）， org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串）， org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）具體講解可參照第三部分定義配置文件中的Layout。5 log4j.appender.stdout.layout.ConversionPattern= 【QC】 %p 【%t】 %C.%M(%L) | %m%n如果使用pattern布局就要指定的列印信息的具體格式ConversionPattern，列印參數如下：%m 輸出代碼中指定的消息%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL %r 輸出自應用啟動到輸出該log信息耗費的毫秒數 %c 輸出所屬的類目，通常就是所在類的全名 %t 輸出產生該日誌事件的線程名 %n 輸出一個回車換行符，Windows平台為「rn」，Unix平台為「n」 %d 輸出日誌時間點的日期或時間，默認格式為ISO8601，也可以在其後指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921 %l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。【QC】是log信息的開頭，可以為任意字符，一般為項目簡稱。輸出的信息【TS】 DEBUG 【main】 AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean 'MyAutoProxy'具體講解可參照第三部分定義配置文件中的格式化日誌信息。7 log4j.appender.R=org.apache.log4j.DailyRollingFileAppender此句與第3行一樣。定義名為R的輸出端的類型為每天產生一個日誌文件。8 log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log此句為定義名為R的輸出端的文件名為D:\Tomcat 5.5\logs\qc.log可以自行修改。9 log4j.appender.R.layout=org.apache.log4j.PatternLayout與第4行相同。10 log4j.appender.R.layout.ConversionPattern=%d-【TS】 %p %t %c - %m%n與第5行相同。12 log4j.logger.com. neusoft =DEBUG指定com.neusoft包下的所有類的等級為DEBUG。可以把com.neusoft改為自己項目所用的包名。13 log4j.logger.com.opensymphony.oscache=ERROR14 log4j.logger.net.sf.navigator=ERROR這兩句是把這兩個包下出現的錯誤的等級設為ERROR，如果項目中沒有配置EHCache，則不需要這兩句。15 log4j.logger.org.apache.commons=ERROR16 log4j.logger.org.apache.struts=WARN這兩句是struts的包。17 log4j.logger.org.displaytag=ERROR這句是displaytag的包。（QC問題列表頁面所用）18 log4j.logger.org.springframework=DEBUG此句為Spring的包。24 log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN25 log4j.logger.org.hibernate=DEBUG此兩句是hibernate的包。以上這些包的設置可根據項目的實際情況而自行定製。


三、log4j詳解

1、定義配置文件Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件log4j.properties（鍵=值）。下面將介紹使用log4j.properties文件作為配置文件的方法:①、配置根LoggerLogger 負責處理日誌記錄的大部分操作。 其語法為：log4j.rootLogger = 【 level 】 , appenderName, appenderName, …其中，level 是日誌記錄的優先級，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的級別，您可以控制到應用程式中相應級別的日誌信息的開關。比如在這裡定義了INFO級別，只有等於及高於這個級別的才進行處理，則應用程式中所有DEBUG級別的日誌信息將不被列印出來。ALL:列印所有的日誌，OFF：關閉所有的日誌輸出。 appenderName就是指定日誌信息輸出到哪個地方。可同時指定多個輸出目的地。②、配置日誌信息輸出目的地 AppenderAppender 負責控制日誌記錄操作的輸出。 其語法為：log4j.appender.appenderName = fully.qualified.name.of.appender.class log4j.appender.appenderName.option1 = value1 … log4j.appender.appenderName.optionN = valueN 這裡的appenderName為在①里定義的，可任意起名。其中，Log4j提供的appender有以下幾種： org.apache.log4j.ConsoleAppender（控制台）， org.apache.log4j.FileAppender（文件）， org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件），org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），可通過log4j.appender.R.MaxFileSize=100KB設置文件大小，還可通過log4j.appender.R.MaxBackupIndex=1設置為保存一個備份文件。 org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）例如：log4j.appender.stdout=org.apache.log4j.ConsoleAppender定義一個名為stdout的輸出目的地，ConsoleAppender為控制台。③、配置日誌信息的格式（布局）LayoutLayout 負責格式化Appender的輸出。其語法為：log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class log4j.appender.appenderName.layout.option1 = value1 … log4j.appender.appenderName.layout.optionN = valueN 其中，Log4j提供的layout有以下幾種： org.apache.log4j.HTMLLayout（以HTML表格形式布局）， org.apache.log4j.PatternLayout（可以靈活地指定布局模式）， org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串）， org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）2、格式化日誌信息Log4J採用類似C語言中的printf函數的列印格式格式化日誌信息，列印參數如下： %m 輸出代碼中指定的消息%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL %r 輸出自應用啟動到輸出該log信息耗費的毫秒數 %c 輸出所屬的類目，通常就是所在類的全名 %t 輸出產生該日誌事件的線程名 %n 輸出一個回車換行符，Windows平台為「rn」，Unix平台為「n」 %d 輸出日誌時間點的日期或時間，默認格式為ISO8601，也可以在其後指定格式，比如：%d{yyyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921 %l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。3、在代碼中使用Log4j我們在需要輸出日誌信息的類中做如下的三個工作：1、導入所有需的commongs-logging類：import org.apache.commons.logging.Log;import org.apache.commons.logging.LogFactory;2、在自己的類中定義一個org.apache.commons.logging.Log類的私有靜態類成員：private final Log log = LogFactory.getLog(getClass());LogFactory.getLog()方法的參數使用的是當前類的class。3、使用org.apache.commons.logging.Log類的成員方法輸出日誌信息：if (log.isDebugEnabled()){log.debug("111");}if (log.isInfoEnabled()){log.info("222");}if (log.isWarnEnabled()){log.warn("333");}if (log.isErrorEnabled()){log.error("444");}if (log.isFatalEnabled()){log.fatal("555")}

取自 "https://wiki.chinulture.com/index.php?title=LOG4J&oldid=263612"