天天看點

Java基礎學習總結(25)——Log4j快速入門教程

log4j是一個優秀的日志元件,基本上所有的java開發項目都會用到它。下面将自己學習的一些心得總結一下,友善以後學習。

log4j在項目中都不會單獨使用,至少是我寫過的java項目中沒有。一般來說log4j是和commons-loggings元件一同使用,在maven中的依賴項是:

Java基礎學習總結(25)——Log4j快速入門教程

commons-logging和log4j的關系就像是jdbc和mysql資料庫一樣,一個是工廠方法,一個是具體的實作,好處:1,邏輯代碼是實作分離 2.維護變少。其中第二點是很重要的。配置比單獨使用log4j元件還要簡單。

先說一下原理。

項目在classpath中引用完commons-logging的jar包之後。按照commons-loggings的官方說法:

Java基礎學習總結(25)——Log4j快速入門教程

翻譯成中文,我也是在别的地方找的,是這樣的:

1) 首先在classpath下尋找自己的配置檔案commons-logging.properties,如果找到,則使用其中定義的Log實作類;

2) 如果找不到commons-logging.properties檔案,則在查找是否已定義系統環境變量org.apache.commons.logging.Log,找到則使用其定義的Log實作類;

3) 否則,檢視classpath中是否有Log4j的包,如果發現,則自動使用Log4j作為日志實作類;

4) 否則,使用JDK自身的日志實作類(JDK1.4以後才有日志實作類);

5) 否則,使用commons-logging自己提供的一個簡單的日志實作類SimpleLog

是以按照上面的說法,我們在classpath中引用萬log4j的jar包就可以自動的使用log4j元件來給我們輸入日志了。這樣就完成了log4j和commons-logging的耦合了。不需要任何的配置檔案,隻需要引入兩個jar包就可以了。

然後在程式中填上下面一句話後:

private static Log log = LogFactory.getLog(YouClassName.class);

就可以使用commons-logging來輸入日志檔案了。可以使用下面五種級别在程式中進行輸出:

log.debug()   輸出“調試”級别的日志資訊;

log.info()      輸出“資訊”級别的日志資訊;

log.warn()    輸出“警告”級别的日志資訊;

log.error()     輸出“錯誤”級别的日志資訊;

log.fatal()      輸出“緻命錯誤”級别的日志資訊;

需要注意的是:

log4j元件必須使用log4j.properties配置檔案。

log4j元件有三個組成部分:日志記錄器(Loggers),輸出端(Appenders)和日志格式化器(Layout)。可以通過配置檔案來統一配置。

比如下面的配置檔案,從網上摘抄的:

log4j.rootLogger=DEBUG, CONSOLE,A1

#它定義日志資訊的“輸出級别”和“輸出目的地”。“DEBUG, CONSOLE,A1”這裡我們要把它分成兩部分:第一個逗号之前的是第一部分,指定“輸出級别”;後面的是第二部分,指定“輸出目的#地”。可以同時指定多個“輸出目的地”,以逗号隔開。具體到上面這一行:它指定的“輸出級别”是“DEBUG”;它指定的“輸出目的地”是“CONSOLE”和“A1”。

#“輸出級别”有可選的五個值,分别是DEBUG、INFO、WARN、ERROR、FATAL,它們是由Log4j系統定義的。

# “輸出目的地”就是我們自己定義的了,就在log4j.properties的後面部分,此檔案定義的“輸出目的地”有CONSOLE、FILE、ROLLING_FILE、SOCKET、LF5_APPENDER、MAIL、DATABA#SE、A1、im。該檔案之是以可作主模闆,就是因為它比較全面地定義了各種常見的輸出目的地(控制台、檔案、電子郵件、資料庫等)。

#當在程式中使用DEBUG的時候,意思是調試級别以上的日志資訊都要輸出,包括  log.debug,log.info,log.warn,log.warn,log.error,log.fatal的日志。

#同理,當使用INFO的時候,意思是級别以上的日志資訊都要輸出,包括 log.info,log.warn,log.warn,log.error,log.fatal的日志。

log4j.addivity.org.apache=true

# 應用于控制台

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

log4j.appender.CONSOLE.Threshold=DEBUG

log4j.appender.CONSOLE.Target=System.out

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

log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n

#應用于檔案

log4j.appender.FILE=org.apache.log4j.FileAppender

log4j.appender.FILE.File=file.log

log4j.appender.FILE.Append=false

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

log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

# Use this layout for LogFactor 5 analysis

# 應用于檔案復原

log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender

log4j.appender.ROLLING_FILE.Threshold=ERROR

log4j.appender.ROLLING_FILE.File=rolling.log

log4j.appender.ROLLING_FILE.Append=true

log4j.appender.ROLLING_FILE.MaxFileSize=10KB

log4j.appender.ROLLING_FILE.MaxBackupIndex=1

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

log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

#應用于socket

log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender

log4j.appender.SOCKET.RemoteHost=localhost

log4j.appender.SOCKET.Port=5001

log4j.appender.SOCKET.LocationInfo=true

# Set up for Log Facter 5

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

log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n

# Log Factor 5 Appender

log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender

log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

# 發送日志給郵件

log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender

log4j.appender.MAIL.Threshold=FATAL

log4j.appender.MAIL.BufferSize=10

[email protected]

log4j.appender.MAIL.SMTPHost=www.wusetu.com

log4j.appender.MAIL.Subject=Log4J Message

[email protected]

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

log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

# 用于資料庫

log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender

log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test

log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver

log4j.appender.DATABASE.user=root

log4j.appender.DATABASE.password=

log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')

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

log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender

log4j.appender.A1.File=SampleMessages.log4j

log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'

log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout

#自定義Appender

log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppende

log4j.appender.im.host = mail.cybercorlin.net

log4j.appender.im.username = username

log4j.appender.im.password = password

log4j.appender.im.recipient = [email protected]

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

log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n

# 結束

還有一個經常使用到的地方就是:

使用log4j控制程式中的包的輸出級别,一開始看這句話可能不太了解,下面我舉例來說明。

比如下面的一句話:

log4j.rootLogger=DEBUG,console

log4j.logger.org.springframework=ERROR 

log4j.logger.com=INFO   

log4j.logger.net=INFO

所有以org.springframework打頭的包都是ERROR級别和ERROR級别以上的,也就是FATAL才會輸出;所有以com或者net打頭的包都是INFO級别和INFO級别以上的輸出,而其他的則為DEBUG級别及DEBUG級别以上的輸出。

上面是設定包的級别,還可以設定輸出地的級别:比如下面

log4j.rootLogger=INFO, stdout, logfile

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

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

log4j.appender.stdout.layout.ConversionPattern=%d %p [%t] [%c] - %m%n

log4j.appender.stdout.Threshold=DEBUG

設定向控制台輸出的級别必須是DEBUG以上的,因為rootLogger中設定的輸出級别是INFO級别,是以這個設定其實是沒有用的。

下面舉一個例子來說明上面的配置。

比如程式需要部署到客戶到伺服器上進行試運作,

log4j.rootLogger=DEBUG, stdout, logfile

在根目錄下,我們選擇讓所有的log都輸出,但是很多東西不想讓使用者在控制台看到。

就可以設定log4j.appender.stdout.Threshold=INFO

這樣在檔案資訊中就有我們想要看到的所有資訊,而使用者看到的就沒有那麼多。

等到過一段時間程式比較穩定了。日志檔案中也不需要那麼多資訊了。就可以增加log4j.appender.logfile.Threshold=INFO

這樣日志中的資訊就會變少,或者使用提高某個包中資訊的輸出級别來實作:

log4j.logger.com.lxzh=INFO