Log4j properties的配置及其使用方法

這篇文章主要講解了“Log4j properties的配置及其使用方法”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“Log4j properties的配置及其使用方法”吧！

目錄

• 一、log4j簡(jiǎn)介
  

• 1、Loggers
  

• 2、Appenders
  

• 3、Layouts
  

• 二、配置詳解
  

• 1、配置根Logger：
  

• 2、配置日志信息輸出目的地（appender）：
  

• 2.1ConsoleAppender選項(xiàng)
  

• 2.2FileAppender選項(xiàng)
  

• 2.3DailyRollingFileAppender選項(xiàng)
  

• 2.4RollingFileAppender選項(xiàng)
  

• 3、配置日志信息的輸出格式（Layout）
  

• 3.1HTMLLayout選項(xiàng)
  

• 3.2PatternLayout選項(xiàng)：
  

• 一個(gè)不錯(cuò)的參考配置
  

一、log4j簡(jiǎn)介

log4j主要有三個(gè)重要的組件：

• Loggers(記錄器)：日志類別和級(jí)別；

• Appenders(輸出源)：日志要輸出的地方；

• Layout(布局)：日志以何種形式輸出。

1、Loggers

Loggers組件在此系統(tǒng)中被分為五個(gè)級(jí)別：DEBUG、INFO、WARN、ERROR和FATAL。這五個(gè)級(jí)別是有順序的，DEBUG < INFO < WARN < ERROR < FATAL，分別用來(lái)指定這條日志信息的重要程度
Log4j有一個(gè)規(guī)則：只輸出級(jí)別不低于設(shè)定級(jí)別的日志信息，假設(shè)Loggers級(jí)別設(shè)定為INFO，則INFO、WARN、ERROR和FATAL級(jí)別的日志信息都會(huì)輸出，而級(jí)別比INFO低的DEBUG則不會(huì)輸出。

2、Appenders

禁用和使用日志請(qǐng)求只是Log4j的基本功能，Log4j日志系統(tǒng)還提供許多強(qiáng)大的功能，比如允許把日志輸出到不同的地方，如控制臺(tái)（Console）、文件（Files）等，可以根據(jù)天數(shù)或者文件大小產(chǎn)生新的文件，可以以流的形式發(fā)送到其它地方等等。
常使用的類如下：

• 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ā)送到任意指定的地方）

log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
…
log4j.appender.appenderName.OptionN = valueN

3、Layouts

Log4j可以在Appenders的后面附加Layouts來(lái)完成這個(gè)功能。
Layouts提供四種日志輸出樣式，如根據(jù)HTML樣式、自由指定樣式、包含日志級(jí)別與信息的樣式和包含日志時(shí)間、線程、類別等信息的樣式。

常使用的類如下：

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

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

• org.apache.log4j.SimpleLayout（包含日志信息的級(jí)別和信息字符串）

• org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線程、類別等信息）

log4j.appender.appenderName.layout =className
log4j.appender.appenderName.layout.Option1 = value1
...
log4j.appender.appenderName.layout.OptionN = valueN

二、配置詳解

在實(shí)際應(yīng)用中，要使Log4j在系統(tǒng)中運(yùn)行須事先設(shè)定配置文件。配置文件事實(shí)上也就是對(duì)Logger、Appender及Layout進(jìn)行相應(yīng)設(shè)定。
Log4j支持兩種配置文件格式:

• 一種是XML格式的文件，

• 一種是properties屬性文件。

下面以properties屬性文件為例介紹log4j.properties的配置。

1、配置根Logger：

log4j.rootLogger = [ level ] , appenderName1, appenderName2, …

log4j.additivity.org.apache=false：表示Logger不會(huì)在父Logger的appender里輸出，默認(rèn)為true。
1. level ：設(shè)定日志記錄的最低級(jí)別，可設(shè)的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級(jí)別，Log4j建議只使用中間四個(gè)級(jí)別。通過(guò)在這里設(shè)定級(jí)別，您可以控制應(yīng)用程序中相應(yīng)級(jí)別的日志信息的開(kāi)關(guān)，比如在這里設(shè)定了INFO級(jí)別，則應(yīng)用程序中所有DEBUG級(jí)別的日志信息將不會(huì)被打印出來(lái)。
2. appenderName：就是指定日志信息要輸出到哪里?？梢酝瑫r(shí)指定多個(gè)輸出目的地，用逗號(hào)隔開(kāi)。
例如：log4j.rootLogger＝INFO,A1,B2,C3

2、配置日志信息輸出目的地（appender）：

log4j.appender.appenderName = className

appenderName：自定義appderName，在log4j.rootLogger設(shè)置中使用；

className：可設(shè)值如下：

(1)org.apache.log4j.ConsoleAppender（控制臺(tái)）
(2)org.apache.log4j.FileAppender（文件）
(3)org.apache.log4j.DailyRollingFileAppender（每天產(chǎn)生一個(gè)日志文件）
(4)org.apache.log4j.RollingFileAppender（文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件）
(5)org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方）

2.1ConsoleAppender選項(xiàng)

Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)為DEBUG。
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)值是true。
Target=System.err：默認(rèn)值是System.out。

2.2FileAppender選項(xiàng)

Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)為DEBUG。
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)值是true。
Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認(rèn)值是true。
File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件中。

2.3DailyRollingFileAppender選項(xiàng)

Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)為DEBUG。
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)值是true。
Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認(rèn)值是true。
File=D:/logs/logging.log4j：指定當(dāng)前消息輸出到logging.log4j文件中。

DatePattern='.'yyyy-MM：每月滾動(dòng)一次日志文件，即每月產(chǎn)生一個(gè)新的日志文件。當(dāng)前月的日志文件名為logging.log4j，前一個(gè)月的日志文件名為logging.log4j.yyyy-MM。

另外，也可以指定按周、天、時(shí)、分等來(lái)滾動(dòng)日志文件，對(duì)應(yīng)的格式如下：

1、'.'yyyy-MM：每月
2、'.'yyyy-ww：每周
3、'.'yyyy-MM-dd：每天
4、'.'yyyy-MM-dd-a：每天兩次
5、'.'yyyy-MM-dd-HH：每小時(shí)
6、'.'yyyy-MM-dd-HH-mm：每分鐘

2.4RollingFileAppender選項(xiàng)

Threshold=WARN：指定日志信息的最低輸出級(jí)別，默認(rèn)為DEBUG。
ImmediateFlush=true：表示所有消息都會(huì)被立即輸出，設(shè)為false則不輸出，默認(rèn)值是true。
Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認(rèn)值是true。
File=D:/logs/logging.log4j：指定消息輸出到logging.log4j文件中。
MaxFileSize=100KB：后綴可以是KB, MB 或者GB。在日志文件到達(dá)該大小時(shí)，將會(huì)自動(dòng)滾動(dòng)，即將原來(lái)的內(nèi)容移到logging.log4j.1文件中。
MaxBackupIndex=2：指定可以產(chǎn)生的滾動(dòng)文件的最大數(shù)，例如，設(shè)為2則可以產(chǎn)生logging.log4j.1，logging.log4j.2兩個(gè)滾動(dòng)文件和一個(gè)logging.log4j文件。

3、配置日志信息的輸出格式（Layout）

log4j.appender.appenderName.layout=className

className：可設(shè)值如下：

(1)org.apache.log4j.HTMLLayout（以HTML表格形式布局）
(2)org.apache.log4j.PatternLayout（可以靈活地指定布局模式）
(3)org.apache.log4j.SimpleLayout（包含日志信息的級(jí)別和信息字符串）
(4)org.apache.log4j.TTCCLayout（包含日志產(chǎn)生的時(shí)間、線程、類別等等信息）

3.1HTMLLayout選項(xiàng)

LocationInfo=true：輸出java文件名稱和行號(hào)，默認(rèn)值是false。
Title=My Logging： 默認(rèn)值是Log4J Log Messages。

3.2PatternLayout選項(xiàng)：

ConversionPattern=%m%n：設(shè)定以怎樣的格式顯示消息。
格式化符號(hào)說(shuō)明：

%p：輸出日志信息的優(yōu)先級(jí)，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL。
%d：輸出日志時(shí)間點(diǎn)的日期或時(shí)間，默認(rèn)格式為ISO8601，也可以在其后指定格式，
如：%d{yyyy/MM/dd HH:mm:ss,SSS}。
%r：輸出自應(yīng)用程序啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)。
%t：輸出產(chǎn)生該日志事件的線程名。
%l：輸出日志事件的發(fā)生位置，相當(dāng)于%c.%M(%F:%L)的組合，包括類全名、方法、文件名以及在代碼中的行數(shù)。例如：test.TestLog4j.main(TestLog4j.java:10)。
%c：輸出日志信息所屬的類目，通常就是所在類的全名。
%M：輸出產(chǎn)生日志信息的方法名。
%F：輸出日志消息產(chǎn)生時(shí)所在的文件名稱。
%L:：輸出代碼中的行號(hào)。
%m:：輸出代碼中指定的具體日志信息。
%n：輸出一個(gè)回車換行符，Windows平臺(tái)為"\r\n"，Unix平臺(tái)為"\n"。
%x：輸出和當(dāng)前線程相關(guān)聯(lián)的NDC(嵌套診斷環(huán)境)，尤其用到像java servlets這樣的多客戶多線程的應(yīng)用中。
%%：輸出一個(gè)"%"字符。
另外，還可以在%與格式字符之間加上修飾符來(lái)控制其最小長(zhǎng)度、最大長(zhǎng)度、和文本的對(duì)齊方式。如：

1）c：指定輸出category的名稱，最小的長(zhǎng)度是20，如果category的名稱長(zhǎng)度小于20的話，默認(rèn)的情況下右對(duì)齊。

2）%-20c："-"號(hào)表示左對(duì)齊。
3）%.30c：指定輸出category的名稱，最大的長(zhǎng)度是30，如果category的名稱長(zhǎng)度大于30的話，就會(huì)將左邊多出的字符截掉，但小于30的話也不會(huì)補(bǔ)空格。

一個(gè)不錯(cuò)的參考配置

#############
# 輸出到控制臺(tái)
#############

# log4j.rootLogger日志輸出類別和級(jí)別：只輸出不低于該級(jí)別的日志信息DEBUG < INFO < WARN < ERROR < FATAL
# WARN：日志級(jí)別     CONSOLE：輸出位置自己定義的一個(gè)名字       logfile：輸出位置自己定義的一個(gè)名字
log4j.rootLogger=WARN,CONSOLE,logfile
# 配置CONSOLE輸出到控制臺(tái)
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
# 配置CONSOLE設(shè)置為自定義布局模式
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
# 配置CONSOLE日志的輸出格式  [frame] 2019-08-22 22:52:12,000  %r耗費(fèi)毫秒數(shù) %p日志的優(yōu)先級(jí) %t線程名 %C所屬類名通常為全類名 %L代碼中的行號(hào) %x線程相關(guān)聯(lián)的NDC %m日志 %n換行
log4j.appender.CONSOLE.layout.ConversionPattern=[frame] %d{yyyy-MM-dd HH:mm:ss,SSS} - %-4r %-5p [%t] %C:%L %x - %m%n

################
# 輸出到日志文件中
################

# 配置logfile輸出到文件中 文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生新的日志文件
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
# 保存編碼格式
log4j.appender.logfile.Encoding=UTF-8
# 輸出文件位置此為項(xiàng)目根目錄下的logs文件夾中
log4j.appender.logfile.File=logs/root.log
# 后綴可以是KB,MB,GB達(dá)到該大小后創(chuàng)建新的日志文件
log4j.appender.logfile.MaxFileSize=10MB
# 設(shè)置滾定文件的最大值3 指可以產(chǎn)生root.log.1、root.log.2、root.log.3和root.log四個(gè)日志文件
log4j.appender.logfile.MaxBackupIndex=3  
# 配置logfile為自定義布局模式
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n

##########################
# 對(duì)不同的類輸出不同的日志文件
##########################

# club.bagedate包下的日志單獨(dú)輸出
log4j.logger.club.bagedate=DEBUG,bagedate
# 設(shè)置為false該日志信息就不會(huì)加入到rootLogger中了
log4j.additivity.club.bagedate=false
# 下面就和上面配置一樣了
log4j.appender.bagedate=org.apache.log4j.RollingFileAppender
log4j.appender.bagedate.Encoding=UTF-8
log4j.appender.bagedate.File=logs/bagedate.log
log4j.appender.bagedate.MaxFileSize=10MB
log4j.appender.bagedate.MaxBackupIndex=3
log4j.appender.bagedate.layout=org.apache.log4j.PatternLayout
log4j.appender.bagedate.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n

感謝各位的閱讀，以上就是“Log4j properties的配置及其使用方法”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)Log4j properties的配置及其使用方法這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！