java日誌框架log4j詳細配置及與slf4j聯合使用教程

最後更新於2017年02月09日

1、log4j基本用法

　　首先，配置log4j的jar，maven工程配置如下依賴，非maven工程從maven倉庫下載jar添加到「build path」

<dependency>
	<groupId>log4j</groupId>
	<artifactId>log4j</artifactId>
	<version>1.2.17</version>
</dependency>

　　而後，在src/main/java目錄（包的根目錄即classpath）新建log4j.properties文件

log4j.rootLogger=INFO,console
log4j.additivity.org.apache=true
#console
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=INFO
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.out
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

　　最後，新建Main.java文件

package com.xmyself.log4j;
import org.apache.log4j.Logger;
public class Main {
	public static void main(String[] args) {
		new Test().test();
	}
}
class Test {
	final Logger log = Logger.getLogger(Test.class);
	public void test() {
		log.info("hello this is log4j info log");
	}
}

　　運行main方法，日誌信息就出來了

2016-12-01 21:23:29 [INFO] hello this is log4j info log

2、log4j.properties路徑

　　log4j.properties要放在哪以及怎樣配置才能被解析呢？不一樣工程類型配置方式不一樣

一、普通java或spring工程

　　這是最多見的java工程類型，寫demo用的多，把log4j.properties放在src/main/java目錄（包的根目錄）就好了

二、spring mvc工程

　　web工程裏用spring mvc構建的比較多了，把log4j.properties放在src/main/resources的conf目錄（web工程配置文件一般在resources或WEB-INF目錄），編輯web.xml，添加

<context-param>
	<param-name>log4jConfigLocation</param-name>
	<param-value>classpath:/conf/log4j.properties</param-value>
</context-param>
<listener>
	<listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

三、普通web工程

　　沒有了spring提供的listener加載log4j.properties，咱們要怎麼加載這個文件呢？一樣，把log4j.properties放在src/main/resources的conf目錄，用servlet加載

public class Log4jServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
 
    public void init(ServletConfig config) throws ServletException {
        String prefix = this.getClass().getClassLoader().getResource("/").getPath();
        String path = config.getInitParameter("log4j-path");
        PropertyConfigurator.configure(prefix + path);
    }
    public void doGet(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {}
    public void doPost(HttpServletRequest req, HttpServletResponse res) throws IOException, ServletException {}
    public void destroy() {}
}

　　編輯web.xml，添加

<servlet>
	<servlet-name>log4j</servlet-name>
	<servlet-class>com.xmyself.log4j.Log4jServlet</servlet-class>
	<init-param>
		<param-name>log4j-path</param-name>
		<param-value>conf/log4j.properties</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>

　　看着是否是和spring mvc的很像，甚至你也想到了，普通java工程沒有指定log4j.properties的路徑，那說明log4j的jar包必定有一個默認的路徑。另外，建議，log4j的配置放在第一個，由於後續加載其餘組件就要開始使用日誌記錄了

　　如今，你能夠在多種類型的java工程中打出日誌了，但都是控制檯的日誌，輸出內容也頗有限，下面咱們就來詳細介紹log4j.properties內容怎麼配置

3、log4j.properties內容

　　接下來介紹的內容看起來獨立，其實相互關聯，而且頗有規律，咱們要輸出日誌，首先得有日誌對象（logger），那這些日誌對象把日誌輸出到哪裏呢，控制檯仍是文件，這就要設置輸出位置（appender），輸出的格式與內容又是什麼樣的呢，這就要設置輸出樣式（layout），這些設置完，log4j的配置也就完了

　　在此以前，先介紹下log4j日誌等級的概念，日誌等級就是日誌的重要程度，log4j日誌分爲7個等級：ALL、DEBUG、INFO、WARN、ERROR、FATAL、OFF，從左到右等級由低到高，分等級是爲了設置日誌輸出的門檻，只有等級等於或高於這個門檻的日誌纔有機會輸出

一、logger

　　日誌實例，就是代碼裏實例化的Logger對象

log4j.rootLogger=LEVEL,appenderName1,appenderName2,...
log4j.additivity.org.apache=false：表示不會在父logger的appender裏輸出，默認true

　　這是全局logger的配置，LEVEL用來設定日誌等級，appenderName定義日誌輸出器，示例中的「console」就是一個日誌輸出器

　　下面給出一個更清晰的例子，配置「com.demo.test」包下全部類中實例化的Logger對象

log4j.logger.com.demo.test=DEBUG,test
log4j.additivity.com.demo.test=false

二、appender

　　日誌輸出器，指定logger的輸出位置

log4j.appender.appenderName=className

　　appender有5種選擇

org.apache.log4j.ConsoleAppender（控制檯）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（天天產生一個日誌文件）
org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）

　　每種appender都有若干配置項，下面逐一介紹

　　ConsoleAppender（經常使用）

Threshold=WARN：指定日誌信息的最低輸出級別，默認DEBUG
ImmediateFlush=true：表示全部消息都會被當即輸出，設爲false則不輸出，默認值是true
Target=System.err：默認值是System.out

　　FileAppender

Threshold=WARN：指定日誌信息的最低輸出級別，默認DEBUG
ImmediateFlush=true：表示全部消息都會被當即輸出，設爲false則不輸出，默認true
Append=false：true表示消息增長到指定文件中，false則將消息覆蓋指定的文件內容，默認true
File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件

　　DailyRollingFileAppender（經常使用）

Threshold=WARN：指定日誌信息的最低輸出級別，默認DEBUG
ImmediateFlush=true：表示全部消息都會被當即輸出，設爲false則不輸出，默認true
Append=false：true表示消息增長到指定文件中，false則將消息覆蓋指定的文件內容，默認true
File=D:/logs/logging.log4j：指定當前消息輸出到logging.log4j文件
DatePattern='.'yyyy-MM：每個月滾動一第二天志文件，即每個月產生一個新的日誌文件。當前月的日誌文件名爲logging.log4j，前一個月的日誌文件名爲logging.log4j.yyyy-MM
另外，也能夠指定按周、天、時、分等來滾動日誌文件，對應的格式以下：
1)'.'yyyy-MM：每個月
2)'.'yyyy-ww：每週
3)'.'yyyy-MM-dd：天天
4)'.'yyyy-MM-dd-a：天天兩次
5)'.'yyyy-MM-dd-HH：每小時
6)'.'yyyy-MM-dd-HH-mm：每分鐘

　　RollingFileAppender

Threshold=WARN：指定日誌信息的最低輸出級別，默認DEBUG
ImmediateFlush=true：表示全部消息都會被當即輸出，設爲false則不輸出，默認true
Append=false：true表示消息增長到指定文件中，false則將消息覆蓋指定的文件內容，默認true
File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件
MaxFileSize=100KB：後綴能夠是KB,MB或者GB。在日誌文件到達該大小時，將會自動滾動，即將原來的內容移到logging.log4j.1文件
MaxBackupIndex=2：指定能夠產生的滾動文件的最大數，例如，設爲2則能夠產生logging.log4j.1，logging.log4j.2兩個滾動文件和一個logging.log4j文件

三、layout

　　指定logger輸出內容及格式

log4j.appender.appenderName.layout=className

　　layout有4種選擇

org.apache.log4j.HTMLLayout（以HTML表格形式佈局）
org.apache.log4j.PatternLayout（能夠靈活地指定佈局模式）
org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串）
org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等信息）

　　layout也有配置項，下面具體介紹

　　HTMLLayout

LocationInfo=true：輸出java文件名稱和行號，默認false
Title=My Logging： 默認值是Log4J Log Messages

　　PatternLayout（最經常使用的配置）

ConversionPattern=%m%n：設定以怎樣的格式顯示消息

　　設置格式的參數說明以下

%p：輸出日誌信息的優先級，即DEBUG，INFO，WARN，ERROR，FATAL
%d：輸出日誌時間點的日期或時間，默認格式爲ISO8601，能夠指定格式如：%d{yyyy/MM/dd HH:mm:ss,SSS}
%r：輸出自應用程序啓動到輸出該log信息耗費的毫秒數
%t：輸出產生該日誌事件的線程名
%l：輸出日誌事件的發生位置，至關於%c.%M(%F:%L)的組合，包括類全名、方法、文件名以及在代碼中的行數
%c：輸出日誌信息所屬的類目，一般就是類全名
%M：輸出產生日誌信息的方法名
%F：輸出日誌消息產生時所在的文件名
%L：輸出代碼中的行號
%m：輸出代碼中指定的具體日誌信息
%n：輸出一個回車換行符，Windows平臺爲"rn"，Unix平臺爲"n"
%x：輸出和當前線程相關聯的NDC(嵌套診斷環境)
%%：輸出一個"%"字符

4、log4j完整配置示例

　　介紹完了log4j.properties內容，咱們來配置一些經常使用的日誌輸出吧

log4j.rootLogger=DEBUG,console,dailyFile,rollingFile,logFile
log4j.additivity.org.apache=true

　　控制檯console日誌輸出器

# 控制檯(console)
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.Threshold=DEBUG
log4j.appender.console.ImmediateFlush=true
log4j.appender.console.Target=System.err
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

　　文件logFile日誌輸出器

# 日誌文件(logFile)
log4j.appender.logFile=org.apache.log4j.FileAppender
log4j.appender.logFile.Threshold=DEBUG
log4j.appender.logFile.ImmediateFlush=true
log4j.appender.logFile.Append=true
log4j.appender.logFile.File=D:/logs/log.log4j
log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
log4j.appender.logFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

　　滾動文件rollingFile日誌輸出器

# 滾動文件(rollingFile)
log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.Threshold=DEBUG
log4j.appender.rollingFile.ImmediateFlush=true
log4j.appender.rollingFile.Append=true
log4j.appender.rollingFile.File=D:/logs/log.log4j
log4j.appender.rollingFile.MaxFileSize=200KB
log4j.appender.rollingFile.MaxBackupIndex=50
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

　　按期滾動文件dailyFile日誌輸出器

# 按期滾動日誌文件(dailyFile)
log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.dailyFile.Threshold=DEBUG
log4j.appender.dailyFile.ImmediateFlush=true
log4j.appender.dailyFile.Append=true
log4j.appender.dailyFile.File=D:/logs/log.log4j
log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
log4j.appender.dailyFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

5、log4j局部日誌配置

　　以上介紹的配置都是全局的，整個工程的代碼使用同一套配置，意味着全部的日誌都輸出在了相同的地方，你沒法直接了當的去看數據庫訪問日誌、用戶登陸日誌、操做日誌，它們都混在一塊兒，所以，須要爲包甚至是類配置單獨的日誌輸出，下面給出一個例子，爲「com.demo.test」包指定日誌輸出器「test」，「com.demo.test」包下全部類的日誌都將輸出到/log/test.log文件

log4j.logger.com.demo.test=DEBUG,test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

　　也可讓同一個類輸出不一樣的日誌，爲達到這個目的，須要在這個類中實例化兩個logger

private static Log logger1 = LogFactory.getLog("myTest1");
private static Log logger2 = LogFactory.getLog("myTest2");

　　而後分別配置

log4j.logger.myTest1= DEBUG,test1
log4j.additivity.myTest1=false
log4j.appender.test1=org.apache.log4j.FileAppender
log4j.appender.test1.File=/log/test1.log
log4j.appender.test1.layout=org.apache.log4j.PatternLayout
log4j.appender.test1.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n
 
log4j.logger.myTest2=DEBUG,test2
log4j.appender.test2=org.apache.log4j.FileAppender
log4j.appender.test2.File=/log/test2.log
log4j.appender.test2.layout=org.apache.log4j.PatternLayout
log4j.appender.test2.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%p] %m%n

6、slf4j與log4j聯合使用

　　slf4j是什麼？slf4j只是定義了一組日誌接口，但並未提供任何實現，既然這樣，爲何要用slf4j呢？log4j不是已經知足要求了嗎？

　　是的，log4j知足了要求，可是，日誌框架並不僅有log4j一個，你喜歡用log4j，有的人可能更喜歡logback，有的人甚至用jdk自帶的日誌框架，這種狀況下，若是你要依賴別人的jar，整個系統就用了兩個日誌框架，若是你依賴10個jar，每一個jar用的日誌框架都不一樣，豈不是一個工程用了10個日誌框架，那就亂了！

　　若是你的代碼使用slf4j的接口，具體日誌實現框架你喜歡用log4j，其餘人的代碼也用slf4j的接口，具體實現未知，那你依賴其餘人jar包時，整個工程就只會用到log4j日誌框架，這是一種典型的門面模式應用，與jvm思想相同，咱們面向slf4j寫日誌代碼，slf4j處理具體日誌實現框架之間的差別，正如咱們面向jvm寫java代碼，jvm處理操做系統之間的差別，結果就是，一處編寫，處處運行。何況，如今愈來愈多的開源工具都在用slf4j了

　　那麼，怎麼用slf4j呢？

　　首先，得弄到slf4j的jar包，maven依賴以下，log4j配置過程徹底不變

<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-api</artifactId>
	<version>1.7.21</version>
</dependency>

　　而後，弄到slf4j與log4j的關聯jar包，經過這個東西，將對slf4j接口的調用轉換爲對log4j的調用，不一樣的日誌實現框架，這個轉換工具不一樣

<dependency>
	<groupId>org.slf4j</groupId>
	<artifactId>slf4j-log4j12</artifactId>
	<version>1.7.21</version>
</dependency>

　　固然了，slf4j-log4j12這個包確定依賴了slf4j和log4j，因此使用slf4j+log4j的組合只要配置上面這一個依賴就夠了

　　最後，代碼裏聲明logger要改一下，原來使用log4j是這樣的

import org.apache.log4j.Logger;
class Test {
	final Logger log = Logger.getLogger(Test.class);
	public void test() {
		log.info("hello this is log4j info log");
	}
}

　　如今要改爲這樣

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
class Test {
	Logger log = LoggerFactory.getLogger(Test.class);
	public void test() {
		log.info("hello, my name is {}", "chengyi");
	}
}

　　依賴的Logger變了，並且，slf4j的api還能使用佔位符，很方便