log4j的配置文件詳細(xì)解析

2019-11-26 15:59:41

字體：大中小

供稿：網(wǎng)友

1.Log4j的優(yōu)點(diǎn)
Log4j是Apache的一個(gè)開放源代碼項(xiàng)目，通過使用Log4j，我們可以控制日志信息輸送地；我們也可以控制每一條日志的輸出格式；通過定義每一條日志信息的級(jí)別，我們能夠更加細(xì)致地控制日志的生成過程。最令人感興趣的就是，這些可以通過一個(gè)配置文件來靈活地進(jìn)行配置，而不需要修改應(yīng)用的代碼。

log4j的好處在于：
(1) 通過修改配置文件，就可以決定log信息的目的地――控制臺(tái)、文件、GUI組件、甚至是套接口服務(wù)器、NT的事件記錄器、UNIX Syslog守護(hù)進(jìn)程等。

(2) 通過修改配置文件，可以定義每一條日志信息的級(jí)別，從而控制是否輸出。在系統(tǒng)開發(fā)階段可以打印詳細(xì)的log信息以跟蹤系統(tǒng)運(yùn)行情況,而在系統(tǒng)穩(wěn)定后可以關(guān)閉log輸出,從而在能跟蹤系統(tǒng)運(yùn)行情況的同時(shí),又減少了垃圾代碼(System.out.println(......)等)。

(3) 使用log4j，需要整個(gè)系統(tǒng)有一個(gè)統(tǒng)一的log機(jī)制，有利于系統(tǒng)的規(guī)劃。

2.配置文件
Log4j由三個(gè)重要的組件構(gòu)成：日志信息的優(yōu)先級(jí)，日志信息的輸出目的地，日志信息的輸出格式。日志信息的優(yōu)先級(jí)從高到低有FATAL、ERROR、WARN、INFO、DEBUG、TRACE、ALL，分別用來指定這條日志信息的重要程度；日志信息的輸出目的地指定了日志將打印到控制臺(tái)還是文件中；而輸出格式則控制了日志信息的顯示內(nèi)容。

2.1 日志信息的優(yōu)先級(jí)
Log4j建議只使用四個(gè)級(jí)別，優(yōu)先級(jí)從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級(jí)別，您可以控制到應(yīng)用程序中相應(yīng)級(jí)別的日志信息的開關(guān)。如在這里定義了INFO級(jí)別，則應(yīng)用程序中所有低于INFO級(jí)別的日志信息將不被打印出來。

2.2 輸出源的使用
有選擇的能用或者禁用日志請(qǐng)求僅僅是Log4j的一部分功能。Log4j允許日志請(qǐng)求被輸出到多個(gè)輸出源。用Log4j的話說，一個(gè)輸出源被稱做一個(gè)Appender。

Appender包括console（控制臺(tái)）, files（文件）, GUI components（圖形的組件）, remote socket servers（socket 服務(wù)）, JMS（java信息服務(wù)）, NT Event Loggers（NT的事件日志）, remote UNIX Syslog daemons（遠(yuǎn)程UNIX的后臺(tái)日志服務(wù)）。它也可以做到異步記錄。一個(gè)logger可以設(shè)置超過一個(gè)的appender。用addAppender方法添加一個(gè)appender到一個(gè)給定的logger。對(duì)于一個(gè)給定的logger它每個(gè)生效的日志請(qǐng)求都被轉(zhuǎn)發(fā)到該logger所有的appender上和該logger的父輩 logger的appender上。

2.2.1 ConsoleAppender
如果使用ConsoleAppender，那么log信息將寫到Console。效果等同于直接把信息打印到System.out上了。

2.2.2 FileAppender
使用FileAppender，那么log信息將寫到指定的文件中。這應(yīng)該是比較經(jīng)常使用到的情況。相應(yīng)地，在配置文件中應(yīng)該指定log輸出的文件名。如下配置指定了log文件名為log.txt。

log4j.appender.appendername.File=log.txt 注意將appendername替換為具體配置中Appender的別名。

注意：指定的log文件路徑問題

2.2.3 DailyRollingAppender
使用FileAppender可以將log信息輸出到文件中，但是如果文件太大了讀起來就不方便了。這時(shí)就可以使用DailyRollingAppender。DailyRollingAppender可以把Log信息輸出到按照日期來區(qū)分的文件中。配置文件就會(huì)每天（時(shí)間可以設(shè)定）產(chǎn)生一個(gè)log文件，每個(gè)log文件只記錄當(dāng)天的log信息：

復(fù)制代碼代碼如下:

log4j.appender.appendername=org.apache.log4j.DailyRollingFileAppender  
log4j.appender.Aappendername.file=log  
log4j.appender.appendername.DatePattern='.'yyyy-MM-dd  
log4j.appender.appendername.layout=org.apache.log4j.PatternLayout  
log4j.appender.appendername.layout.ConversionPattern= %5r %-5p %c{2} - %m%n 

2.2.4 RollingFileAppender
文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件。

復(fù)制代碼代碼如下:

og4j.appender.appendername=org.apache.log4j.RollingFileAppender
log4j.appender.appendername.File= ../logs/rlog.log
# Control the maximum log file size
log4j.appender.appendername.MaxFileSize=100KB
# Archive log files (one backup file here)
log4j.appender.appendername.MaxBackupIndex=1

log4j.appender.appendername.layout=org.apache.log4j.PatternLayout
log4j.appender.appendername.layout.ConversionPattern=%p %t %c - %m%n

這個(gè)配置文件指定了輸出源appendername，是一個(gè)輪轉(zhuǎn)日志文件。最大的文件是100KB，當(dāng)一個(gè)日志文件達(dá)到最大尺寸時(shí)，Log4J會(huì)自動(dòng)把rlog.log重命名為rlog.log.1，然后重建一個(gè)新的rlog.log文件，依次輪轉(zhuǎn)。

2.2.5 WriterAppender
將日志信息以流格式發(fā)送到任意指定的地方。

2.3 Layout的配置
Layout指定了log信息輸出的樣式。

2.3.1 布局樣式

復(fù)制代碼代碼如下:

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

2.3.2 格式

復(fù)制代碼代碼如下:

%m 輸出代碼中指定的消息  
%p 輸出優(yōu)先級(jí)，即DEBUG，INFO，WARN，ERROR，F(xiàn)ATAL  
%r 輸出自應(yīng)用啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)  
%c 輸出所屬的類目，通常就是所在類的全名  
%t 輸出產(chǎn)生該日志事件的線程名  
%n 輸出一個(gè)回車換行符，Windows平臺(tái)為"rn"，Unix平臺(tái)為"n"  
%d 輸出日志時(shí)間點(diǎn)的日期或時(shí)間，默認(rèn)格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921  
%l 輸出日志事件的發(fā)生位置，包括類目名、發(fā)生的線程，以及在代碼中的行數(shù)。舉例：Testlog4.main(Test Log4.java:10) 

3.為不同的Appender設(shè)置日志輸出級(jí)別
通過在配置中修改Appender的Threshold即能實(shí)現(xiàn)，比如下面的例子：

配置文件：
log4j.rootLogger = debug,A,B,C

# 輸出到控制臺(tái)
log4j.appender.A = org.apache.log4j.ConsoleAppender
log4j.appender.A.Target = System.out
log4j.appender.A.layout = org.apache.log4j.PatternLayout
log4j.appender.A.layout.ConversionPattern = %p %t %c - %m%n

# 輸出到日志文件
log4j.appender.B = org.apache.log4j.DailyRollingFileAppender
log4j.appender.B.File = logs/log.log
log4j.appender.B.Append = true
log4j.appender.B.Threshold = DEBUG # 輸出EBUG級(jí)別以上的日志
log4j.appender.B.layout = org.apache.log4j.PatternLayout
log4j.appender.B.layout.ConversionPattern = %p %t %c - %m%n

# 保存異常信息到單獨(dú)文件
log4j.appender.C = org.apache.log4j.DailyRollingFileAppender
log4j.appender.C.File = logs/error.log # 異常日志文件名
log4j.appender.C.Append = true
log4j.appender.C.Threshold = ERROR #只輸出ERROR級(jí)別以上的日志
log4j.appender.C.layout = org.apache.log4j.PatternLayout
log4j.appender.C.layout.ConversionPattern = %p %t %c - %m%n

例子：

復(fù)制代碼代碼如下:

public class TestLog4j
{
    public static void main(String[] args)
    {
        PropertyConfigurator.configure("D:/Code/conf/log4j.properties");
        Logger logger = Logger.getLogger(TestLog4j.class);
        logger.debug("debug");
        logger.error("error");   
    }
}