log4j最全教程

(轉自http://www.codeceo.com/article/log4j-usage.html)

日誌是應用軟件中不可缺乏的部分，Apache的開源項目log4j是一個功能強大的日誌組件,提供方便的日誌記錄。在apache網站：jakarta.apache.org/log4j 能夠免費下載到Log4j最新版本的軟件包。

1、入門實例

1.新建一個JAva工程，導入包log4j-1.2.17.jar，整個工程最終目錄以下

二、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

三、設置日誌內容

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."); } }

四、輸出結果

（1）首先是控制檯的信息

（2）再來看輸出的文件

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

2、Log4j基本使用方法

Log4j由三個重要的組件構成：日誌信息的優先級，日誌信息的輸出目的地，日誌信息的輸出格式。日誌信息的優先級從高到低有ERROR、WARN、 INFO、DEBUG，分別用來指定這條日誌信息的重要程度；日誌信息的輸出目的地指定了日誌將打印到控制檯仍是文件中；而輸出格式則控制了日誌信息的顯 示內容。

2.一、定義配置文件

其實您也能夠徹底不使用配置文件，而是在代碼中配置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.二、在代碼中使用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.三、日誌級別

每一個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)將不會被打印出來。

3、Web項目中使用Log4j實例

上面代碼描述了Log4j的簡單應用，其實使用Log4j也就是這樣簡單方便。固然除了上面的配置方法，還有其它，好比作一個J2EE應用，在J2EE應用使用Log4j，必須先在啓動服務時加載Log4j的配置文件進行初始化，能夠在web.xml中進行。

一、web應用的log4j使用基本上都採用：新建一個servlet，這個servlet在init函數中爲log4j執行配置。通常就是讀入配置文件。因此須要在web.xml中爲這個servlet配置，同時設定load-on-startup爲1。

二、這個servlet配置log4j就是讀出配置文件，而後調用configure函數。這裏有兩個問題：1、須要知道文件在哪裏；2、須要正確的文件類型

三、配置文件位置在web.xml中配置一個param便可，路徑通常是相對於web的root目錄

四、文件類型通常有兩種，一個是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.java

package 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); } }

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

輸出結果：

4、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/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.2.xsd http://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

而後打開文件