Log4j properties的配置及其使用方法

這篇文章主要講解了“Log4j properties的配置及其使用方法”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“Log4j properties的配置及其使用方法”吧！

目錄

• 一、log4j簡介
  

• 1、Loggers
  

• 2、Appenders
  

• 3、Layouts
  

• 二、配置詳解
  

• 1、配置根Logger：
  

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

• 2.1ConsoleAppender選項
  

• 2.2FileAppender選項
  

• 2.3DailyRollingFileAppender選項
  

• 2.4RollingFileAppender選項
  

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

• 3.1HTMLLayout選項
  

• 3.2PatternLayout選項：
  

• 一個不錯的參考配置
  

一、log4j簡介

log4j主要有三個重要的組件：

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

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

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

1、Loggers

Loggers組件在此系統中被分為五個級別：DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的，DEBUG < INFO < WARN < ERROR < FATAL，分別用來指定這條日志信息的重要程度
Log4j有一個規則：只輸出級別不低于設定級別的日志信息，假設Loggers級別設定為INFO，則INFO、WARN、ERROR和FATAL級別的日志信息都會輸出，而級別比INFO低的DEBUG則不會輸出。

2、Appenders

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

• org.apache.log4j.ConsoleAppender（控制臺）

• org.apache.log4j.FileAppender（文件）

• org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件）

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

• org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方）

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

3、Layouts

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

常使用的類如下：

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

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

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

• org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等信息）

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

二、配置詳解

在實際應用中，要使Log4j在系統中運行須事先設定配置文件。配置文件事實上也就是對Logger、Appender及Layout進行相應設定。
Log4j支持兩種配置文件格式:

• 一種是XML格式的文件，

• 一種是properties屬性文件。

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

1、配置根Logger：

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

log4j.additivity.org.apache=false：表示Logger不會在父Logger的appender里輸出，默認為true。
1. level ：設定日志記錄的最低級別，可設的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別，Log4j建議只使用中間四個級別。通過在這里設定級別，您可以控制應用程序中相應級別的日志信息的開關，比如在這里設定了INFO級別，則應用程序中所有DEBUG級別的日志信息將不會被打印出來。
2. appenderName：就是指定日志信息要輸出到哪里。可以同時指定多個輸出目的地，用逗號隔開。
例如：log4j.rootLogger＝INFO,A1,B2,C3

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

log4j.appender.appenderName = className

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

className：可設值如下：

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

2.1ConsoleAppender選項

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

2.2FileAppender選項

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

2.3DailyRollingFileAppender選項

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：每分鐘

2.4RollingFileAppender選項

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）

log4j.appender.appenderName.layout=className

className：可設值如下：

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

3.1HTMLLayout選項

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

3.2PatternLayout選項：

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)的組合，包括類全名、方法、文件名以及在代碼中的行數。例如：test.TestLog4j.main(TestLog4j.java:10)。
%c：輸出日志信息所屬的類目，通常就是所在類的全名。
%M：輸出產生日志信息的方法名。
%F：輸出日志消息產生時所在的文件名稱。
%L:：輸出代碼中的行號。
%m:：輸出代碼中指定的具體日志信息。
%n：輸出一個回車換行符，Windows平臺為"\r\n"，Unix平臺為"\n"。
%x：輸出和當前線程相關聯的NDC(嵌套診斷環境)，尤其用到像java servlets這樣的多客戶多線程的應用中。
%%：輸出一個"%"字符。
另外，還可以在%與格式字符之間加上修飾符來控制其最小長度、最大長度、和文本的對齊方式。如：

1）c：指定輸出category的名稱，最小的長度是20，如果category的名稱長度小于20的話，默認的情況下右對齊。

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

一個不錯的參考配置

#############
# 輸出到控制臺
#############

# log4j.rootLogger日志輸出類別和級別：只輸出不低于該級別的日志信息DEBUG < INFO < WARN < ERROR < FATAL
# WARN：日志級別     CONSOLE：輸出位置自己定義的一個名字       logfile：輸出位置自己定義的一個名字
log4j.rootLogger=WARN,CONSOLE,logfile
# 配置CONSOLE輸出到控制臺
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender 
# 配置CONSOLE設置為自定義布局模式
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout 
# 配置CONSOLE日志的輸出格式  [frame] 2019-08-22 22:52:12,000  %r耗費毫秒數 %p日志的優先級 %t線程名 %C所屬類名通常為全類名 %L代碼中的行號 %x線程相關聯的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輸出到文件中 文件大小到達指定尺寸的時候產生新的日志文件
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
# 保存編碼格式
log4j.appender.logfile.Encoding=UTF-8
# 輸出文件位置此為項目根目錄下的logs文件夾中
log4j.appender.logfile.File=logs/root.log
# 后綴可以是KB,MB,GB達到該大小后創建新的日志文件
log4j.appender.logfile.MaxFileSize=10MB
# 設置滾定文件的最大值3 指可以產生root.log.1、root.log.2、root.log.3和root.log四個日志文件
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

##########################
# 對不同的類輸出不同的日志文件
##########################

# club.bagedate包下的日志單獨輸出
log4j.logger.club.bagedate=DEBUG,bagedate
# 設置為false該日志信息就不會加入到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的配置及其使用方法”的內容了，經過本文的學習后，相信大家對Log4j properties的配置及其使用方法這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！