2. 程式人生 > >java日誌框架log4j詳細配置及與slf4j聯合使用教程

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

阿新 • • 發佈：2018-12-11

注： 更讓你理解facade門面模式，更讓你理解jvm的run anyway

一、log4j基本用法

　　首先，配置log4j的jar，maven工程配置以下依賴，非maven工程從maven倉庫下載jar新增到“build path”

1

2

3

4

5

<dependency>

<groupId>log4j</groupId>

<artifactId>log4j</artifactId>

<version>1.2.17</version

>

</dependency>

　　然後，在src/main/java目錄（包的根目錄即classpath）新建log4j.properties檔案

1

2

3

4

5

6

7

8

9

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檔案

1

2

3

4

5

6

7

8

9

10

11

12

13

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方法，日誌資訊就出來了

1

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

二、log4j.properties路徑

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

1、普通java或spring工程

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

2、spring mvc工程

　　web工程裡用spring mvc構建的比較多了，把log4j.properties放在src/main/resources的conf目錄（web工程配置檔案通常在resources或WEB-INF目錄），編輯web.xml，新增

1

2

3

4

5

6

7

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

3、普通web工程

　　沒有了spring提供的listener載入log4j.properties，我們要怎麼載入這個檔案呢？同樣，把log4j.properties放在src/main/resources的conf目錄，用servlet載入

1

2

3

4

5

6

7

8

9

10

11

12

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，新增

1

2

3

4

5

6

7

8

9

<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內容怎麼配置

三、log4j.properties內容

　　接下來介紹的內容看起來獨立，其實相互關聯，並且很有規律，我們要輸出日誌，首先得有日誌物件（logger），那這些日誌物件把日誌輸出到哪裡呢，控制檯還是檔案，這就要設定輸出位置（appender），輸出的格式與內容又是什麼樣的呢，這就要設定輸出樣式（layout），這些設定完，log4j的配置也就完了

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

1、logger

　　日誌例項，就是程式碼裡實例化的Logger物件

1

2

log4j.rootLogger=LEVEL,appenderName1,appenderName2,...

log4j.additivity.org.apache=false：表示不會在父logger的appender裡輸出，預設true

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

　　下面給出一個更清晰的例子，配置“com.demo.test”包下所有類中例項化的Logger物件

1

2

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

log4j.additivity.com.demo.test=false

2、appender

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

1

log4j.appender.appenderName=className

　　appender有5種選擇

1

2

3

4

5

org.apache.log4j.ConsoleAppender（控制檯）

org.apache.log4j.FileAppender（檔案）

org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌檔案）

org.apache.log4j.RollingFileAppender（檔案大小到達指定尺寸的時候產生一個新的檔案）

org.apache.log4j.WriterAppender（將日誌資訊以流格式傳送到任意指定的地方）

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

　　ConsoleAppender（常用）

1

2

3

Threshold=WARN：指定日誌資訊的最低輸出級別，預設DEBUG

ImmediateFlush=true：表示所有訊息都會被立即輸出，設為false則不輸出，預設值是true

Target=System.err：預設值是System.out

　　FileAppender

1

2

3

4

Threshold=WARN：指定日誌資訊的最低輸出級別，預設DEBUG

ImmediateFlush=true：表示所有訊息都會被立即輸出，設為false則不輸出，預設true

Append=false：true表示訊息增加到指定檔案中，false則將訊息覆蓋指定的檔案內容，預設true

File=D:/logs/logging.log4j：指定訊息輸出到logging.log4j檔案

　　DailyRollingFileAppender（常用）

1

2

3

4

5

6

7

8

9

10

11

12

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

1

2

3

4

5

6

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檔案

3、layout

　　指定logger輸出內容及格式

1

log4j.appender.appenderName.layout=className

　　layout有4種選擇

1

2

3

4

org.apache.log4j.HTMLLayout（以HTML表格形式佈局）

org.apache.log4j.PatternLayout（可以靈活地指定佈局模式）

org.apache.log4j.SimpleLayout（包含日誌資訊的級別和資訊字串）

org.apache.log4j.TTCCLayout（包含日誌產生的時間、執行緒、類別等資訊）

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

　　HTMLLayout

1

2

LocationInfo=true：輸出java檔名稱和行號，預設false

Title=My Logging： 預設值是Log4J Log Messages

　　PatternLayout（最常用的配置）

1

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

　　設定格式的引數說明如下

1

2

3

4

5

6

7

8

9

10

11

12

13

%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(巢狀診斷環境)

%%：輸出一個"%"字元

四、log4j完整配置示例

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

1

2

log4j.rootLogger=DEBUG,console,dailyFile,rollingFile,logFile

log4j.additivity.org.apache=true

　　控制檯console日誌輸出器

1

2

3

4

5

6

7

# 控制檯(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日誌輸出器

1

2

3

4

5

6

7

8

# 日誌檔案(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日誌輸出器

1

2

3

4

5

6

7

8

9

10

# 滾動檔案(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日誌輸出器

1

2

3

4

5

6

7

8

9

# 定期滾動日誌檔案(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

五、log4j區域性日誌配置

　　以上介紹的配置都是全域性的，整個工程的程式碼使用同一套配置，意味著所有的日誌都輸出在了相同的地方，你無法直接了當的去看資料庫訪問日誌、使用者登入日誌、操作日誌，它們都混在一起，因此，需要為包甚至是類配置單獨的日誌輸出，下面給出一個例子，為“com.demo.test”包指定日誌輸出器“test”，“com.demo.test”包下所有類的日誌都將輸出到/log/test.log檔案

1

2

3

4

5

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

1

2

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

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

　　然後分別配置

1

2

3

4

5

6

7

8

9

10

11

12

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

六、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配置過程完全不變

1

2

3

4

5

<dependency>

<groupId>org.slf4j</groupId>

<artifactId>slf4j-api</artifactId>

<version>1.7.21</version>

</dependency>

　　然後，弄到slf4j與log4j的關聯jar包，通過這個東西，將對slf4j介面的呼叫轉換為對log4j的呼叫，不同的日誌實現框架，這個轉換工具不同

1

2

3

4

5

<dependency>

<groupId>org.slf4j</groupId>

<artifactId>slf4j-log4j12</artifactId>

<version>1.7.21</version>

</dependency>

　　當然了，slf4j-log4j12這個包肯定依賴了slf4j和log4j，所以使用slf4j+log4j的組合只要配置上面這一個依賴就夠了

　　最後，程式碼裡宣告logger要改一下，原來使用log4j是這樣的

1

2

3

4

5

6

7

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

}

}

　　現在要改成這樣

1

2

3

4

5

6

7

8

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還能使用佔位符，很方便

相關推薦

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

注： 更讓你理解facade門面模式，更讓你理解jvm的run anyway 一、log4j基本用法 　　首先，配置log4j的jar，maven工程配置以下依賴，非maven工程從maven倉庫下載jar新增到“build path” 1 2

Java日誌框架-logback的介紹及配置使用方法（純Java工程）

說明：內容估計有些舊，2011年的，但是大體意思應該沒多大變化，最新的配置可以參考官方文件。 一、logback的介紹 Logback是由log4j創始人設計的又一個開源日誌元件。logback當前分成三個模組：logback-core，logback- classic和

JAVA日誌框架log4j和slf4j

writer class 基本 鏈接 發送 控制 spa com 內容 1 org.apache.log4j.ConsoleAppender（控制臺） 2 org.apache.log4j.FileAppender（文件） 3 org.apache.log4j.Daily

Java 日誌框架Log4j簡介、歷史

Log4j簡介 Log4j 是基於Java開發的日誌框架，其作者Ceki Gülcü將Log4j捐獻給了Apache軟體基金會，使之成為了Apache日誌服務的一個子專案。 Log4j雖然是Java

shiro框架的詳細配置及使用

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-insta

Java日誌框架研究及常見配置

按照基本的定義，日誌即是對程式執行過程中關鍵事件的記錄；大體日誌分為執行日誌和開發日誌，執行日誌在業務層面記錄一些關鍵事件，為後面的跟蹤執行提供幫助，而開發日誌大多數時候是除錯日誌，根據事件流的輸出來除錯程式；因為開發人員本身的關注領域，執行日誌可能製作的比較少，難以達到

【Java日誌】log4j配置詳解

#設定日誌的級別，以及日誌所使用的appender log4j.rootLogger=all, console, file ### 控制檯 ### log4j.appender.console=org.apache.log4j.ConsoleAppender log4j.appender.cons

Java日誌框架解析及實戰分析

轉載自： https://zhuanlan.zhihu.com/p/24272450 https://zhuanlan.zhihu.com/p/24275518 作為Java程式設計師，幸運的是，Java 擁有功能和效能都非常強大的日誌庫；不幸的是，這樣的日誌庫有不止一個——相信每個人都曾經迷失在JUL(J

Java Web框架play framework的下載與環境變數配置

        Web專案的開發有著眾多的框架，最近剛剛接觸了play， 對於一個Java開發人員來說，play是一個不可多得的好框架。下面我簡單介紹下如何下載play ，以及play的環境變數配置方法。（1）登入playframework官網，進行下載： https://w

Java日誌框架——JCL(Log4J,Java Logging API)轉SLF4J過程中重複依賴衝突問題

如文章《Java日誌框架——JCL(Log4J,Java Logging API)轉SLF4J》所述，在完成”JCL(Log4J,Java Logging API)轉SLF4J“的過程中，要注意重複依賴衝突問題。 比如一個專案原本使用JCL日誌框架（可以是具有對"commo

遊戲UI框架設計(五): 配置管理與應用

oid per b- 測試 中心 序列化對象 ner stun sage 遊戲UI框架設計(五) --配置管理與應用 在開發企業級遊戲/VR/AR產品時候，我們總是希望可以總結出一些通用的技術體系，框架結構等，為簡化我們的開發起到“四兩撥千金”的作用。所謂“配

【字符編碼】Java字符編碼詳細解答及問題探討

很好 cep 我們 簡單 實現 而是 tle 針對 Coding 一、前言 　　繼上一篇寫完字節編碼內容後，現在分析在Java中各字符編碼的問題，並且由這個問題，也引出了一個更有意思的問題，筆者也還沒有找到這個問題的答案。也希望各位園友指點指點。 二、Java字符編碼 　　

Question20180106 Java環境變量的配置及為什麽要配置環境變量

system32 lin 安裝目錄 方式 for 不同 包括 new batch Question 1 Java環境變量的配置及為什麽要配置環境變量 Q1.1為什麽要配置環境變量 　　在學習JAVA的過程中，涉及到多個環境變量（environment variable

Java日誌框架：slf4j作用及其實現原理

sof cat 打開 系統 aging .get matching ade you 簡單回顧門面模式 slf4j是門面模式的典型應用，因此在講slf4j前，我們先簡單回顧一下門面模式， 門面模式，其核心為外部與一個子系統的通信必須通過一個統一的外觀對象進行，使得子系統更易於

log4j 詳細配置實例

log4j log4j實例 一，maven引入jar包 org.slf4j slf4j-api 1.6.6 org.slf4j slf4j-log4j12 1.6.6 log4j log

asp.Net Core免費開源分布式異常日誌收集框架Exceptionless安裝配置以及簡單使用圖文教程

true 類型 全部 界面 目錄 () 程序包 light set 最近在學習張善友老師的NanoFabric 框架的時了解到Exceptionless : https://exceptionless.com/ ！因此學習了一下這個開源框架！下面對Exceptionless

log4j詳細配置

文件 日誌打印 bug CA 別人 使用 error org .info 參考博客：https://blog.csdn.net/sinat_30185177/article/details/73550377 log4j。。很簡單好用的一個記錄日誌的東東，正因為好用，本人從

windows下的nginx安裝和配置及與tomcat關聯配置記錄

   1. 官方中文說明：http://wiki.nginx.org/NginxChs  或者http://nginx.org/ 下載：當前穩定版: Nginx 1.0.5 | Nginx/windows 1.0.5 (更新記錄) (2011年7月19日) 我們下

MongDB-API在SSM框架中的配置及使用

一、在父工程的pom.xml中引入Maven依賴 <groupId>com.foriseland.fjf</groupId> <artifactId>fjf-cache-mongdb</artifactId> <version>1.0

Java日誌框架介紹

一.序言 線上問題的排查 通過日誌資料進行使用者行為分析等 二.日誌框架分類及其歷史 框架的種類： JDK自身帶的 Log4J1及其Log4J2： LogBack： Commons Logging：門面框架 SLF：門面框架 框架歷史： 框架之間關係： SLF與Commons Log