Java log4j詳細教程_java

一：Log4j入門簡介學習

 Log4j是Apache的一個開放原始碼項目，通過使用Log4j，我們可以控制日誌資訊輸送的目的地是控制台、檔案、GUI組件、甚至是套介面伺服器、NT的事件記錄器、UNIX Syslog守護進程等；我們也可以控制每一條日誌的輸出格式；通過定義每一條日誌資訊的層級，我們能夠更加細緻地控制日誌的產生過程。最令人感興趣的就是，這些可以通過一個設定檔來靈活地進行配置，而不需要修改應用的代碼。

此外，通過Log4j其他語言介面，您可以在C、C++、.Net、PL/SQL程式中使用Log4j，其文法和用法與在Java程式中一樣，使得多語言分布式系統得到一個統一一致的日誌組件模組。而且，通過使用各種第三方擴充，您可以很方便地將Log4j整合到J2EE、JINI甚至是SNMP應用中。

二、入門執行個體

1.建立一個JAva工程，匯入包log4j-1.2.17.jar，整個工程最終目錄如下

2、src同級建立並設定log4j.properties

 ### 設定###
log4j.rootLogger = debug,stdout,D,E
### 輸出資訊到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
### 輸出DEBUG 層級以上的日誌到=E://logs/error.log ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = E://logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.PatternLayout
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n
### 輸出ERROR 層級以上的日誌到=E://logs/error.log ###
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File =E://logs/error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

3、設定日誌內容

package com.mucfc;import org.apache.log4j.Logger;/** *@author linbingwen *@2015年5月18日9:14:21 */public class Test { private static Logger logger = Logger.getLogger(Test.class);  /**  * @param args  */  public static void main(String[] args) {  // System.out.println("This is println message.");  // 記錄debug層級的資訊  logger.debug("This is debug message.");  // 記錄info層級的資訊  logger.info("This is info message.");  // 記錄error層級的資訊  logger.error("This is error message.");  } }

4、輸出結果

（1）首先是控制台的資訊

（2）再來看輸出的檔案

內容如下，發現已按照要求輸出到對應的文檔中去了。

三、Log4j基本使用方法

Log4j由三個重要的組件構成：日誌資訊的優先順序，日誌資訊的輸出目的地，日誌資訊的輸出格式。日誌資訊的優先順序從高到低有ERROR、WARN、 INFO、DEBUG，分別用來指定這條日誌資訊的重要程度；日誌資訊的輸出目的地指定了日誌將列印到控制台還是檔案中；而輸出格式則控制了日誌資訊的顯 示內容。

2.1、定義設定檔

其實您也可以完全不使用設定檔，而是在代碼中配置Log4j環境。但是，使用設定檔將使您的應用程式更加靈活。Log4j支援兩種設定檔格式，一種是XML格式的檔案，一種是Java特性檔案（鍵=值）。下面我們介紹使用Java特性檔案做為設定檔的方法：
1.配置根Logger，其文法為：

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

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（將日誌資訊以流格式發送到任意指定的地方）

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有以e幾種：

org.apache.log4j.HTMLLayout（以HTML表格形式布局）， 
org.apache.log4j.PatternLayout（可以靈活地指定配置模式）， 
org.apache.log4j.SimpleLayout（包含日誌資訊的層級和資訊字串）， 
org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等資訊）
Log4J採用類似C語言中的printf函數的列印格式格式化日誌資訊，列印參數如下： %m 輸出代碼中指定的訊息

%p 輸出優先順序，即DEBUG，INFO，WARN，ERROR，FATAL 
%r 輸出自應用啟動到輸出該log資訊耗費的毫秒數 
%c 輸出所屬的類目，通常就是所在類的全名 
%t 輸出產生該日誌事件的線程名 
%n 輸出一個斷行符號分行符號，Windows平台為“rn”，Unix平台為“n” 
%d 輸出日誌時間點的日期或時間，預設格式為ISO8601，也可以在其後指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921 
%l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)

2.2、在代碼中使用Log4j

1.得到記錄器

使用Log4j，第一步就是擷取日誌記錄器，這個記錄器將負責控制日誌資訊。其文法為：

public static Logger getLogger( String name)

通過指定的名字獲得記錄器，如果必要的話，則為這個名字建立一個新的記錄器。Name一般取本類的名字，比如：

static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )

2.讀取設定檔

當獲得了日誌記錄器之後，第二步將配置Log4j環境，其文法為：

BasicConfigurator.configure ()： 自動快速地使用預設Log4j環境。 
PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性檔案編寫的設定檔。 
DOMConfigurator.configure ( String filename ) ：讀取XML形式的設定檔。
3.插入記錄資訊（格式化日誌資訊）

當上兩個必要步驟執行完畢，您就可以輕鬆地使用不同優先順序別的日誌記錄語句插入到您想記錄日誌的任何地方，其文法如下：

Logger.debug ( Object message ) ; 
Logger.info ( Object message ) ; 
Logger.warn ( Object message ) ; 
Logger.error ( Object message ) ;

2.3、記錄層級

每個Logger都被了一個記錄層級（log level），用來控制日誌資訊的輸出。記錄層級從高到低分為：

A：off 最高等級，用於關閉所有日誌記錄。
B：fatal 指出每個嚴重的錯誤事件將會導致應用程式的退出。
C：error 指出雖然發生錯誤事件，但仍然不影響系統的繼續運行。
D：warm 表明會出現潛在的錯誤情形。
E：info 一般和在粗粒度層級上，強調應用程式的運行全程。
F：debug 一般用於細粒度層級上，對調試應用程式非常有協助。
G：all 最低等級，用於開啟所有日誌記錄。

上面這些層級是定義在org.apache.log4j.Level類中。Log4j只建議使用4個層級，優先順序從高到低分別是error,warn,info和debug。通過使用記錄層級，可以控制應用程式中相應層級日誌資訊的輸出。例如，如果使用b了info層級，則應用程式中所有低於info層級的日誌資訊(如debug)將不會被列印出來。

四、Web項目中使用Log4j執行個體

上面代碼描述了Log4j的簡單應用，其實使用Log4j也就是這樣簡單方便。當然除了上面的配置方法，還有其它，比如做一個J2EE應用，在J2EE應用使用Log4j，必須先在啟動服務時載入Log4j的設定檔進行初始化，可以在web.xml中進行。

1、web應用的log4j使用基本上都採用：建立一個servlet，這個servlet在init函數中為log4j執行配置。一般就是讀入設定檔。所以需要在web.xml中為這個servlet配置，同時設定load-on-startup為1。

2、這個servlet配置log4j就是讀出設定檔，然後調用configure函數。這裡有兩個問題：一、需要知道檔案在哪裡；二、需要正確的檔案類型

3、設定檔位置在web.xml中配置一個param即可，路徑一般是相對於web的root目錄

4、檔案類型一般有兩種，一個是Java的property檔案，另一種是xml檔案

設定檔的大致內容：log4j可以指定輸出的log層級的最低等級，以及log的輸出配置格式，每個log可以指定多個輸出方式

（1）建立Web工程，整個工程最後目錄如下

（2）web.xml配置如下：

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns="http://java.sun.com/xml/ns/javaee"  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"  id="WebApp_ID" version="3.0">  <display-name>LogLearning</display-name>  <servlet>  <servlet-name>Log4JTestServlet</servlet-name>  <servlet-class>com.mucfc.Log4JTestServlet</servlet-class>  </servlet>  <!--用來啟動 log4jConfigLocation的servlet -->  <servlet>  <servlet-name>Log4JInitServlet</servlet-name>  <servlet-class>com.mucfc.Log4JInitServlet</servlet-class>  <init-param>  <param-name>log4j-properties-location</param-name>  <param-value>/WEB-INF/classes/log4j.properties</param-value>  </init-param>  <load-on-startup>1</load-on-startup>  </servlet>  <servlet-mapping>  <servlet-name>Log4JTestServlet</servlet-name>  <url-pattern>/test</url-pattern>  </servlet-mapping> </web-app>

（3）設定檔log4j.properties

 ### set log levels ### 
log4j.rootLogger = debug,stdout,D,E 
log4j.appender.stdout = org.apache.log4j.ConsoleAppender 
log4j.appender.stdout.Target = System.out 
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout 
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n 
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender 
log4j.appender.D.File = F://logs/log.log 
log4j.appender.D.Append = true 
log4j.appender.D.Threshold = DEBUG  
log4j.appender.D.layout = org.apache.log4j.PatternLayout 
log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n 
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender 
log4j.appender.E.File =F://logs/error.log  
log4j.appender.E.Append = true 
log4j.appender.E.Threshold = ERROR  
log4j.appender.E.layout = org.apache.log4j.PatternLayout 
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

（4）web容器一來就初始化的servlet

Log4JInitServlet.javapackage com.mucfc; import java.io.File; import java.io.IOException; import javax.servlet.ServletConfig; import javax.servlet.ServletContext; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.log4j.BasicConfigurator; import org.apache.log4j.PropertyConfigurator; /**  * Servlet implementation class Log4JInitServlet  */ @WebServlet("/Log4JInitServlet") public class Log4JInitServlet extends HttpServlet {  private static final long serialVersionUID = 1L;  /**  * @see HttpServlet#HttpServlet()  */  public Log4JInitServlet() {  super();  // TODO Auto-generated constructor stub  }  /**  * @see Servlet#init(ServletConfig)  */  public void init(ServletConfig config) throws ServletException {  System.out.println("Log4JInitServlet 正在初始化 log4j日誌設定資訊");  String log4jLocation = config.getInitParameter("log4j-properties-location");  ServletContext sc = config.getServletContext();  if (log4jLocation == null) {  System.err.println("*** 沒有 log4j-properties-location 初始化的檔案, 所以使用 BasicConfigurator初始化");  BasicConfigurator.configure();  } else {  String webAppPath = sc.getRealPath("/");  String log4jProp = webAppPath + log4jLocation;  File yoMamaYesThisSaysYoMama = new File(log4jProp);  if (yoMamaYesThisSaysYoMama.exists()) {  System.out.println("使用: " + log4jProp+"初始化日誌設定資訊");  PropertyConfigurator.configure(log4jProp);  } else {  System.err.println("*** " + log4jProp + " 檔案沒有找到， 所以使用 BasicConfigurator初始化");  BasicConfigurator.configure();  }  }  super.init(config);  }  /**  * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)  */  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  // TODO Auto-generated method stub  }  /**  * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)  */  protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  // TODO Auto-generated method stub  } }

調用日誌Log4JTestServlet,java

package com.mucfc; import java.io.IOException; import javax.servlet.ServletConfig; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.log4j.Logger; /**  * Servlet implementation class Log4JTestServlet  */ @WebServlet("/Log4JTestServlet") public class Log4JTestServlet extends HttpServlet {  private static final long serialVersionUID = 1L;  private static Logger logger = Logger.getLogger(Log4JTestServlet.class);  /**  * @see HttpServlet#HttpServlet()  */  public Log4JTestServlet() {  super();  // TODO Auto-generated constructor stub  }  /**  * @see Servlet#init(ServletConfig)  */  public void init(ServletConfig config) throws ServletException {  // TODO Auto-generated method stub  }  /**  * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)  */  protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  // 記錄debug層級的資訊  logger.debug("This is debug message.");  // 記錄info層級的資訊  logger.info("This is info message.");  // 記錄error層級的資訊  logger.error("This is error message.");  }  /**  * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)  */  protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {  doGet(request,response);  } }

接下來就是運行了，來看看結果：

輸出結果：

五、Spring中使用Log4j

這裡要實現web項目中利用Spring來使用Log4j

（1）接上面的工程，然後再匯入Spring的包

（2）web.xml增加

<!-- 設定根目錄 -->  <context-param>  <param-name>webAppRootKey</param-name>  <param-value>webapp.root</param-value>  </context-param>  <context-param>  <param-name>log4jConfigLocation</param-name>  <param-value>/WEB-INF/classes/log4j.properties</param-value> </context-param> <!-- 3000表示 開一條watchdog線程每60秒掃描一下設定檔的變化;這樣便於日誌存放位置的改變 --> <context-param>  <param-name>log4jRefreshInterval</param-name>  <param-value>3000</param-value>  </context-param> <listener>  <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener>

整個內容如下：

<?xml version="1.0" encoding="UTF-8"?> <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns="http://java.sun.com/xml/ns/javaee"  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"  id="WebApp_ID" version="3.0">  <display-name>LogLearning</display-name>  <servlet>   <servlet-name>Log4JTestServlet</servlet-name>   <servlet-class>com.mucfc.Log4JTestServlet</servlet-class>  </servlet>  <!--用來啟動 log4jConfigLocation的servlet --> <!--  <servlet>   <servlet-name>Log4JInitServlet</servlet-name>   <servlet-class>com.mucfc.Log4JInitServlet</servlet-class>   <init-param>    <param-name>log4j-properties-location</param-name>    <param-value>/WEB-INF/classes/log4j.properties</param-value>   </init-param>   <load-on-startup>1</load-on-startup>  </servlet>-->  <servlet-mapping>   <servlet-name>Log4JTestServlet</servlet-name>   <url-pattern>/test</url-pattern>  </servlet-mapping>   <!-- Spring 容器載入 -->  <listener>   <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  </listener>  <context-param>   <param-name>contextConfigLocation</param-name>   <param-value>classpath:applicationContext.xml</param-value>  </context-param>  <!-- 設定根目錄 -->  <context-param>   <param-name>webAppRootKey</param-name>   <param-value>webapp.root</param-value>  </context-param>  <context-param>   <param-name>log4jConfigLocation</param-name>   <param-value>/WEB-INF/classes/log4j.properties</param-value>  </context-param>  <!-- 3000表示 開一條watchdog線程每60秒掃描一下設定檔的變化;這樣便於日誌存放位置的改變 -->  <context-param>    <param-name>log4jRefreshInterval</param-name>    <param-value>3000</param-value>  </context-param>  <listener>   <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>  </listener> </web-app>

這裡Log4JInitServlet.java就相當於沒用到了。

（2）applicationContext.xml

沒有內容：

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"  xmlns:aop="http://www.springframework.org/schema/aop"  xsi:schemaLocation=" http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-3.2.xsdhttp://www.springframework.org/schema/aophttp://www.springframework.org/schema/aop/spring-aop-3.2.xsdhttp://www.springframework.org/schema/context   http://www.springframework.org/schema/context/spring-context-3.2.xsd"> </beans>

（3）這樣日誌就跟隨Spring視窗啟動而啟動了

程式一運行，就會自動把日誌列印

log.log

error.log為空白，因為它只列印error層級以上的資訊

瀏覽器輸入http://localhost:8080/LogLearning2/test

然後開啟檔案

關於Java log4j詳細教程到此就全部結束了，下面文章將給大家介紹java web log4j 配置及在web項目中配置Log4j的技巧，感興趣的朋友繼續關注本站哦。