基本介紹
- 中文名：java日誌
- 外文名：log4j
- 別名：log4j--log for java
- 版本： Apache License V2.0
定義,配置,第一步,第二步,第三步,第四步,說明,詳解,定義配置檔案,格式化日誌,運用在代碼中,結合,
定義
log4j--log for java(java的日誌)
在強調可重用組件開發的今天，除了自己從頭到尾開發一個可重用的日誌操作類外，Apache為我們提供了一個強有力的日誌操作包-Log4j。
此外，通過Log4j其他語言接口，您可以在C、C++、.Net、PL/SQL程式中使用Log4j，其語法和用法與在Java程式中一樣，使得多語言分散式系統得到一個統一一致的日誌組件模組。而且，通過使用各種第三方擴展，您可以很方便地將Log4j集成到J2EE、JINI甚至是SNMP套用中。
說明：下面分為三部分，
第一部分講解如何配置log4j；
第二部分為對log4j.properties配置檔案中的各個屬性的講解；
第三部分為對log4j的詳細講解。
如果只想配置上log4j，那么只需要看前兩個部分就可以，如果想對log4j深入了解，則還需看第三部分。
使用的license： Apache License V2.0。
配置
第一步
加入log4j-1.2.8.jar(可以選擇log4j的更高版本)到lib下。
如果使用maven項目，也可以選擇在pom.xml中新增依賴：
<!-- 加入log4j支持 -->
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
第二步
在CLASSPATH下建立log4j.properties。內容如下(數字為行號)：
log4j.rootCategory=INFO, stdout , Rlog4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.layout=org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern=[QC] %p [%t] %C.%M(%L) | %m%nlog4j.appender.R=org.apache.log4j.DailyRollingFileAppenderlog4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.loglog4j.appender.R.layout=org.apache.log4j.PatternLayoutlog4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%nlog4j.logger.com.neusoft=DEBUGlog4j.logger.com.opensymphony.oscache=ERRORlog4j.logger.net.sf.navigator=ERRORlog4j.logger.org.apache.commons=ERRORlog4j.logger.org.apache.struts=WARNlog4j.logger.org.displaytag=ERRORlog4j.logger.org.springframework=DEBUGlog4j.logger.com.ibatis.db=WARNlog4j.logger.org.apache.velocity=FATALlog4j.logger.com.canoo.webtest=WARNlog4j.logger.org.hibernate.ps.PreparedStatementCache=WARNlog4j.logger.org.hibernate=DEBUGlog4j.logger.org.logicalcobwebs=WARN
第三步
相應的修改其中屬性，修改之前就必須知道這些都是乾什麼的，在第二部分講解。
第四步
在要輸出日誌的類中加入相關語句：
定義屬性：static Logger logger = Logger.getLogger(LogDemo.class); //LogDemo為相關的類
在相應的方法中：
if (logger.isDebugEnabled()){
logger.debug(“System …..”);
}
說明
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。
2、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。
3、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。
4、log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n
如果使用pattern布局就要指定的列印信息的具體格式ConversionPattern，列印參數如下：
%m 輸出代碼中指定的訊息；
%M 輸出列印該條日誌的方法名；
%p 輸出優先權，即DEBUG，INFO，WARN，ERROR，FATAL；
%r 輸出自套用啟動到輸出該log信息耗費的毫秒數；
%c 輸出所屬的類目，通常就是所在類的全名；
%t 輸出產生該日誌事件的執行緒名；
%n 輸出一個回車換行符，Windows平台為"rn”，Unix平台為"n”；
%d 輸出日誌時間點的日期或時間，默認格式為ISO8601，也可以在其後指定格式，比如：%d{yyyy-MM-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'
具體講解可參照第三部分定義配置檔案中的格式化日誌信息。
5、log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
此句與第3行一樣。定義名為R的輸出端的類型為每天產生一個日誌檔案。
6、log4j.appender.R.File=D:\\Tomcat 5.5\\logs\\qc.log
此句為定義名為R的輸出端的檔案名稱為D:\\Tomcat 5.5\\logs\\qc.log可以自行修改。
7、log4j.appender.R.layout=org.apache.log4j.PatternLayout
與第4行相同。
8、log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n
與第5行相同。
9、log4j.logger.com. neusoft =DEBUG
指定com.neusoft包下的所有類的等級為DEBUG。
可以把com.neusoft改為自己項目所用的包名。
10、log4j.logger.com.opensymphony.oscache=ERROR
11、log4j.logger.net.sf.navigator=ERROR
這兩句是把這兩個包下出現的錯誤的等級設為ERROR，如果項目中沒有配置EHCache，則不需要這兩句。
12、log4j.logger.org.apache.commons=ERROR
13、log4j.logger.org.apache.struts=WARN
這兩句是struts的包。
14、log4j.logger.org.displaytag=ERROR
這句是displaytag的包。（QC問題列表頁面所用）
15、log4j.logger.org.springframework=DEBUG
此句為Spring的包。
16、log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
17、log4j.logger.org.hibernate=DEBUG
此兩句是hibernate的包。
以上這些包的設定可根據項目的實際情況而自行定製。
詳解
定義配置檔案
Log4j支持兩種配置檔案格式，一種是XML（標準通用標記語言下的一個套用）格式的檔案，一種是Java特性檔案log4j.properties（鍵=值）。下面將介紹使用log4j.properties檔案作為配置檔案的方法:
①、配置根Logger
Logger 負責處理日誌記錄的大部分操作。
其語法為：
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中，level 是日誌記錄的優先權，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別。Log4j建議只使用四個級別，優先權從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的級別，您可以控制到應用程式中相應級別的日誌信息的開關。比如在這裡定義了INFO級別，只有等於及高於這個級別的才進行處理，則應用程式中所有DEBUG級別的日誌信息將不被列印出來。ALL:列印所有的日誌，OFF：關閉所有的日誌輸出。 appenderName就是指定日誌信息輸出到哪個地方。可同時指定多個輸出目的地。
②、配置日誌信息輸出目的地 Appender
Appender 負責控制日誌記錄操作的輸出。
其語法為：
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為控制台。
③、配置日誌信息的格式（布局）Layout
Layout 負責格式化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（包含日誌產生的時間、執行緒、類別等等信息）
格式化日誌
Log4J採用類似C語言中的printf函式的列印格式格式化日誌信息，列印參數如下：
%m 輸出代碼中指定的訊息；
%M 輸出列印該條日誌的方法名；
%p 輸出優先權，即DEBUG，INFO，WARN，ERROR，FATAL；
%r 輸出自套用啟動到輸出該log信息耗費的毫秒數；
%c 輸出所屬的類目，通常就是所在類的全名；
%t 輸出產生該日誌事件的執行緒名；
%n 輸出一個回車換行符，Windows平台為"rn”，Unix平台為"n”；
%d 輸出日誌時間點的日期或時間，默認格式為ISO8601，也可以在其後指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，輸出類似：2002-10-18 22:10:28,921；
%l 輸出日誌事件的發生位置，及在代碼中的行數。
運用在代碼中
我們在需要輸出日誌信息的類中做如下的三個工作：
1、導入所有需的commons-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");
}
2.3 如何套用記錄器的層次
2.3.1 如何定義及獲取不同層次的記錄器
任何一個記錄器的使用都有兩個步驟：
1) 在配置檔案中定義相應的記錄器。
在配置檔案中定義記錄器的格式有兩種
? 定義根記錄器的格式為
log4j.rootLogger = [ level ], appendName1, appendName2, …appendNameN
? 定義一個非根記錄器的格式為
log4j.logger.loggerName1 = [ level ], appendName1,…appendNameN
……
log4j.logger.loggerNameM = [ level ], appendName1, …appendNameN
我們可以定義任意個非根記錄器。
2) 在代碼中調用Logger類的取得記錄器方法取得相應的記錄器對象。
要取得根記錄器對象可通過Logger.getRootLogger()函式，要取得非根記錄器可通過Logger.getLogger()函式。
理論知道就講到這裡，紙上得來終覺淺，下面，我們來小小演練一下。
例4-a：
package TestLog4j;import org.apache.log4j.Logger;import org.apache.log4j.PropertyConfigurator;import org.apache.log4j.Priority;import TestLog4j.TestLog4j2.TestLog4j2;public class TestLog4j{static Logger logger = Logger.getLogger(TestLog4j.class.getName()); //（2）public TestLog4j(){}public static void main(String[] args){//同時輸出到控制台和一個檔案的實例並實現了Logger的繼承PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");logger.debug("Start of the main() in TestLog4j");logger.info("Just testing a log message with priority set to INFO");logger.warn("Just testing a log message with priority set to WARN");logger.error("Just testing a log message with priority set to ERROR");logger.fatal("Just testing a log message with priority set to FATAL");logger.log(Priority.WARN, "Testing a log message use a alternate form");logger.debug(TestLog4j.class.getName());TestLog4j2 testLog4j2 = new TestLog4j2(); //（1）testLog4j2.testLog();}}在類TestLog4j中我們調用了另一個類TestLog4j2，下面看一下類TestLog4j2的代碼。例4-b：package TestLog4j.TestLog4j2;import org.apache.log4j.Logger;import org.apache.log4j.PropertyConfigurator;import org.apache.log4j.Priority;public class TestLog4j2{static Logger logger = Logger.getLogger(TestLog4j2.class.getName()); //（1）public TestLog4j2(){}public void testLog(){//同時輸出到控制台和一個檔案的實例PropertyConfigurator.configure("F:\\nepalon\\log4j2.properties");logger.debug("2Start of the main()");logger.info("2Just testing a log message with priority set to INFO");logger.warn("2Just testing a log message with priority set to WARN");logger.error("2Just testing a log message with priority set to ERROR");logger.fatal("2Just testing a log message with priority set to FATAL");logger.log(Priority.DEBUG, "Testing a log message use a alternate form");logger.debug("2End of the main()");}}最後我們來看一下配置檔案。
例4-c：
log4j2.properties檔案內容
#1區
#### Use two appenders, one to log to console, another to log to a file
log4j.rootLogger = debug, stdout,R
#2區
#Print only messages of priority WARN or higher for your category
log4j.logger.TestLog4j= , R
log4j.logger.TestLog4j.TestLog4j2=WARN
#3區
#### First appender writes to console
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
# Pattern to output the caller's file name and line number.
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n
#4區
#### Second appender writes to a file
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=F:\\nepalon\\classes\\TestLog4j\\example.log
# Control the maximum log file size
log4j.appender.R.MaxFileSize=100KB
# Archive log files (one backup file here)
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n
先看一下運行結果。
在控制台中的結果為：
DEBUG [main] (?:?) - Start of the main() in TestLog4j
INFO [main] (?:?) - Just testing a log message with priority set to INFO
WARN [main] (?:?) - Just testing a log message with priority set to WARN
ERROR [main] (?:?) - Just testing a log message with priority set to ERROR
FATAL [main] (?:?) - Just testing a log message with priority set to FATAL
WARN [main] (?:?) - Testing a log message use a alternate form
DEBUG [main] (?:?) - TestLog4j.TestLog4j
WARN [main] (?:?) - 2Just testing a log message with priority set to WARN
ERROR [main] (?:?) - 2Just testing a log message with priority set to ERROR
FATAL [main] (?:?) - 2Just testing a log message with priority set to FATAL
輸出檔案的結果為：
2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - Start of the main() in TestLog4j
2003-12-19 04:19:44:INFO main TestLog4j.TestLog4j - Just testing a log message with priority set to INFO
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Just testing a log message with priority set to WARN
2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j - Just testing a log message with priority set to ERROR
2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j - Just testing a log message with priority set to FATAL
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j - Testing a log message use a alternate form
2003-12-19 04:19:44:DEBUG main TestLog4j.TestLog4j - TestLog4j.TestLog4j
2003-12-19 04:19:44:WARN main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to WARN
2003-12-19 04:19:44:ERROR main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to ERROR
2003-12-19 04:19:44:FATAL main TestLog4j.TestLog4j2.TestLog4j2 - 2Just testing a log message with priority set to FATAL
首先，先來看一下配置檔案都有些什麼東西。
1) 在1區中定義了一個根記錄器。這個根記錄器具有DEBUG級別並有一個名稱為stdout的輸出端appender。
2) 2區中的內容是這一節的重點，也是套用到記錄器層次的地方，但其實也只有兩句，充分體現了log4j的簡單性。在這裡，我們定義了兩個名稱分別為TestLog4j和TestLog4j.TestLog4j2設計器。
? 在定義TestLog4j記錄器時沒有指定級別，所以它的級別繼承自它的父記錄器，即根記錄器，所以它的級別也為DEBUG。在定義TestLog4j記錄器時又定義了一個名稱為R的輸出端，所以它的輸出端有兩個，一個從根記錄器繼承而來的名為stdout的輸出端，另一個為在此定義的名為R的輸出端。在此需要注意的是，在定義記錄器時必須先定義記錄器的級別，然後才是記錄器的輸出端。如果只想定義輸出端而不定義級別，則雖然級別可以為空，但逗號分隔設定不能省略。如定義TestLog4j記錄器的做法。
? 在定義TestLog4j.TestLog4j2記錄器時又指定了它的級別，由於一個記錄器的級別只能有一個，所以新指定的級別將覆寫掉它的父記錄器的級別（這就象Java中的多態）。我們沒有定義TestLog4j.TestLog4j2記錄器的輸出端，所以它的輸出端將從它的父記錄器中繼承而來。它的父記錄器為TestLog4j記錄器，所以它和TestLog4j記錄器一樣具有兩個名稱分別為 stdout和R的輸出端。
3) 剩下的3區和4區分別設定了兩個輸出端的參數值。
接下來，回到我們的代碼，看一下是如何取得記錄器，在取記錄器時又發生了什麼。
1) 例4-a中的代碼（2）中，語句Logger.getLogger()中的參數TestLog4j.class.getName()的值為 TestLog4j. TestLog4j，所以此語句的結果是取得一個名為TestLog4j. TestLog4j的記錄器的對象。但在配置檔案中並沒有定義這樣的記錄器，所以最終將返回與所需的名稱TestLog4j. TestLog4j最接近的記錄器對象，即名為TestLog4j的記錄器的對象。
2) 例4-b中的代碼（1）的原理與例4-a中的代碼（2）相似，期望取得的是名為TestLog4j.TestLog4j2. TestLog4j2的記錄器對象，但最終返回的是TestLog4j.TestLog4j2記錄器的對象。
結合
到目前為止，這篇文章講的都是如何在application中套用log4j，而Java現在的套用主流是J2EE和J2ME。現在，我們來看一下要如何在 J2EE開發中套用log4j。其實在Web application中套用log4j也很簡單，與在application中套用log4j不同之處就是要在所有套用log4j的代碼之前對log4j進行初始化。所以，我們在web application中就要把log4j的初始化工作獨立出來，把它放在Servlet中。下面，我們看一個例子。
例5-a：
進行初始化的Servlet：
import org.apache.log4j.PropertyConfigurator;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* log4j.jar的初始化類，參考web.xml
*/
public class Log4jInit extends HttpServlet
{
public void init()
{
//通過web.xml來動態取得配置檔案
String prefix = getServletContext().getRealPath("/");
String file = getInitParameter("log4j-init-file");
// 如果沒有給出相應的配置檔案，則不進行初始化
if(file != null)
{
PropertyConfigurator.configure(prefix+file); //（1）
}
}
public void doGet(HttpServletRequest req, HttpServletResponse res)
{}
}
下面來看一下這個Servlet在web.xml中的定義。
例5-b：
<servlet>
<servlet-name>log4j-init</servlet-name>
<servlet-class>TestLog4j.Log4jInit</servlet-class>
<init-param>
<param-name>log4j-init-file</param-name>
<param-value>sort.properties</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
因為log4j的初始化要在所有的log4j調用之前完成，所以在web.xml檔案中，我們一定要把對應的Servlet定義的load-on-startup應設為1，以便在Web容器啟動時即裝入該Servlet。
完成了這兩個步驟這後，我們就可以象在application開發中一樣在web application任何地方套用log4j了。下面是在javabean中的套用的一個例子。
例5-c：
import org.apache.log4j.Logger;public class InfoForm{static Logger logger = Logger.getLogger(InfoForm.class);protected String title;protected String content;public InfoForm() {}public void setTitle(Object value){logger.debug("nepalon:title = " + title);title = value;}public String getTitle(){logger.debug("nepalon:title = " + title);return title;}public void setContent(String value){content = value;logger.debug("nepalon: content() = " + content);}public String getContent(){logger.debug("nepalon: content = \n" + content);return content;}}