Java log4j詳細教程

2019-11-26 14:52:29

字體：大中小

來源：轉載

供稿：網友

一：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窗口啟動而啟動了

程序一運行，就會自動把日志打印