Log4j.properties配置詳解

一、 Log4j簡介

Log4j有三個主要的組件：

  • Loggers(記錄器):日志類別和級別;
  • Appenders (輸出源):日志要輸出的地方;
  • Layouts(布局):日志以何種形式輸出

1.1 Loggers

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

1.2 Appenders

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

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

配置模式：

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

1.3 Layouts

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

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

配置模式：

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

二、配置詳解

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

  • 一種是XML格式的文件，
  • 一種是properties屬性文件。

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

2.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：就是指定日志信息要輸出到哪里?？梢酝瑫r指定多個輸出目的地，用逗號隔開。
例如：log4j.rootLogger＝INFO,A1,B2,C3

2.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（每天產(chǎn)生一個日志文件）
  • (4)org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產(chǎn)生一個新的文件）
  • (5)org.apache.log4j.WriterAppender（將日志信息以流格式發(fā)送到任意指定的地方）

(1) ConsoleAppender選項

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

(2) FileAppender選項

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

(3) DailyRollingFileAppender選項

  • Threshold=WARN：指定日志信息的最低輸出級別，默認為DEBUG。
  • ImmediateFlush=true：表示所有消息都會被立即輸出，設為false則不輸出，默認值是true。
  • Append=false：true表示消息增加到指定文件中，false則將消息覆蓋指定的文件內(nèi)容，默認值是true。
  • File=D:/logs/logging.log4j：指定當前消息輸出到logging.log4j文件中。
  • DatePattern='.'yyyy-MM：每月滾動一次日志文件，即每月產(chǎn)生一個新的日志文件。當前月的日志文件名為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：每分鐘

(4) RollingFileAppender選項

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

2.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（包含日志產(chǎn)生的時間、線程、類別等等信息）

(1) HTMLLayout選項

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

(2) PatternLayout選項：

ConversionPattern=%m%n：設定以怎樣的格式顯示消息。
格式化符號說明：

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

另外，還可以在%與格式字符之間加上修飾符來控制其最小長度、最大長度、和文本的對齊方式。如：

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

附：Log4j比較全面的配置

Log4j配置文件實現(xiàn)了輸出到控制臺、文件、回滾文件、發(fā)送日志郵件、輸出到數(shù)據(jù)庫日志表、自定義標簽等全套功能。

log4j.rootLogger=DEBUG,console,dailyFile,im
log4j.additivity.org.apache=true
# 控制臺(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=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 日志文件(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=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 回滾文件(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=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 定期回滾日志文件(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=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 應用于socket
log4j.appender.socket=org.apache.log4j.RollingFileAppender
log4j.appender.socket.RemoteHost=localhost
log4j.appender.socket.Port=5001
log4j.appender.socket.LocationInfo=true
# Set up for Log Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# Log Factor 5 Appender
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
# 發(fā)送日志到指定郵件
log4j.appender.mail=org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold=FATAL
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From = xxx@mail.com
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= xxx@mail.com
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# 應用于數(shù)據(jù)庫
log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.database.URL=jdbc:mysql://localhost:3306/test
log4j.appender.database.driver=com.mysql.jdbc.Driver
log4j.appender.database.user=root
log4j.appender.database.password=
log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')
log4j.appender.database.layout=org.apache.log4j.PatternLayout
log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 自定義Appender
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = corlin@cybercorlin.net
log4j.appender.im.layout=org.apache.log4j.PatternLayout
log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

附: 輸出獨立日志文件

log4j的強大功能無可置疑，但實際應用中免不了遇到某個功能需要輸出獨立的日志文件的情況，怎樣才能把所需的內(nèi)容從原有日志中分離，形成單獨的日志文件呢？其實只要在現(xiàn)有的log4j基礎上稍加配置即可輕松實現(xiàn)這一功能。

常見

先看一個常見的log4j.properties文件，它是在控制臺和myweb.log文件中記錄日志：

log4j.rootLogger=DEBUG, stdout, logfile
 
log4j.category.org.springframework=ERROR
log4j.category.org.apache=INFO
 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n
 
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
log4j.appender.logfile.File=${myweb.root}/WEB-INF/log/myweb.log
log4j.appender.logfile.MaxFileSize=512KB
log4j.appender.logfile.MaxBackupIndex=5
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - %m%n

不同類輸出不同文件

如果想對不同的類輸出不同的文件(以cn.com.Test為例)，先要在Test.java中定義:

private static Log logger = LogFactory.getLog(Test.class);
　　然后在log4j.properties中加入:
log4j.logger.cn.com.Test= DEBUG, test
log4j.appender.test=org.apache.log4j.FileAppender
log4j.appender.test.File=${myweb.root}/WEB-INF/log/test.log
log4j.appender.test.layout=org.apache.log4j.PatternLayout
log4j.appender.test.layout.ConversionPattern=%d %p [%c] - %m%n
　　也就是讓cn.com.Test中的logger使用log4j.appender.test所做的配置。

同一類輸出多個日志文件

但是，如果在同一類中需要輸出多個日志文件呢？其實道理是一樣的，先在Test.java中定義:

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

然后在log4j.properties中加入:

log4j.logger.myTest1= DEBUG, test1
log4j.appender.test1=org.apache.log4j.FileAppender
log4j.appender.test1.File=${myweb.root}/WEB-INF/log/test1.log
log4j.appender.test1.layout=org.apache.log4j.PatternLayout
log4j.appender.test1.layout.ConversionPattern=%d %p [%c] - %m%n
　　
log4j.logger.myTest2= DEBUG, test2
log4j.appender.test2=org.apache.log4j.FileAppender
log4j.appender.test2.File=${myweb.root}/WEB-INF/log/test2.log
log4j.appender.test2.layout=org.apache.log4j.PatternLayout
log4j.appender.test2.layout.ConversionPattern=%d %p [%c] - %m%n
```　
  也就是在用logger時給它一個自定義的名字(如這里的"myTest1")，然后在log4j.properties中做出相應配置即可。別忘了不同日志要使用不同的logger(如輸出到test1.log的要用logger1.info("abc"))。

　　還有一個問題，就是這些自定義的**日志默認是同時輸出到log4j.rootLogger所配置的日志中的**，如何能只讓它們輸出到自己指定的日志中呢？別急，這里有個開關：

log4j.additivity.myTest1 = false

它用來設置是否同時輸出到log4j.rootLogger所配置的日志中，設為false就不會輸出到其它地方啦！注意這里的"myTest1"是你在程序中給logger起的那個自定義的名字！
如果你說，我只是不想同時輸出這個日志到log4j.rootLogger所配置的logfile中，stdout里我還想同時輸出呢！那也好辦，把你的log4j.logger.myTest1 = DEBUG, test1改為下式就OK啦！
log4j.logger.myTest1=DEBUG, test1
最后編輯于 ：
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容