Log4j入門

Log4j入門

Apache的開源項目log4j是一個功能強大的日誌組件,提供方便的日誌記錄。在apache網站：jakarta.apache.org/log4j 能夠免費下載到Log4j最新版本的軟件包。

    https://github.com/Steven-hsm/log4j   源碼下載

1        首先以一個例子爲入門

我以maven工程的方式(自從使用了maven就不喜歡本身導入jar包了,你能夠本身導入jar包的方式導入log4j的jar包)

1.       新建一個maven工程(java和web的均可以)

2.       在pom.xml增長log4j的jar包依賴

<!-- Logging -->   

<dependency>   

    <groupId>org.slf4j</groupId>   

    <artifactId>slf4j-api</artifactId>   

    <version>1.6.6</version>   

</dependency>   

<dependency>   

    <groupId>org.slf4j</groupId>   

    <artifactId>jcl-over-slf4j</artifactId>   

    <version>1.6.6</version>   

    <scope>runtime</scope>   

    </dependency>   

<dependency>   

    <groupId>org.slf4j</groupId>   

    <artifactId>slf4j-log4j12</artifactId>   

    <version>1.6.6</version>   

    <scope>runtime</scope>   

</dependency> 

3.       新增log4j的配置文件,命名最好和個人相同,約定優於配置

4.       以一個最簡單的輸出到控制檯的配置爲基礎

###設置

log4j.rootLogger = debug,stdout

###  輸出信息到控制擡 ###

log4j.appender.stdout = org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Target = System.out

log4j.appender.stdout.layout = org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n

5.       測試類

2        Log4j介紹

參考兩篇文章,這篇直接貼出來,忘記原連接位置了.另一篇地址

http://www.codeceo.com/article/log4j-usage.html

1、Log4j簡介

Log4j有三個主要的組件：Loggers(記錄器)，Appenders (輸出源)和Layouts(佈局)。這裏可簡單理解爲日誌類別，日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個組件能夠輕鬆地記錄信息的類型和級別，並能夠在運行時控制日誌輸出的樣式和位置。

1、Loggers

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

其中日誌輸出級別，共有5級：

FATAL,ERROR,WARN,INFO,DEBUG

 

2、Appenders

禁用和使用日誌請求只是Log4j的基本功能，Log4j日誌系統還提供許多強大的功能，好比容許把日誌輸出到不一樣的地方，如控制檯（Console）、文件（Files）等，能夠根據天數或者文件大小產生新的文件，能夠以流的形式發送到其它地方等等。

Appender 爲日誌輸出目的地，Log4j提供的appender有如下幾種：

org.apache.log4j.ConsoleAppender（控制檯），

org.apache.log4j.FileAppender（文件），

org.apache.log4j.DailyRollingFileAppender（天天產生一個日誌文件），

org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），

org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）

 

3、Layouts

有時用戶但願根據本身的喜愛格式化本身的日誌輸出，Log4j能夠在Appenders的後面附加Layouts來完成這個功能。Layouts提供四種日誌輸出樣式，如根據HTML樣式、自由指定樣式、包含日誌級別與信息的樣式和包含日誌時間、線程、類別等信息的樣式。

Layout：日誌輸出格式，Log4j提供的layout有如下幾種：

org.apache.log4j.HTMLLayout（以HTML表格形式佈局），

org.apache.log4j.PatternLayout（能夠靈活地指定佈局模式），

org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串），

org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）

 

4、打印參數

Log4J採用相似C語言中的printf函數的打印格式格式化日誌信息，以下:

%m 輸出代碼中指定的消息

%p 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL 

%r 輸出自應用啓動到輸出該log信息耗費的毫秒數 

%c 輸出所屬的類目，一般就是所在類的全名 

%t 輸出產生該日誌事件的線程名

%f 輸出日誌信息所屬的類的類名

%n 輸出一個回車換行符，Windows平臺爲「/r/n」，Unix平臺爲「/n」 

%d 輸出日誌時間點的日期或時間，默認格式爲ISO8601，也能夠在其後指定格式，好比：%d{yyy-MMM-dd HH:mm:ss,SSS}，輸出相似2016-03-15 11:13:55,180

%l 輸出日誌事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:10)

 

5、DatePattern解釋

DatePattern='.'yyyy-MM：每個月滾動一第二天志文件，即每個月產生一個新的日誌文件。當前月的日誌文件名爲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：每分鐘

 

6、File、MaxFileSize和MaxBackupIndex

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文件。

 

7、輸出到控制檯和文件的示例

?

1 2 3 4 5 6 7 8 9 10 11 12 13

log4j.rootLogger=INFO,stdout,RollingFile log4j.logger.com.javacui.lucene=DEBUG #stdout 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} [%c] [%l] - %m%n #RollingFile log4j.appender.RollingFile=org.apache.log4j.DailyRollingFileAppender log4j.appender.RollingFile.Append=true log4j.appender.RollingFile.File=D:/tmp/logs/log4j.log log4j.appender.RollingFile.DatePattern='.'yyyy-MM-dd log4j.appender.RollingFile.layout=org.apache.log4j.PatternLayout log4j.appender.RollingFile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%t] [%c] [%p] - %m%n

Threshold=WARN：指定日誌信息的最低輸出級別，默認爲DEBUG。

ImmediateFlush=true：表示全部消息都會被當即輸出，設爲false則不輸出，默認值是true。

Target=System.err：默認值是System.out。

 

2、實用配置詳解

log4j的強大功能不容置疑，但實際應用中免不了遇到某個功能須要輸出獨立的日誌文件的狀況，怎樣才能把所需的內容從原有日誌中分離，造成單獨的日誌文件呢？其實只要在現有的log4j基礎上稍加配置便可輕鬆實現這一功能。

 

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

?

1 2 3 4 5 6 7 8 9 10 11 12 13

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中定義:

?

1	private static Log logger = LogFactory.getLog(Test.class);

而後在log4j.properties中加入:

?

1 2 3 4 5

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中定義:

?

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

 

而後在log4j.properties中加入:

?

1 2 3 4 5 6 7 8 9 10 11

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所配置的日誌中的，如何能只讓它們輸出到本身指定的日誌中呢？別急，這裏有個開關：

?

1	log4j.additivity.myTest1 = false

它用來設置是否同時輸出到log4j.rootLogger所配置的日誌中，設爲false就不會輸出到其它地方啦！注意這裏的"myTest1"是你在程序中給logger起的那個自定義的名字！

若是你說，我只是不想同時輸出這個日誌到log4j.rootLogger所配置的logfile中，stdout裏我還想同時輸出呢！那也好辦，把你的log4j.logger.myTest1 = DEBUG, test1改成下式就OK啦！