Log4j的使用

阿宇來了發表於2020-12-23

Log4j的使用

林炳文Evankaka原創作品。轉載出處http://blog.csdn.net/evankaka

日誌是應用軟體中不可缺少的部分，Apache的開源專案Log4j是一個功能強大的日誌元件,提供方便的日誌記錄。在apache網站：jakarta.apache.org/log4j 可以免費下載到Log4j最新版本的軟體包。
一、入門例項

本例子工程下載

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、設定日誌內容

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.java

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

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/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

然後開啟檔案

林炳文Evankaka原創作品。轉載http://blog.csdn.net/evankaka

log4j的基本使用和引數設定
2018-03-22
使用log4j將資料流入flume
2020-08-23
springboot log4j的坑
2018-08-14
Spring Boot
使用汙點分析檢查log4j問題
2022-02-15
在myeclipse中使用log4j記錄日誌
2019-04-08
Eclipse
升級過log4j，卻還沒搞懂log4j漏洞的本質？
2021-12-21
[JavaWeb]Log4j的前因後果
2022-02-01
JavaWeb
java log4j 的一個bug
2020-10-31
Java
Spring配置log4j
2018-04-09
Spring
Spring整合log4j
2018-07-27
Spring
使用log4j列印異常堆疊到日誌檔案
2020-11-15
exclude Log4j print Log
2024-06-06
幽默圖：log4j漏洞事件的幽默模因
2021-12-24
事件
elasticsearch 的 log4j漏洞怎麼解決啊？
2021-12-13
Elasticsearch
DevOps經歷的 Log4j痛苦經歷 - Reddit
2022-03-22
dev
自定義log4j的appender寫es日誌
2019-05-18
APP
高併發下log4j的效能瓶頸
2019-01-22
Log4j漏洞原始碼分析
2021-12-14
原始碼
log4j properties 完整版
2018-11-11
log4j簡單配置解釋
2018-05-06
為什麼阿里巴巴禁止工程師直接使用日誌系統(Log4j、Logback)中的API
2018-11-26
阿里工程師API
為什麼阿里巴巴禁止工程師直接使用日誌系統(Log4j、Logback)中的 API
2018-12-26
阿里工程師API
您的Linux伺服器是否容易受到Log4j的攻擊？
2022-05-27
Linux伺服器
commons-logging + log4j原始碼分析
2019-08-07
原始碼
配置LOG4J（log4j-1.2.17）
2020-04-05
2.No appenders could be found for logger(log4j)
2018-12-29
APP
log4j日誌級別以及配置
2018-05-07
Confluence 6 log4j 日誌級別
2018-07-31
Java - 自動配置log4j的日誌檔案路徑
2019-08-06
Java
使用亞馬遜雲科技安全服務防禦、檢測和響應 Log4j 漏洞
2022-01-20
亞馬遜
log4j遠端程式碼執行漏洞
2024-06-08
Mybatis、maven專案中整合log4j （17）
2021-10-19
MyBatisMaven
Elasticsearch 史詩級 log4j 漏洞解決
2021-12-11
Elasticsearch
log4j日誌輸出級別(轉)
2022-01-04
發現第一個 Log4J 蠕蟲
2021-12-20
log4j MDC實現日誌追蹤
2018-04-08
estk/log4rs: 類似log4j的Rust日誌框架
2022-11-21
Rust框架
排查log4j不輸出日誌到檔案的問題
2022-02-18

Log4j的使用

Log4j的使用

set log levels

相關文章