log4j.xml簡單配置樣例說明
一:測試環境與log4j(一)——為什麼要使用log4j?一樣,這裡不再重述
二:老規矩,先來個栗子,然後再聊聊感受
(1)這裡栗子有一點特別呀!給出了包名唉!想必有用,是的,配置檔案中要特別說明一下的
package test.log4j.test8; import org.apache.log4j.LogManager; import org.apache.log4j.Logger; import org.apache.log4j.xml.DOMConfigurator; /** * Created by godtrue */ public class UseLog4j { //日誌記錄器 private static Logger LOGGER = LogManager.getLogger(UseLog4j.class); //程式入口——主函式 public static void main(String[]args) { //讀取使用Java的特性檔案編寫的配置檔案 DOMConfigurator.configure( "D:\\workspace_test\\hello-log4j\\log4j.xml" ); //輸出日誌資訊,測試日誌級別的作用(配置在配置檔案中),僅僅輸出大於等於目前有效級別的日誌資訊 LOGGER.debug("[1]-my level is DEBUG 天"); LOGGER.info("[2]-my level is INFO"); LOGGER.warn("[3]-my level is WARN"); LOGGER.error("[4]-my level is ERROR"); } }
(2)這段程式碼和(1)除了類名多了一個 _ ,並沒有什麼區別,那有什麼用那?恩,有用的,一切為了測試,不信,你自己試試就更清楚了
package test.log4j.test8; import org.apache.log4j.LogManager; import org.apache.log4j.Logger; import org.apache.log4j.xml.DOMConfigurator; /** * Created by godtrue */ public class UseLog4j_ { //日誌記錄器 private static Logger LOGGER = LogManager.getLogger(UseLog4j_.class); //程式入口——主函式 public static void main(String[]args) { //讀取使用Java的特性檔案編寫的配置檔案 DOMConfigurator.configure( "D:\\workspace_test\\hello-log4j\\log4j.xml" ); //輸出日誌資訊,測試日誌級別的作用(配置在配置檔案中),僅僅輸出大於等於目前有效級別的日誌資訊 LOGGER.debug("[1]-my level is DEBUG 天"); LOGGER.info("[2]-my level is INFO"); LOGGER.warn("[3]-my level is WARN"); LOGGER.error("[4]-my level is ERROR"); } }
(3)如下的配置檔案,僅列出了三種檔案輸出目的地的配置,他們相對比較常用,其中值得特別注意的是記錄器的 name 和 additivity 這兩個屬性的作用,詳情往下看註解,最好自己試試
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration> <!-- 將日誌資訊輸出到控制檯 --> <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender"> <!-- 設定日誌輸出的樣式 --> <layout class="org.apache.log4j.PatternLayout"> <!-- 設定日誌輸出的格式 --> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" /> </layout> <!--過濾器設定輸出的級別--> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <!-- 設定日誌輸出的最小級別 --> <param name="levelMin" value="WARN" /> <!-- 設定日誌輸出的最大級別 --> <param name="levelMax" value="ERROR" /> <!-- 設定日誌輸出的xxx,預設是false --> <param name="AcceptOnMatch" value="true" /> </filter> </appender> <!-- 將日誌資訊輸出到檔案,但是當檔案的大小達到某個閾值的時候,日誌檔案會自動回滾 --> <appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender"> <!-- 設定日誌資訊輸出檔案全路徑名 --> <param name="File" value="D:/log4j/RollingFileAppender.log" /> <!-- 設定是否在重新啟動服務時,在原有日誌的基礎新增新日誌 --> <param name="Append" value="true" /> <!-- 設定儲存備份回滾日誌的最大個數 --> <param name="MaxBackupIndex" value="10" /> <!-- 設定當日志文件達到此閾值的時候自動回滾,單位可以是KB,MB,GB,預設單位是KB --> <param name="MaxFileSize" value="10KB" /> <!-- 設定日誌輸出的樣式 --> <layout class="org.apache.log4j.PatternLayout"> <!-- 設定日誌輸出的格式 --> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" /> </layout> </appender> <!-- 將日誌資訊輸出到檔案,可以配置多久產生一個新的日誌資訊檔案 --> <appender name="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender"> <!-- 設定日誌資訊輸出檔案全路徑名 --> <param name="File" value="D:/log4j/DailyRollingFileAppender.log" /> <!-- 設定日誌每分鐘回滾一次,即產生一個新的日誌檔案 --> <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" /> <!-- 設定日誌輸出的樣式 --> <layout class="org.apache.log4j.PatternLayout"> <!-- 設定日誌輸出的格式 --> <param name="ConversionPattern" value="[%d{yyyy-MM-dd HH:mm:ss:SSS}] [%-5p] [method:%l]%n%m%n%n" /> </layout> </appender> <!-- 注意: 1:當additivity="false"時,root中的配置就失靈了,不遵循預設的繼承機制 2:logger中的name非常重要,它代表記錄器的包的形式,有一定的包含關係,試驗表明 2-1:當定義的logger的name同名時,只有最後的那一個才能正確的列印日誌 2-2:當對應的logger含有包含關係時,比如:name=test.log4j.test8 和 name=test.log4j.test8.UseLog4j,則2-1的情況是一樣的 2-3:logger的name表示所有的包含在此名的所有記錄器都遵循同樣的配置,name的值中的包含關係是指記錄器的名稱喲!注意啦! 3:logger中定義的level和appender中的filter定義的level的區間取交集 4:如果appender中的filter定義的 levelMin > levelMax ,則打印不出日誌資訊 --> <!-- 指定logger的設定,additivity指示是否遵循預設的繼承機制--> <logger name="test.log4j.test8.UseLog4j" additivity="false"> <level value ="WARN"/> <appender-ref ref="DailyRollingFileAppender"/> </logger> <!--指定logger的設定,additivity指示是否遵循預設的繼承機制 --> <logger name="test.log4j.test8.UseLog4j_" additivity="false"> <level value ="ERROR"/> <appender-ref ref="RollingFileAppender"/> </logger> <!-- 根logger的設定--> <root> <level value ="INFO"/> <appender-ref ref="ConsoleAppender"/> <!--<appender-ref ref="DailyRollingFileAppender"/>--> </root> </log4j:configuration
三:感受
1)我們現在實際的專案使用的是log4j2,相應的配置方式和這裡有所不同,抽時間我再好好玩一下
2)如果整個log4j日誌框架,按照比較平滑的學習曲線來學習的話,還是非常簡單的,以前學習過,不過不做筆記就是學習一下,時間一長容易忘記各項配置都是幹啥的,所以,在裡再補上一筆,寫部落格的好處就體現出來了,等忘記了回頭再看看,也許記憶就恢復了,謝謝部落格園提供的遊戲場所。——世界是個遊樂場,我們都是上帝的孩子。
3)程式設計這一行,我覺得應該重複的造輪子,特別是在學習某項技術的時候,網上關於log4j的博文也挺多的,剛開始我也找了一些來看,不過發現不好玩,不是自己的東西理解起來費勁不說,好多一實驗還不靈,當然,有好多也是相當不錯的,是經過試驗的,不過不夠詳細。總之,好的要學習,而學習的最好途徑還是自己多思考,多動手試驗試驗。
四:寫這些部落格我曾詳細的看過一下資源(非常感謝,在此謝過!)
log4j.properties配置詳解與例項-全部測試通過
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Xml程式碼
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' >
<appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="[%d{dd HH:mm:ss,SSS\} %-5p] [%t] %c{2\} - %m%n" />
</layout>
<!--過濾器設定輸出的級別-->
<filter class="org.apache.log4j.varia.LevelRangeFilter">
<param name="levelMin" value="debug" />
<param name="levelMax" value="warn" />
<param name="AcceptOnMatch" value="true" />
</filter>
</appender>
<appender name="myFile" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="D:/output.log" /><!-- 設定日誌輸出檔名 -->
<!-- 設定是否在重新啟動服務時,在原有日誌的基礎新增新日誌 -->
<param name="Append" value="true" />
<param name="MaxBackupIndex" value="10" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%p (%c:%L)- %m%n" />
</layout>
</appender>
<appender name="activexAppender" class="org.apache.log4j.DailyRollingFileAppender">
<param name="File" value="E:/activex.log" />
<param name="DatePattern" value="'.'yyyy-MM-dd'.log'" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern"
value="[%d{MMdd HH:mm:ss SSS\} %-5p] [%t] %c{3\} - %m%n" />
</layout>
</appender>
<!-- 指定logger的設定,additivity指示是否遵循預設的繼承機制-->
<logger name="com.runway.bssp.activeXdemo" additivity="false">
<priority value ="info"/>
<appender-ref ref="activexAppender" />
</logger>
<!-- 根logger的設定-->
<root>
<priority value ="debug"/>
<appender-ref ref="myConsole"/>
<appender-ref ref="myFile"/>
</root>
</log4j:configuration>
(1). 輸出方式appender一般有5種:
org.apache.log4j.RollingFileAppender(滾動檔案,自動記錄最新日誌)
org.apache.log4j.ConsoleAppender (控制檯)
org.apache.log4j.FileAppender (檔案)
org.apache.log4j.DailyRollingFileAppender (每天產生一個日誌檔案)
org.apache.log4j.WriterAppender (將日誌資訊以流格式傳送到任意指定的地方)
(2). 日記記錄的優先順序priority,優先順序由高到低分為
OFF ,FATAL ,ERROR ,WARN ,INFO ,DEBUG ,ALL。
Log4j建議只使用FATAL ,ERROR ,WARN ,INFO ,DEBUG這五個級別。
(3). 格式說明layout中的引數都以%開始,後面不同的引數代表不同的格式化資訊(引數按字母表順序列出):
%c 輸出所屬類的全名,可在修改為 %d{Num} ,Num類名輸出的維(如:"org.apache.elathen.ClassName",%C{2}將輸出elathen.ClassName)
%d 輸出日誌時間其格式為 %d{yyyy-MM-dd HH:mm:ss,SSS},可指定格式 如 %d{HH:mm:ss}
%l 輸出日誌事件發生位置,包括類目名、發生執行緒,在程式碼中的行數
%n 換行符
%m 輸出程式碼指定資訊,如info(“message”),輸出message
%p 輸出優先順序,即 FATAL ,ERROR 等
%r 輸出從啟動到顯示該log資訊所耗費的毫秒數
%t 輸出產生該日誌事件的執行緒名
xml declaration and DTD
xml配置檔案的頭部包括兩個部分:xml宣告和DTD宣告。頭部的格式如下:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
log4j:configuration (root element)
- xmlns:log4j [#FIXED attribute] : 定義log4j的名字空間,取定值"http://jakarta.apache.org/log4j/"
- appender [* child] : 一個appender子元素定義一個日誌輸出目的地
- logger [* child] : 一個logger子元素定義一個日誌寫出器
- root [? child] : root子元素定義了root logger
appender
appender元素定義一個日誌輸出目的地。
- name [#REQUIRED attribute] : 定義appender的名字,以便被後文引用
- class [#REQUIRED attribute] : 定義appender物件所屬的類的全名
- param [* child] : 建立appender物件時傳遞給類構造方法的引數
- layout [? child] : 該appender使用的layout物件
layout
layout元素定義與某一個appender相聯絡的日誌格式化器。
- class [#REQUIRED attribute] : 定義layout物件所屬的類的全名
- param [* child] : 建立layout物件時傳遞給類構造方法的引數
logger
logger元素定義一個日誌輸出器。
- name [#REQUIRED attribute] : 定義logger的名字,以便被後文引用
- additivity [#ENUM attribute] : 取值為"true"(預設)或者"false",是否繼承父logger的屬性
- level [? child] : 定義該logger的日誌級別
- appender-ref [* child] : 定義該logger的輸出目的地
root
root元素定義根日誌輸出器root logger。
- param [* child] : 建立root logger物件時傳遞給類構造方法的引數
- level [? child] : 定義root logger的日誌級別
- appender-ref [* child] : 定義root logger的輸出目的地
level
level元素定義logger物件的日誌級別。
- class [#IMPLIED attribute] : 定義level物件所屬的類,預設情況下是"org.apache.log4j.Level類
- value [#REQUIRED attribute] : 為level物件賦值。可能的取值從小到大依次為"all"、"debug"、"info"、"warn"、"error"、"fatal"和"off"。當值為"off"時表示沒有任何日誌資訊被輸出
- param [* child] : 建立level物件時傳遞給類構造方法的引數
appender-ref
appender-ref元素引用一個appender元素的名字,為logger物件增加一個appender。
- ref [#REQUIRED attribute] : 一個appender元素的名字的引用
- appender-ref元素沒有子元素
param
param元素在建立物件時為類的構造方法提供引數。它可以成為appender、layout、filter、errorHandler、level、categoryFactory和root等元素的子元素。
- name and value [#REQUIRED attributes] : 提供引數的一組名值對
- param元素沒有子元素
在xml檔案中配置appender和layout
建立不同的Appender物件或者不同的Layout物件要呼叫不同的構造方法。可以使用param子元素來設定不同的引數值。
建立ConsoleAppender物件
ConsoleAppender的構造方法不接受其它的引數。
... ... ... ...
<appender name="console.log" class="org.apache.log4j.ConsoleAppender">
<layout ... >
... ...
</layout>
</appender>
... ... ... ...
建立FileAppender物件
可以為FileAppender類的構造方法傳遞兩個引數:File表示日誌檔名;Append表示如檔案已存在,是否把日誌追加到檔案尾部,可能取值為"true"和"false"(預設)。
... ... ... ...
<appender name="file.log" class="org.apache.log4j.FileAppender">
<param name="File" value="/tmp/log.txt" />
<param name="Append" value="false" />
<layout ... >
... ...
</layout>
</appender>
... ... ... ...
建立RollingFileAppender物件
除了File和Append以外,還可以為RollingFileAppender類的構造方法傳遞兩個引數:MaxBackupIndex備份日誌檔案的個數(預設是1個);MaxFileSize表示日誌檔案允許的最大位元組數(預設是10M)。
... ... ... ...
<appender name="rollingFile.log" class="org.apache.log4j.RollingFileAppender">
<param name="File" value="/tmp/rollingLog.txt" />
<param name="Append" value="false" />
<param name="MaxBackupIndex" value="2" />
<param name="MaxFileSize" value="1024" />
<layout ... >
... ...
</layout>
</appender>
... ... ... ...
建立PatternLayout物件
可以為PatternLayout類的構造方法傳遞引數ConversionPattern。
... ... ... ...
<layout class="org.apache.log4j.PatternLayout> <param name="Conversion" value="%d [%t] %p - %m%n" />
</layout>
... ... ... ...
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1 簡介
一般log4j的xml配置方式基本步驟有3個,第一步:配置appender;第二步:配置logger;第三步:配置root。下面配置一個ConsoleAppender和兩個DailyRollingFileAppender為例具體展開。
1.1 日誌級別
不考慮其他因素,日記級別FATAL>ERROR>WARN>INFO>DEBUG,這個是許多同學都清楚的,但是結合appender,logger,root的配置後,日誌列印的結果會發生一些微妙的變化。
首先,root的中的日誌級別在使用者沒有為某一個具體的logger配置日誌級別的時候才會對該logger生效。這裡就可以用來解釋有的同學問為什麼在root中配置了ERROR級別,但是日誌中依舊有INFO的日誌輸出。
其次,如果某一個appender配置了日誌過濾器,那使用該appender的logger配置日誌級別的時候,範圍不超出appender過濾的級別資訊才會被輸出。
2 配置appender
圖2-1是一個標準的ConsoleAppender配置:
圖 2‑1
如註釋所描述,ConsoleAppender一般在我們除錯專案時候用處比較大,這裡不再多餘描述。
圖2-2是一個標準的FileAppender配置,這裡我配置了一個info.log檔案和一個eror.log,位於/opt/logs目錄下面,分別用來記錄一般訊息和錯誤訊息。
圖 2‑2
appender的配置相對比較簡單,除了過濾器,沒有特殊要注意的。
3 配置logger
圖3-1是兩種looger配置。
圖 3‑1
logger的name屬性指代的是程式包路徑,不用贅述。additivity屬性,表示是否遵循預設的繼承機制。
需要注意:
1如果我們配置了true,那我們最好不要再給該logger配置appender-ref屬性,除非被配置的appender-ref我們沒有繼續新增在root的appender-ref中,否則我們會發現日誌重複。
2如果我們配置了false,那就必須為該logger配置appender-ref,否則日誌不會被列印。
4 配置root
圖4-1是一個標準的root配置。
圖 4‑1
root的作用是是收集所有配置的logger(additivity=true)反饋上來的資訊流並且根據root中配置的appender-ref進行輸出,所以,如果我們logger配置了additivity=true,又配置了appender-ref,會導致日誌重複。
注意:這裡的level值對那些沒有配置日誌級別,而且additivity=true的logger才會有作用。
下面是具體的配置資訊:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/' >
<!--對於ConsoleAppender來說,在開發階段還是比較有用的,能直接在ide中看到輸出的日誌內容,
但是在實際的產品階段,我們更希望將日誌輸出到指定的檔案上檢視,這就需要用到FileAppender-->
<appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
<param name="encoding" value="UTF-8" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %t %l %m%n" />
</layout>
<!--如果有過濾器,當前appender只會處理滿足過濾器條件的日誌資訊-->
<!--<filter class="org.apache.log4j.varia.LevelRangeFilter">
<param name="levelMin" value="DEBUG" />
<param name="levelMax" value="FATAL" />
<param name="AcceptOnMatch" value="true" />
</filter>-->
</appender>
<!-- 寫到遠端日誌 -->
<appender name="DEFAULT-APPENDER-REMOTE" class="org.apache.log4j.net.SyslogAppender">
<param name="SyslogHost" value="${logServer}"/>
<param name="Facility" value="LOCAL1"/>
<param name="FacilityPrinting" value="true"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %t %c %m%n" />
</layout>
</appender>
<appender name="FRAMEWORK-APPENDER-REMOTE" class="org.apache.log4j.net.SyslogAppender">
<param name="SyslogHost" value="${logServer}"/>
<param name="Facility" value="LOCAL3"/>
<param name="FacilityPrinting" value="true"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %t %c %m%n" />
</layout>
</appender>
<!-- 寫到本地日誌 -->
<!--第一步:配置appender-->
<appender name="INFO-LOCAL" class="org.apache.log4j.DailyRollingFileAppender">
<param name="file" value="/opt/logs/info.log" />
<param name="append" value="true" /><!--一般必須配置true,否則會覆蓋而不是累加-->
<param name="encoding" value="UTF-8" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %t %l %m%n" />
</layout>
<!--如果有過濾器,日誌檔案中就只會有符合過濾器的日誌資訊-->
<filter class="org.apache.log4j.varia.LevelRangeFilter">
<param name="levelMin" value="DEBUG" />
<param name="levelMax" value="INFO" />
<param name="AcceptOnMatch" value="true" />
</filter>
</appender>
<appender name="ERROR-LOCAL" class="org.apache.log4j.DailyRollingFileAppender">
<param name="file" value="/opt/logs/error.log" />
<param name="append" value="true" /><!--一般必須配置true,否則會覆蓋而不是累加-->
<param name="encoding" value="UTF-8" />
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p %t %l %m%n" />
</layout>
<!--如果有過濾器,日誌檔案中就只會有符合過濾器的日誌資訊-->
<filter class="org.apache.log4j.varia.LevelRangeFilter">
<param name="levelMin" value="WARN" />
<param name="levelMax" value="FATAL" />
<param name="AcceptOnMatch" value="true" />
</filter>
</appender>
<!--第二步:配置logger。
如果不配置,系統會採用預設策略,即additivity="true",level value="DEBUG"。
注意:additivity=true,表示遵循預設的繼承機制,此時就不應該繼續配置appender-ref,否則日誌會出現重複
相反,如果additivity=false,就必須要配置appender-ref,否則日誌不會被列印,配置也就沒有意義-->
<logger name="com.test.log4j" additivity="true">
<!--給具體的logger配置日誌級別,比如com.test包下面日誌級別大於等於DEBUG的,
才會交給appender進行處理。
注意:對於com.test包而言,此處的級別會覆蓋root下面的日誌級別-->
<level value="INFO" />
<!--如果此處配置了append-ref,而且additivity="true",將會和root裡面的同一個
append-ref形成累加,即重複日誌-->
<!--<appender-ref ref="CONSOLE" />-->
<!--<appender-ref ref="DEFAULT-LOCAL"/>-->
<!--<appender-ref ref="ERROR-LOCAL"/>-->
</logger>
<logger name="com.test2" additivity="false">
<level value="INFO" />
<appender-ref ref="INFO-LOCAL" />
</logger>
<!--第三步:配置root-->
<!--root的作用是收集所有配置的logger反饋上來的資訊流並根據配置在root中appender進行輸出,
只要你在looger中配置了additivity="false",就不會反饋到root中。-->
<root>
<!--優先順序小於具體的logger中配置的級別,只有當具體的logger沒有配置的時候,
這裡才會對具體的looger起作用-->
<level value="DEBUG" />
<appender-ref ref="CONSOLE" />
<appender-ref ref="INFO-LOCAL" />
<appender-ref ref="ERROR-LOCAL"/>
</root>
</log4j:configuration>
---------------------
原文:https://blog.csdn.net/jingyuwang1/article/details/49430233