- 先說下我的需求
1,可以記錄日記在我們的java開發項目周期中;
2,很簡單即可輸出日志;
3,每天按照時間將不同的日志輸出到不同的文件中,每天輸出日志到一個帶有當前時間戳的文件中;
4,可以修改當前輸出日志的文件名,文件名后綴是當前的日期,而不需要等待log4j的項目到第二天這個文件名才能生成帶有時間戳的文件;
6,按不同的日志等級輸出日志到不同的文件中,例如error文件中只有輸出的log級別為error的日志,info級別的日志只輸出到info文件(所以這里需要用的是log4j的xml配置文件而不是使用log4j.properties文件)
先說下log4j的幾種log級別的等級:
日志記錄器(Logger)的行為是分等級的。如下表所示:
分 為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別,這些級別是從高到低的級別。Log4j建議只使用四個級別,優先級從高到低分別是 ERROR、WARN、INFO、DEBUG。通過在這里定義的級別,您可以控制到應用程序中相應級別的日志信息的開關。比如在這里定義了INFO級別, 則應用程序中所有DEBUG級別的日志信息將不被打印出來
優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級別,您可以控制到應用程序中相應級別的日志信息的開關。比如在這里定義了INFO級別,則應用程序中所有DEBUG級別的日志信息將不被打印出來。程序會打印高於或等於所設置級別的日志,設置的日志等級越高,打印出來的日志就越少。如果設置級別為INFO,則優先級高於等於INFO級別(如:INFO、WARN、ERROR)的日志信息將可以被輸出,小於該級別的如DEBUG將不會被輸出。
所以從上面來說我們最好設置的日志級別為INFO ,或者是DEBUG級別。推薦使用DEBUG級別,可以顯示所有的日志。
- 需要准備的jar包
- log4j.jar 包,可以直接在官方下載到:http://logging.apache.org/log4j/1.2/download.html
- log4j-extr包,主要是立即生成自定義的文件名(原始的log4j生成的文件后綴名只能在第二天名稱才會變)
http://mvnrepository.com/artifact/log4j/apache-log4j-extras(之所以選擇這個地址是因為原始的log4j extra的URL http://www.apache.org/dyn/closer.cgi/logging/log4j/companions/extras/1.1/apache-log4j-extras-1.1.zip 下載地址現在都失效了,不曉得是不是被牆了???)
下面的xml文件中的這行代碼就是用到了log4j-extra中的類,千萬主要了如果沒有將這個jar加入到當前項目的classpath中,下面的這行代碼運行的時候會報錯的:
<appender name="log4jDebug" class="org.apache.log4j.rolling.RollingFileAppender"> <!-- 這里的class="org.apache.log4j.rolling.RollingFileAppender",而沒有使用log4j的原始的:class="org.apache.log4j.DailyRollingFileAppender" --> <param name="Append" value="true"/> <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy"> <param name="FileNamePattern" value="./log/log_%d{yyyy-MM-dd}.log" /> </rollingPolicy>
將上面的兩個jar文件放到項目的classpath中,如下:
配置文件
只需要一個配置文件我們這里就可以使用log4j的所以的功能,是不是很簡單,所以主要的重心就是放在log4j配置文件上。但是如果是使用的是log4j的properties文件,它輸出的日志記錄可能不是你需要的,就想上面提到的日志級別,如果使用properties文件,那么所有的error和warn級別的日志都會輸出到INFO級別的日志中,如果我們這里設置log的級別為info的話。
所以這樣的話,一個文件中可能有info級別的,error級別的,warn級別的,里面還是很混亂的,很難快速查找定位對應級別的日志。
log4j提出了一個方案就是使用xml配置文件起配置log4j這樣就可以使用不同的log4j級別輸出不同的文件中。
以下是一個log4j的xml文件配置詳情,可以滿足以上所有的需求(如果需要的話你還可以定制其中的日志輸出路徑等等,另外說下,經自己試驗,發現log4j是可以使用相對路徑來輸出對應的log日志文件的,並不像有的人說的不能使用相對路徑只能使用絕對路徑,這個是錯的,我這里下面使用的就是相對路徑,是相對當前的項目路徑)。
使用的時候不管是properties文件或者是xml配置文件,最好一定要放在項目根目錄下面,就是項目中跟src目錄同級別里面。
log4j.xml配置文件源代碼如下:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd"> <log4j:configuration debug="true" xmlns:log4j='http://jakarta.apache.org/log4j/' > <!-- ========================== 自定義輸出格式說明================================ --> <!-- %p 輸出優先級,即DEBUG,INFO,WARN,ERROR,FATAL --> <!-- %r 輸出自應用啟動到輸出該log信息耗費的毫秒數 --> <!-- %c 輸出所屬的類目,通常就是所在類的全名 --> <!-- %t 輸出產生該日志事件的線程名 --> <!-- %n 輸出一個回車換行符,Windows平台為“/r/n”,Unix平台為“/n” --> <!-- %d 輸出日志時間點的日期或時間,默認格式為ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類似:2002年10月18日 22:10:28,921 --> <!-- %l 輸出日志事件的發生位置,包括類目名、發生的線程,以及在代碼中的行數。舉例:Testlo4.main(TestLog4.java:10) --> <!-- ========================================================================== --> <!-- ========================== 輸出方式說明================================ --> <!-- Log4j提供的appender有以下幾種: --> <!-- org.apache.log4j.ConsoleAppender(控制台), --> <!-- org.apache.log4j.FileAppender(文件), --> <!-- org.apache.log4j.DailyRollingFileAppender(每天產生一個日志文件), --> <!-- org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件), --> <!-- org.apache.log4j.WriterAppender(將日志信息以流格式發送到任意指定的地方) --> <!-- ========================================================================== --> <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender"> <!-- <param name="Target" value="System.out"/> --> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c Method: %l ]%n%p:%m%n"/> </layout> <!-- <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="LevelMin" value="DEBUG"/> <param name="LevelMax" value="DEBUG"/> </filter> --> </appender> <!-- output the debug --> <!-- <appender name="log4jDebug" class="org.apache.log4j.DailyRollingFileAppender"> <param name="File" value="log_"/> <param name="MaxFileSize" value="KB"/> <param name="MaxBackupIndex" value="2"/> --> <appender name="log4jDebug" class="org.apache.log4j.rolling.RollingFileAppender"> <param name="Append" value="true"/> <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy"> <param name="FileNamePattern" value="./log/log_%d{yyyy-MM-dd}.log" /> </rollingPolicy> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c Method: %l ]%n%p:%m%n"/> </layout> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="LevelMin" value="DEBUG"/> <param name="LevelMax" value="DEBUG"/> </filter> </appender> <!-- <appender name="log4jInfo" class="org.apache.log4j.DailyRollingFileAppender"> <param name="File" value="log_"/> <param name="DatePattern" value="'.log'yyyy-MM-dd"/> <param name="Append" value="true"/> <param name="MaxFileSize" value="5KB"/> <param name="MaxBackupIndex" value="2"/> --> <appender name="log4jInfo" class="org.apache.log4j.rolling.RollingFileAppender"> <param name="Append" value="true"/> <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy"> <param name="FileNamePattern" value="./log/log_%d{yyyy-MM-dd}.log" /> </rollingPolicy> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c Method: %l ]%n%p:%m%n"/> </layout> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="LevelMin" value="INFO"/> <param name="LevelMax" value="INFO"/> </filter> </appender> <!-- <appender name="log4jWarn" class="org.apache.log4j.DailyRollingFileAppender"> <param name="File" value="/log_"/> <param name="DatePattern" value="'.log'yyyy-MM-dd"/> <param name="Append" value="true"/> <param name="MaxFileSize" value="5KB"/> <param name="MaxBackupIndex" value="2"/> --> <appender name="log4jWarn" class="org.apache.log4j.rolling.RollingFileAppender"> <param name="Append" value="true"/> <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy"> <param name="FileNamePattern" value="./log/log_%d{yyyy-MM-dd}.log" /> </rollingPolicy> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c Method: %l ]%n%p:%m%n"/> </layout> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="LevelMin" value="WARN"/> <param name="LevelMax" value="WARN"/> </filter> </appender> <!-- <appender name="log4jError" class="org.apache.log4j.DailyRollingFileAppender"> --> <appender name="log4jError" class="org.apache.log4j.rolling.RollingFileAppender"> <!-- <param name="File" value="/error_"/> <param name="DatePattern" value="'.log'yyyy-MM-dd"/> --> <param name="Append" value="true"/> <rollingPolicy class="org.apache.log4j.rolling.TimeBasedRollingPolicy"> <param name="FileNamePattern" value="./log/error_%d{yyyy-MM-dd}.log" /> </rollingPolicy> <!-- <param name="MaxFileSize" value="5KB"/> --> <!-- <param name="MaxBackupIndex" value="2"/> --> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c Method: %l ]%n%p:%m%n"/> </layout> <filter class="org.apache.log4j.varia.LevelRangeFilter"> <param name="LevelMin" value="ERROR"/> <param name="LevelMax" value="ERROR"/> </filter> </appender> <!--通過<category></category>的定義可以將各個包中的類日志輸出到不同的日志文件中--> <!-- <category name="com.gzy"> <priority value="debug" /> <appender-ref ref="log4jTestLogInfo" /> <appender-ref ref="log4jTestDebug" /> </category> --> <appender name="MAIL" class="org.apache.log4j.net.SMTPAppender"> <param name="threshold" value="debug" /> <!-- 日志的錯誤級別 <param name="threshold" value="error"/> --> <!-- 緩存文件大小,日志達到512K時發送Email --> <param name="BufferSize" value="512" /><!-- 單位K --> <param name="From" value="test@163.com" /> <param name="SMTPHost" value="smtp.163.com" /> <param name="Subject" value="juyee-log4jMessage" /> <param name="To" value="test@163.com" /> <param name="SMTPUsername" value="test" /> <param name="SMTPPassword" value="test" /> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss.SSS a} [%p]-[%c] %m%n" /> </layout> </appender> <root> <priority value="debug"/> <appender-ref ref="CONSOLE" /> <appender-ref ref="log4jDebug" /> <appender-ref ref="log4jInfo" /> <appender-ref ref="log4jWarn" /> <appender-ref ref="log4jError" /> <!-- <appender-ref ref="MAIL" /> --> </root> </log4j:configuration>
這里附上另一種配置log4j的文件,是使用log4j的properties文件,上面也說到了,它是有缺陷的,就是里面的日志等級可能都會輸出到一個文件中,高級別的日志信息也會在低級別的日志文件中出現,有點混亂。
log4j.properties 文件:
# priority :debug<info<warn<error #you cannot specify every priority with different file for log4j log4j.rootLogger=debug,stdout,info,debug,warn,error #console log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern= [%d{yyyy-MM-dd HH:mm:ss a}]:%p %l%m%n #info log log4j.logger.info=info log4j.appender.info=org.apache.log4j.DailyRollingFileAppender log4j.appender.info.DatePattern='_'yyyy-MM-dd'.log' log4j.appender.info.File=./src/com/hp/log/info.log log4j.appender.info.Append=true log4j.appender.info.Threshold=INFO log4j.appender.info.layout=org.apache.log4j.PatternLayout log4j.appender.info.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n #debug log log4j.logger.debug=debug log4j.appender.debug=org.apache.log4j.DailyRollingFileAppender log4j.appender.debug.DatePattern='_'yyyy-MM-dd'.log' log4j.appender.debug.File=./src/com/hp/log/debug.log log4j.appender.debug.Append=true log4j.appender.debug.Threshold=DEBUG log4j.appender.debug.layout=org.apache.log4j.PatternLayout log4j.appender.debug.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n #warn log log4j.logger.warn=warn log4j.appender.warn=org.apache.log4j.DailyRollingFileAppender log4j.appender.warn.DatePattern='_'yyyy-MM-dd'.log' log4j.appender.warn.File=./src/com/hp/log/warn.log log4j.appender.warn.Append=true log4j.appender.warn.Threshold=WARN log4j.appender.warn.layout=org.apache.log4j.PatternLayout log4j.appender.warn.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n #error log4j.logger.error=error log4j.appender.error = org.apache.log4j.DailyRollingFileAppender log4j.appender.error.DatePattern='_'yyyy-MM-dd'.log' log4j.appender.error.File = ./src/com/hp/log/error.log log4j.appender.error.Append = true log4j.appender.error.Threshold = ERROR log4j.appender.error.layout = org.apache.log4j.PatternLayout log4j.appender.error.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss a} [Thread: %t][ Class:%c >> Method: %l ]%n%p:%m%n
是不是很簡單啊,呵呵。
完成以上的配置后,現在就可以試試使用log4j了。新建一個java類,源代碼中如下使用即可:
package com.test.utility; import org.apache.log4j.Logger; public class Test { private static Logger log=Logger.getLogger(Test.class); public static void main(String[] args) { log.info("this is info message"); log.debug("this is debug message"); log.warn("this is warn message"); log.error("this is error message"); } }
嗯,以上就完成了log4j的所有需要的配置了.enjoy it!