在我們的應用程式中日誌是不可缺少的部分,在Apache中由一個功能無比強大的日誌組件,它提供了方便的日誌記錄,這個開源的項目就是我們慣用的Log4j,jar包我麽們一顆取Apache官網下載最新版本的。log4j下載地址 一.入門篇 1.打開我們的Eclipse新建一個Java項目並且導入Log4j ...
在我們的應用程式中日誌是不可缺少的部分,在Apache中由一個功能無比強大的日誌組件,它提供了方便的日誌記錄,這個開源的項目就是我們慣用的Log4j,jar包我麽們一顆取Apache官網下載最新版本的。log4j下載地址
一.入門篇
1.打開我們的Eclipse新建一個Java項目並且導入Log4j的Jar包
2.創建並且設置我們Log4j的資源文件
### 設置### log4j.rootLogger = debug,stdout,D,E ### 輸出信息到控制台 ### 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 ### 輸出DEBUG級別以上的日誌到E://logs/error.log ### log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = E://logs/log.log log4j.appender.D.Append = true log4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n ### 輸入ERROR級別以上的日誌到E://logs/error.log ### log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File =E://logs/error.log log4j.appender.E.Append = true log4j.appender.E.Threshold = ERROR log4j.appender.E.layout = org.apache.log4j.PatternLayout log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
3.我們來到Log4jTest中的main方法設置日誌內容
logger.debug("記錄debug級別的信息 "); logger.info("記錄info級別的信息 "); logger.error("記錄error級別的信息 ");
4.查看我們的日誌輸出結果:
這是控制臺上列印的信息。
然後我們在來看看我們日誌文件
這個時候我們發現日誌已經按照我們的配置要求輸出到對應的文檔去了。
二.log4j最基本的使用方式
log4j最要由三個重要的組件構成:日誌信息的優先順序,日誌信息的輸出目的地,日誌信息的輸出格式。日誌信息的優先順序從高到低由ERROR,WARN,INFO,DEBUG,分別用來指定這條日誌信息的重要程度;日誌信息的輸出目的地指定了日誌是列印在控制台還是輸出到文件中;而輸出格式控制了日誌信息的顯示內容。
1)定義配置文件
其實我們可以完全不用配置log4j文件,我們可以在代碼中完成log4j的配置環境,但是使用配置文件將使應用程式變得更加的靈活。log4j支持兩種配置文件格式,一種是XML格式的文件還有一種就是我們上面用的使用properteis資源文件。
配置根Logger,語法為:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中,level 是日誌記錄的優先順序,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別,優 先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裡定義的級別,您可以控制到應用程式中相應級別的日誌信息的開關。比如在這裡定 義了INFO級別,則應用程式中所有DEBUG級別的日誌信息將不被列印出來。 appenderName就是指B日誌信息輸出到哪個地方。您可以同時指定多個輸出目的地。
配置日誌信息輸出目的地Appender,其語法為:
log4j.appender.appenderName = fully.qualified.name.of.appender.class log4j.appender.appenderName.option1 = value1 … log4j.appender.appenderName.option = valueN
其中,Log4j提供的appender有以下幾種:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天產生一個日誌文件),
org.apache.log4j.RollingFileAppender(文件大小到達指定尺寸的時候產生一個新的文件),
org.apache.log4j.WriterAppender(將日誌信息以流格式發送到任意指定的地方)
3.配置日誌信息的格式(佈局),其語法為:
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class log4j.appender.appenderName.layout.option1 = value1 … log4j.appender.appenderName.layout.option = valueN
其中,Log4j提供的layout有以下幾種:
org.apache.log4j.HTMLLayout(以HTML表格形式佈局),
org.apache.log4j.PatternLayout(可以靈活地指定佈局模式),
org.apache.log4j.SimpleLayout(包含日誌信息的級別和信息字元串),
org.apache.log4j.TTCCLayout(包含日誌產生的時間、線程、類別等等信息)
Log4J採用類似C語言中的printf函數的列印格式格式化日誌信息,列印參數如下: %m 輸出代碼中指定的消息
%p 輸出優先順序,即DEBUG,INFO,WARN,ERROR,FATAL %r 輸出自應用啟動到輸出該log信息耗費的毫秒數 %c 輸出所屬的類目,通常就是所在類的全名 %t 輸出產生該日誌事件的線程名 %n 輸出一個回車換行符,Windows平臺為“rn”,Unix平臺為“n” %d 輸出日誌時間點的日期或時間,預設格式為ISO8601,也可以在其後指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類似:2002年10月18日 22:10:28,921 %l 輸出日誌事件的發生位置,包括類目名、發生的線程,以及在代碼中的行數。舉例:Log4jTest.main(Log4jTest.java:9)
2)在代碼中使用Log4j
首先我們要得到記錄器
使用Log4j,第一步就是獲取日誌記錄器,這個記錄器將負責控制日誌信息。其語法為:
public static Logger getLogger( String name)
通過指定的名字獲得記錄器,如果必要的話,則為這個名字創建一個新的記錄器。Name一般取本類的名字,比如:
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
然後我們需要讀取配置文件
當獲得了日誌記錄器之後,第二步將配置Log4j環境,其語法為:
BasicConfigurator.configure (): 自動快速地使用預設Log4j環境。 PropertyConfigurator.configure ( String configFilename) :讀取使用Java的特性文件編寫的配置文件。 DOMConfigurator.configure ( String filename ) :讀取XML形式的配置文件。
插入記錄信息(格式化日誌信息)
當上兩個必要步驟執行完畢,您就可以輕鬆地使用不同優先順序別的日誌記錄語句插入到您想記錄日誌的任何地方,其語法如下:
Logger.debug ( Object message ) ; Logger.info ( Object message ) ; Logger.warn ( Object message ) ; Logger.error ( Object message ) ;
3)日誌級別
每個Logger都被了一個日誌級別(log level),用來控制日誌信息的輸出。日誌級別從高到低分為:
A:off 最高等級,用於關閉所有日誌記錄。
B:fatal 指出每個嚴重的錯誤事件將會導致應用程式的退出。
C:error 指出雖然發生錯誤事件,但仍然不影響系統的繼續運行。
D:warm 表明會出現潛在的錯誤情形。
E:info 一般和在粗粒度級別上,強調應用程式的運行全程。
F:debug 一般用於細粒度級別上,對調試應用程式非常有幫助。
G:all 最低等級,用於打開所有日誌記錄。
上面這些級別是定義在org.apache.log4j.Level類中。Log4j只建議使用4個級別,優先順序從高到低分別是error,warn,info和debug。通過使用日誌級別,可以控制應用程式中相應級別日誌信息的輸出。例如,如果使用b了info級別,則應用程式中所有低於info級別的日誌信息(如debug)將不會被列印出來。
三,Web項目中使用log4j
上面代碼描述了Log4j的簡單應用,其實使用Log4j也就是這樣簡單方便。當然除了上面的配置方法,還有其它,比如做一個J2EE應用,在J2EE應用使用Log4j,必須先在啟動服務時載入Log4j的配置文件進行初始化,可以在web.xml中進行。
1、web應用的log4j使用基本上都採用:新建一個servlet,這個servlet在init函數中為log4j執行配置。一般就是讀入配置文件。所以需要在web.xml中為這個servlet配置,同時設定load-on-startup為1。
2、這個servlet配置log4j就是讀出配置文件,然後調用configure函數。這裡有兩個問題:一、需要知道文件在哪裡;二、需要正確的文件類型
3、配置文件位置在web.xml中配置一個param即可,路徑一般是相對於web的root目錄
4、文件類型一般有兩種,一個是Java的property文件,另一種是xml文件
配置文件的大致內容:log4j可以指定輸出的log級別的最低等級,以及log的輸出配置格式,每個log可以指定多個輸出方式
接下來我們來創建一個WEB項目
然後我們配置WEB。xml
<servlet> <servlet-name>Log4JTestServlet</servlet-name> <servlet-class>com.miya.log4j.Log4JTestServlet</servlet-class> </servlet> <!--用來啟動 log4jConfigLocation的servlet --> <servlet> <servlet-name>Log4JInitServlet</servlet-name> <servlet-class>com.miya.log4j.Log4JInitServlet</servlet-class> <init-param> <param-name>log4j-properties-location</param-name> <param-value>/WEB-INF/classes/log4j.properties</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>Log4JTestServlet</servlet-name> <url-pattern>/test</url-pattern> </servlet-mapping>
配置log4j.properties
### set log levels ### log4j.rootLogger = debug,stdout,D,E 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 log4j.appender.D = org.apache.log4j.DailyRollingFileAppender log4j.appender.D.File = F://logs/log.log log4j.appender.D.Append = true log4j.appender.D.Threshold = DEBUG log4j.appender.D.layout = org.apache.log4j.PatternLayout log4j.appender.D.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n log4j.appender.E = org.apache.log4j.DailyRollingFileAppender log4j.appender.E.File =F://logs/error.log log4j.appender.E.Append = true log4j.appender.E.Threshold = ERROR log4j.appender.E.layout = org.apache.log4j.PatternLayout log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n
WEB容器一打開就載入servlet這樣也是就行了。
當我們需要在Spring項目中加入Log4j
首先百年不變配置Web.xml
<servlet> <servlet-name>Log4JTestServlet</servlet-name> <servlet-class>com.miya.log4j.Log4JTestServlet</servlet-class> </servlet> <!--用來啟動 log4jConfigLocation的servlet --> <!-- <servlet> <servlet-name>Log4JInitServlet</servlet-name> <servlet-class>com.miya.log4j.Log4JInitServlet</servlet-class> <init-param> <param-name>log4j-properties-location</param-name> <param-value>/WEB-INF/classes/log4j.properties</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet>--> <servlet-mapping> <servlet-name>Log4JTestServlet</servlet-name> <url-pattern>/test</url-pattern> </servlet-mapping> <!-- Spring 容器載入 --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> <context-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:applicationContext.xml</param-value> </context-param> <!-- 設置根目錄 --> <context-param> <param-name>webAppRootKey</param-name> <param-value>webapp.root</param-value> </context-param> <context-param> <param-name>log4jConfigLocation</param-name> <param-value>/WEB-INF/classes/log4j.properties</param-value> </context-param> <!-- 3000表示 開一條watchdog線程每60秒掃描一下配置文件的變化;這樣便於日誌存放位置的改變 --> <context-param> <param-name>log4jRefreshInterval</param-name> <param-value>3000</param-value> </context-param> <listener> <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class> </listener>
在spring的配置中applicationContext.xml中不需要加入任何bean。在我們程式一運行log4j的servlet也會跟著spring視窗啟動了。