Log4j詳解

2019-11-14 11:03:25
字體：大中小
供稿：網(wǎng)友
最詳細(xì)的Log4j使用教程

一、入門實(shí)例

1.新建一個(gè)java工程，導(dǎo)入包log4j-1.2.17.jar，整個(gè)工程最終目錄如下
2、src同級(jí)創(chuàng)建并設(shè)置log4j.PRoperties
 ### 設(shè)置###log4j.rootLogger = debug,stdout,D,E### 輸出信息到控制抬 ###log4j.appender.stdout = org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.Target = System.outlog4j.appender.stdout.layout = org.apache.log4j.PatternLayoutlog4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n### 輸出DEBUG 級(jí)別以上的日志到=E://logs/error.log ###log4j.appender.D = org.apache.log4j.DailyRollingFileAppenderlog4j.appender.D.File = E://logs/log.loglog4j.appender.D.Append = truelog4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.PatternLayoutlog4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n### 輸出ERROR 級(jí)別以上的日志到=E://logs/error.log ###log4j.appender.E = org.apache.log4j.DailyRollingFileAppenderlog4j.appender.E.File =E://logs/error.log log4j.appender.E.Append = truelog4j.appender.E.Threshold = ERROR log4j.appender.E.layout = org.apache.log4j.PatternLayoutlog4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n3、設(shè)置日志內(nèi)容
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級(jí)別的信息          logger.debug("This is debug message.");          // 記錄info級(jí)別的信息          logger.info("This is info message.");          // 記錄error級(jí)別的信息          logger.error("This is error message.");      }  }4、輸出結(jié)果
（1）首先是控制臺(tái)的信息
（2）再來看輸出的文件
內(nèi)容如下，發(fā)現(xiàn)已按照要求輸出到對應(yīng)的文檔中去了。
二、Log4j基本使用方法
Log4j由三個(gè)重要的組件構(gòu)成：日志信息的優(yōu)先級(jí)，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優(yōu)先級(jí)從高到低有ERROR、WARN、 INFO、DEBUG，分別用來指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺(tái)還是文件中；而輸出格式則控制了日志信息的顯 示內(nèi)容。
2.1、定義配置文件
其實(shí)您也可以完全不使用配置文件，而是在代碼中配置Log4j環(huán)境。但是，使用配置文件將使您的應(yīng)用程序更加靈活。Log4j支持兩種配置文件格式，一種是xml格式的文件，一種是Java特性文件（鍵=值）。下面我們介紹使用Java特性文件做為配置文件的方法：1.配置根Logger，其語法為：
log4j.rootLogger = [ level ] , appenderName, appenderName, …其中，level 是日志記錄的優(yōu)先級(jí)，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級(jí)別。Log4j建議只使用四個(gè)級(jí)別，優(yōu) 先級(jí)從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級(jí)別，您可以控制到應(yīng)用程序中相應(yīng)級(jí)別的日志信息的開關(guān)。比如在這里定 義了INFO級(jí)別，則應(yīng)用程序中所有DEBUG級(jí)別的日志信息將不被打印出來。 appenderName就是指B日志信息輸出到哪個(gè)地方。您可以同時(shí)指定多個(gè)輸出目的地。
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（控制臺(tái)），  org.apache.log4j.FileAppender（文件），  org.apache.log4j.DailyRollingFileAppender（每天產(chǎn)生一個(gè)日志文件），  org.apache.log4j.RollingFileAppender（文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件），  org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方）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（包含日志信息的級(jí)別和信息字符串），  org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線程、類別等等信息）Log4J采用類似C語言中的printf函數(shù)的打印格式格式化日志信息，打印參數(shù)如下： %m 輸出代碼中指定的消息
%p 輸出優(yōu)先級(jí)，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL  %r 輸出自應(yīng)用啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)  %c 輸出所屬的類目，通常就是所在類的全名  %t 輸出產(chǎn)生該日志事件的線程名  %n 輸出一個(gè)回車換行符，Windows平臺(tái)為“rn”，Unix平臺(tái)為“n”  %d 輸出日志時(shí)間點(diǎn)的日期或時(shí)間，默認(rèn)格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921  %l 輸出日志事件的發(fā)生位置，包括類目名、發(fā)生的線程，以及在代碼中的行數(shù)。舉例：Testlog4.main(TestLog4.java:10)2.2、在代碼中使用Log4j
1.得到記錄器
使用Log4j，第一步就是獲取日志記錄器，這個(gè)記錄器將負(fù)責(zé)控制日志信息。其語法為：
public static Logger getLogger( String name)
通過指定的名字獲得記錄器，如果必要的話，則為這個(gè)名字創(chuàng)建一個(gè)新的記錄器。Name一般取本類的名字，比如：
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
2.讀取配置文件
當(dāng)獲得了日志記錄器之后，第二步將配置Log4j環(huán)境，其語法為：
BasicConfigurator.configure ()： 自動(dòng)快速地使用缺省Log4j環(huán)境。  PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫的配置文件。  DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。3.插入記錄信息（格式化日志信息）
當(dāng)上兩個(gè)必要步驟執(zhí)行完畢，您就可以輕松地使用不同優(yōu)先級(jí)別的日志記錄語句插入到您想記錄日志的任何地方，其語法如下：
Logger.debug ( Object message ) ;  Logger.info ( Object message ) ;  Logger.warn ( Object message ) ;  Logger.error ( Object message ) ;2.3、日志級(jí)別
每個(gè)Logger都被了一個(gè)日志級(jí)別（log level），用來控制日志信息的輸出。日志級(jí)別從高到低分為：A：off 最高等級(jí)，用于關(guān)閉所有日志記錄。B：fatal 指出每個(gè)嚴(yán)重的錯(cuò)誤事件將會(huì)導(dǎo)致應(yīng)用程序的退出。C：error 指出雖然發(fā)生錯(cuò)誤事件，但仍然不影響系統(tǒng)的繼續(xù)運(yùn)行。D：warm 表明會(huì)出現(xiàn)潛在的錯(cuò)誤情形。E：info 一般和在粗粒度級(jí)別上，強(qiáng)調(diào)應(yīng)用程序的運(yùn)行全程。F：debug 一般用于細(xì)粒度級(jí)別上，對調(diào)試應(yīng)用程序非常有幫助。G：all 最低等級(jí)，用于打開所有日志記錄。
上面這些級(jí)別是定義在org.apache.log4j.Level類中。Log4j只建議使用4個(gè)級(jí)別，優(yōu)先級(jí)從高到低分別是error,warn,info和debug。通過使用日志級(jí)別，可以控制應(yīng)用程序中相應(yīng)級(jí)別日志信息的輸出。例如，如果使用b了info級(jí)別，則應(yīng)用程序中所有低于info級(jí)別的日志信息(如debug)將不會(huì)被打印出來。
三、Web項(xiàng)目中使用Log4j實(shí)例
上面代碼描述了Log4j的簡單應(yīng)用，其實(shí)使用Log4j也就是這樣簡單方便。當(dāng)然除了上面的配置方法，還有其它，比如做一個(gè)J2EE應(yīng)用，在J2EE應(yīng)用使用Log4j，必須先在啟動(dòng)服務(wù)時(shí)加載Log4j的配置文件進(jìn)行初始化，可以在web.xml中進(jìn)行。
1、web應(yīng)用的log4j使用基本上都采用：新建一個(gè)servlet，這個(gè)servlet在init函數(shù)中為log4j執(zhí)行配置。一般就是讀入配置文件。所以需要在web.xml中為這個(gè)servlet配置，同時(shí)設(shè)定load-on-startup為1。
2、這個(gè)servlet配置log4j就是讀出配置文件，然后調(diào)用configure函數(shù)。這里有兩個(gè)問題：一、需要知道文件在哪里；二、需要正確的文件類型
3、配置文件位置在web.xml中配置一個(gè)param即可，路徑一般是相對于web的root目錄
4、文件類型一般有兩種，一個(gè)是Java的property文件，另一種是xml文件
配置文件的大致內(nèi)容：log4j可以指定輸出的log級(jí)別的最低等級(jí)，以及l(fā)og的輸出配置格式，每個(gè)log可以指定多個(gè)輸出方式
（1）創(chuàng)建Web工程，整個(gè)工程最后目錄如下
（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>      <!--用來啟動(dòng) 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日志設(shè)置信息");          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+"初始化日志設(shè)置信息");                  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      }  }調(diào)用日志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級(jí)別的信息            logger.debug("This is debug message.");            // 記錄info級(jí)別的信息            logger.info("This is info message.");            // 記錄error級(jí)別的信息            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);      }  }接下來就是運(yùn)行了，來看看結(jié)果：
輸出結(jié)果：
四、Spring中使用Log4j
這里要實(shí)現(xiàn)web項(xiàng)目中利用Spring來使用Log4j
（1）接上面的工程，然后再導(dǎo)入Spring的包
（2）web.xml增加
<!-- 設(shè)置根目錄 -->     <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>整個(gè)內(nèi)容如下：
<?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>      <!--用來啟動(dòng) 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>       <!-- 設(shè)置根目錄 -->      <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>這里L(fēng)og4JInitServlet.java就相當(dāng)于沒用到了。
（2）applicationContext.xml
沒有內(nèi)容：
<?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窗口啟動(dòng)而啟動(dòng)了
程序一運(yùn)行，就會(huì)自動(dòng)把日志打印
log.log
error.log為空，因?yàn)樗淮蛴rror級(jí)別以上的信息
瀏覽器輸入http://localhost:8080/LogLearning2/test
然后打開文件