Log4j詳細使用教程_動力節(jié)點Java學(xué)院整理
日志是應(yīng)用軟件中不可缺少的部分，Apache的開源項目Log4j是一個功能強大的日志組件,提供方便的日志記錄。在apache網(wǎng)站：jakarta.apache.org/log4j 可以免費下載到Log4j最新版本的軟件包。
一、入門實例
1.新建一個JAva工程，導(dǎo)入包log4j-1.2.17.jar，整個工程最終目錄如下
2、src同級創(chuàng)建并設(shè)置log4j.properties
### 設(shè)置###
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、設(shè)置日志內(nèi)容
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、輸出結(jié)果
（1）首先是控制臺的信息
（2）再來看輸出的文件
內(nèi)容如下，發(fā)現(xiàn)已按照要求輸出到對應(yīng)的文檔中去了。
二、Log4j基本使用方法
Log4j由三個重要的組件構(gòu)成：日志信息的優(yōu)先級，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優(yōu)先級從高到低有ERROR、WARN、 INFO、DEBUG，分別用來指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺還是文件中；而輸出格式則控制了日志信息的顯 示內(nèi)容。
2.1、定義配置文件
其實您也可以完全不使用配置文件，而是在代碼中配置Log4j環(huán)境。但是，使用配置文件將使您的應(yīng)用程序更加靈活。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。下面我們介紹使用Java特性文件做為配置文件的方法：
1.配置根Logger，其語法為：
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中，level 是日志記錄的優(yōu)先級，分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優(yōu) 先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級別，您可以控制到應(yīng)用程序中相應(yīng)級別的日志信息的開關(guān)。比如在這里定 義了INFO級別，則應(yīng)用程序中所有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（每天產(chǎn)生一個日志文件）， org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產(chǎn)生一個新的文件）， 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（包含日志信息的級別和信息字符串）， org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時間、線程、類別等等信息）
Log4J采用類似C語言中的printf函數(shù)的打印格式格式化日志信息，打印參數(shù)如下： %m 輸出代碼中指定的消息
%p 輸出優(yōu)先級，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL
%r 輸出自應(yīng)用啟動到輸出該log信息耗費的毫秒數(shù)
%c 輸出所屬的類目，通常就是所在類的全名
%t 輸出產(chǎn)生該日志事件的線程名
%n 輸出一個回車換行符，Windows平臺為“rn”，Unix平臺為“n”
%d 輸出日志時間點的日期或時間，默認格式為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，第一步就是獲取日志記錄器，這個記錄器將負責(zé)控制日志信息。其語法為：
public static Logger getLogger( String name)
通過指定的名字獲得記錄器，如果必要的話，則為這個名字創(chuàng)建一個新的記錄器。Name一般取本類的名字，比如：
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
2.讀取配置文件
當(dāng)獲得了日志記錄器之后，第二步將配置Log4j環(huán)境，其語法為：
BasicConfigurator.configure ()： 自動快速地使用缺省Log4j環(huán)境。
PropertyConfigurator.configure ( String configFilename) ：讀取使用Java的特性文件編寫的配置文件。
DOMConfigurator.configure ( String filename ) ：讀取XML形式的配置文件。
3.插入記錄信息（格式化日志信息）
當(dāng)上兩個必要步驟執(zhí)行完畢，您就可以輕松地使用不同優(yōu)先級別的日志記錄語句插入到您想記錄日志的任何地方，其語法如下：
Logger.debug ( Object message ) ; Logger.info ( Object message ) ; Logger.warn ( Object message ) ; Logger.error ( Object message ) ;
2.3、日志級別
每個Logger都被了一個日志級別（log level），用來控制日志信息的輸出。日志級別從高到低分為：
A：off 最高等級，用于關(guān)閉所有日志記錄。
B：fatal 指出每個嚴(yán)重的錯誤事件將會導(dǎo)致應(yīng)用程序的退出。
C：error 指出雖然發(fā)生錯誤事件，但仍然不影響系統(tǒng)的繼續(xù)運行。
D：warm 表明會出現(xiàn)潛在的錯誤情形。
E：info 一般和在粗粒度級別上，強調(diào)應(yīng)用程序的運行全程。
F：debug 一般用于細粒度級別上，對調(diào)試應(yīng)用程序非常有幫助。
G：all 最低等級，用于打開所有日志記錄。
上面這些級別是定義在org.apache.log4j.Level類中。Log4j只建議使用4個級別，優(yōu)先級從高到低分別是error,warn,info和debug。通過使用日志級別，可以控制應(yīng)用程序中相應(yīng)級別日志信息的輸出。例如，如果使用b了info級別，則應(yīng)用程序中所有低于info級別的日志信息(如debug)將不會被打印出來。
三、Web項目中使用Log4j實例
上面代碼描述了Log4j的簡單應(yīng)用，其實使用Log4j也就是這樣簡單方便。當(dāng)然除了上面的配置方法，還有其它，比如做一個J2EE應(yīng)用，在J2EE應(yīng)用使用Log4j，必須先在啟動服務(wù)時加載Log4j的配置文件進行初始化，可以在web.xml中進行。
1、web應(yīng)用的log4j使用基本上都采用：新建一個servlet，這個servlet在init函數(shù)中為log4j執(zhí)行配置。一般就是讀入配置文件。所以需要在web.xml中為這個servlet配置，同時設(shè)定load-on-startup為1。
2、這個servlet配置log4j就是讀出配置文件，然后調(diào)用configure函數(shù)。這里有兩個問題：一、需要知道文件在哪里；二、需要正確的文件類型
3、配置文件位置在web.xml中配置一個param即可，路徑一般是相對于web的root目錄
4、文件類型一般有兩種，一個是Java的property文件，另一種是xml文件
配置文件的大致內(nèi)容：log4j可以指定輸出的log級別的最低等級，以及l(fā)og的輸出配置格式，每個log可以指定多個輸出方式
（1）創(chuàng)建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日志設(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
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);
}
}
接下來就是運行了，來看看結(jié)果：
輸出結(jié)果：
四、Spring中使用Log4j
這里要實現(xiàn)web項目中利用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>
整個內(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> <!--用來啟動 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/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
然后打開文件
以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
深入分析JAVA 多線程--interrupt()和線程終止方式
這篇文章主要介紹了JAVA 多線程--interrupt()和線程終止方式的的相關(guān)資料，文中代碼非常細致，幫助大家更好的理解和學(xué)習(xí)，感興趣的朋友可以了解下2020-06-06
這篇文章主要介紹了Java使用正則表達式匹配獲取鏈接地址的方法,簡單分析了java正則匹配常用方法及獲取網(wǎng)址鏈接的相關(guān)操作技巧,需要的朋友可以參考下2017-08-08
使用OpenFeign實現(xiàn)服務(wù)調(diào)用的方法詳解
OpenFeign是運行在客戶端的聲明式服務(wù)調(diào)用的框架，通過聲明接口的方式來達到對服務(wù)的調(diào)用，本文就來和大家講講如何使用OpenFeign實現(xiàn)服務(wù)調(diào)用吧2023-06-06
Java使用策略模式實現(xiàn)聚石塔接口調(diào)用的問題
這篇文章主要介紹了Java使用策略模式實現(xiàn)聚石塔接口調(diào)用,為了避免多重判斷，而且有更好的擴展性，首選了策略模式來實現(xiàn)，具體解決方法跟隨小編一起看看吧2021-12-12
JAVA?兩個類同時實現(xiàn)同一個接口的方法(三種方法)
在Java中,兩個類同時實現(xiàn)同一個接口是非常常見的,接口定義了一組方法,實現(xiàn)接口的類必須提供這些方法的具體實現(xiàn),以下將展示如何實現(xiàn)這一要求,并提供具體的代碼示例,需要的朋友可以參考下2024-08-08
本文主要介紹Java中Mybatis的二級緩存，緩存就是一塊內(nèi)存空間，保存臨時數(shù)據(jù)，它是SqlSessionFactory的緩存，對Mybaits感興趣的小伙伴可以參考閱讀2023-03-03
這篇文章主要為大家介紹了JVM的垃圾回收機制，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-01-01
這篇文章主要通過兩個例題為大家介紹一下Java合并兩個及以上有序鏈表的實現(xiàn)方法，文中的示例代碼講解詳細，具有一定的學(xué)習(xí)價值，需要的可以參考一下2023-04-04
在JSP里，獲取客戶端的IP地址的方法是：request.getRemoteAddr()，這種方法在大部分情況下都是有效的。但是在通過了Apache,Squid等反向代理軟件就不能獲取到客戶端的真實IP地址了2014-04-04
這篇文章主要為大家詳細介紹了基于Java文件輸入輸出流實現(xiàn)文件上傳下載功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-04-04