概述
Log4j有三個主要的組件:Loggers(記錄器),Appenders (輸出源)和Layouts(佈局)。這裏可簡單理解爲日誌類別,日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個組件可以輕鬆地記錄信息的類型和級別,並可以在運行時控制日誌輸出的樣式和位置。
Logger
Loggers組件被分爲五個級別:
- DEBUG
- INFO
- WARN
- ERROR
- FATAL
各個級別的順序是這樣那個的:
DEBUG < INFO < WARN < ERROR < FATAL
可以簡單地理解爲級別越大越重要。
Log4j有一個規則:只輸出級別不低於設定級別的日誌信息,假設Loggers級別設定爲INFO,則INFO、WARN、ERROR和FATAL級別的日誌信息都會輸出,而級別比INFO低的DEBUG則不會輸出。
Appender
Appender用來規定日誌輸出的目的地是哪裏,可以是控制檯,文件,數據庫等等。
常見的Appender有以下幾種:
- 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
其中appenderName是Appender的名字,可以隨意起,只要滿足命名規範就行,Option1,Option2,…,OptionN是這個appender的各種屬性。
Layout
Layout用來規定日誌是以什麼樣的格式輸出,需要輸出哪些信息。Layout提供四種日誌輸出樣式,如根據HTML樣式、自由指定樣式、包含日誌級別與信息的樣式和包含日誌時間、線程、類別等信息的樣式。
常見的Layout如下:
- 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
含義和Appender的配置是一樣的,就不另作解釋了。
配置詳解
在實際應用中,要使Log4j在系統中運行須事先設定配置文件。配置文件事實上也就是對Logger、Appender及Layout進行相應設定。 Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是properties屬性文件。下面以properties屬性文件爲例介紹。
配置Logger
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
log4j.additivity.org.apache=false # 表示Logger不會在父Logger的appender裏輸出,默認爲true。
level :設定日誌記錄的最低級別,可設的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別,Log4j建議只使用中間四個級別。通過在這裏設定級別,您可以控制應用程序中相應級別的日誌信息的開關,比如在這裏設定了INFO級別,則應用程序中所有DEBUG級別的日誌信息將不會被打印出來。
appenderName:就是指定日誌信息要輸出到哪裏。可以同時指定多個輸出目的地,用逗號隔開。
例如:log4j.rootLogger=INFO,A1,B2,C3
配置Appender
log4j.appender.appenderName = className
appenderName: Appender的名字,自定義,在log4j.rootLogger設置中使用;
className:Appender的類的全名(包含包名),常用的Appender的className如下:
- org.apache.log4j.ConsoleAppender(控制檯)
- org.apache.log4j.FileAppender(文件)
- org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌文件)
- org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件)
- org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)
ConsoleAppender的選項
- Threshold=WARN:指定日誌信息的最低輸出級別,默認爲DEBUG。
- ImmediateFlush=true:表示所有消息都會被立即輸出,設爲false則不輸出,默認值是true。
- Target=System.err:默認值是System.out。
FileAppender選項
- Threshold=WARN:指定日誌信息的最低輸出級別,默認爲DEBUG。
- ImmediateFlush=true:表示所有消息都會被立即輸出,設爲false則不輸出,默認值是true。
- Append=false:true表示消息增加到指定文件中,false則將消息覆蓋指定的文件內容,默認值是true。
- File=D:/logs/logging.log4j:指定消息輸出到logging.log4j文件中
DailyRollingFileAppender選項
- 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。
另外,也可以指定按周、天、時、分等來滾動日誌文件,對應的格式如下:- ‘.’yyyy-MM:每月
- ‘.’yyyy-ww:每週
- ‘.’yyyy-MM-dd:每天
- ‘.’yyyy-MM-dd-a:每天兩次
- ‘.’yyyy-MM-dd-HH:每小時
- ‘.’yyyy-MM-dd-HH-mm:每分鐘
RollingFileAppender選項
- 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文件。
配置Layout
log4j.appender.appenderName.layout=className
常見的className如下:
- org.apache.log4j.HTMLLayout(以HTML表格形式佈局)
- org.apache.log4j.PatternLayout(可以靈活地指定佈局模式)
- org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字符串)
- org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息)
HTMLLayout選項
- LocationInfo=true:輸出java文件名稱和行號,默認值是false。
- Title=My Logging: 默認值是Log4J Log Messages。
PatternLayout選項
- 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這樣的多客戶多線程的應用中。
- %%:輸出一個”%”字符。
另外,還可以在%與格式字符之間加上修飾符來控制其最小長度、最大長度、和文本的對齊方式。如:
- c:指定輸出category的名稱,最小的長度是20,如果category的名稱長度小於20的話,默認的情況下右對齊。
- %-20c:”-“號表示左對齊。
- %.30c:指定輸出category的名稱,最大的長度是30,如果category的名稱長度大於30的話,就會將左邊多出的字符截掉,但小於30的話也不會補空格。
log4j的默認配置
log4j配置支持xml和properties兩種格式的文件,默認先在程序的classpath目錄下檢查是否有log4j.xml文件,如果沒有再出招log4j.properties文件。
log4j的包中的LogManager類在加載的時候有個靜態代碼塊是這樣寫的:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
static { // By default we use a DefaultRepositorySelector which always returns 'h'. Hierarchy h = new Hierarchy(new RootLogger((Level) Level.DEBUG)); repositorySelector = new DefaultRepositorySelector(h); /** Search for the properties file log4j.properties in the CLASSPATH. */ String override =OptionConverter.getSystemProperty(DEFAULT_INIT_OVERRIDE_KEY, null); // if there is no default init override, then get the resource // specified by the user or the default config file. if(override == null || "false".equalsIgnoreCase(override)) { String configurationOptionStr = OptionConverter.getSystemProperty( DEFAULT_CONFIGURATION_KEY, null); String configuratorClassName = OptionConverter.getSystemProperty( CONFIGURATOR_CLASS_KEY, null); URL url = null; // if the user has not specified the log4j.configuration // property, we search first for the file "log4j.xml" and then // "log4j.properties" if(configurationOptionStr == null) { url = Loader.getResource(DEFAULT_XML_CONFIGURATION_FILE); if(url == null) { url = Loader.getResource(DEFAULT_CONFIGURATION_FILE); } } else { try { url = new URL(configurationOptionStr); } catch (MalformedURLException ex) { // so, resource is not a URL: // attempt to get the resource from the class path url = Loader.getResource(configurationOptionStr); } } // If we have a non-null url, then delegate the rest of the // configuration to the OptionConverter.selectAndConfigure // method. if(url != null) { LogLog.debug("Using URL ["+url+"] for automatic log4j configuration."); OptionConverter.selectAndConfigure(url, configuratorClassName, LogManager.getLoggerRepository()); } else { LogLog.debug("Could not find resource: ["+configurationOptionStr+"]."); } } } |
轉自:點擊打開鏈接