1. 概述 html
1.1. 背景
在應用程序中添加日誌記錄總的來講基於三個目的 :監視代碼中變量的變化狀況,週期性的記錄到文件中供其餘應用進行統計分析工做;跟蹤代碼運行時軌跡,做爲往後審計的依據;擔當集成開發環境中的調試器的做用,向文件或控制檯打印代碼的調試信息。
最普通的作法就是在代碼中嵌入許多的打印語句,這些打印語句能夠輸出到控制檯或文件中,比較好的作法就是構造一個日誌操做類 來封裝此類操做,而不是讓一系列的打印語句充斥了代碼的主體。 java
http://logging.apache.org/log4j/ 官網地址 mysql
1.2. Log4j 簡介 程序員
在強調可重用組件開發的今天,除了本身從頭至尾開發一個可重用的日誌操做類外, Apache 爲咱們提供了一個強有力的日誌操做包 -Log4j 。
Log4j 是 Apache 的一個開放源代碼項目,經過使用 Log4j ,咱們能夠控制日誌信息輸送的目的地是控制檯、文件、 GUI 組件、甚至是套接口服 務器、 NT 的事件記錄器、 UNIX Syslog 守護進程等;咱們也能夠控制每一條日誌的輸出格式;經過定義每一條日誌信息的級別,咱們可以更加細緻地控制日誌的生成過程。最使人感興趣的就 是,這些能夠經過一個配置文件來靈活地進行配置,而不須要修改應用的代碼。
此外,經過 Log4j 其餘語言接口,您能夠在 C 、 C+ + 、 .Net 、 PL/SQL 程序中使用 Log4j ,其語法和用法與在 Java 程序中同樣,使得多語言分佈式系統獲得一個統一一致的日誌組件模塊。並且,通 過使用各類第三方擴展,您能夠很方便地將 Log4j 集成到 J2EE 、 JINI 甚至是 SNMP 應用中。 web
2. 一個簡單的實例 sql
項目結構: 數據庫
Java 代碼: apache
配置文件 log4j.properties: 多線程
Properties 代碼 app
# 能夠設置級別: debug>info>error
#debug :顯示 debug 、 info 、 error
#info :顯示 info 、 error
#error :只 error
# 也就是說只顯示比大於等於當前級別的信息
log4j.rootLogger=debug,appender1
#log4j.rootLogger=info,appender1
#log4j.rootLogger=error,appender1
# 輸出到控制檯
log4j.appender.appender1=org.apache.log4j.ConsoleAppender
# 樣式爲 TTCCLayout
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout
輸出結果:
Console 代碼
[main] DEBUG com.coderdream.log4j.HelloLog4j - This is debug message.
[main] INFO com.coderdream.log4j.HelloLog4j - This is info message.
[main] ERROR com.coderdream.log4j.HelloLog4j - This is error message.
經過配置文件可知,咱們須要配置 3 個方面的內容:
1 、根目錄(級別和目的地);
2 、目的地(控制檯、文件等等);
3 、輸出樣式。
下面咱們來看看Log4J 的類圖:
Logger - 日誌寫出器 ,供程序員輸出日誌信息
Appender - 日誌目的地 ,把格式化好的日誌信息輸出到指定的地方去
Layout - 日誌格式化器 ,用來把程序員的 logging request 格式化成字符串
2 . Log4j 基本使用方法
Log4j 由三個重要的組件構成:日誌信息的優先級,日誌信息的輸出目的地,日誌信息的輸出格式 。日誌信息的優先級從高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ,分別用來指定這條日誌信息的重要程度;日誌信息的輸出目的地指定了日誌將打印到控制檯仍是文件中;而輸出格式則控制了日誌信息的顯示內容。
1 、定義配置文件
其實您也能夠徹底不使用配置文件,而是在代碼中配置 Log4j 環境。可是,使用配置文件將使您的應用程序更加靈活。 Log4j 支持兩種配置文件格式,一種是 XML 格式的文件,一種是 Java 特性文件(鍵 = 值 properties 文件)。下面咱們介紹使用 Java 特性文件作爲配置文件的方法:
1 ) . 配置根 Logger ,其語法爲:
log4j.rootLogger = [ level ] , appenderName, appenderName, …
其中, level 是日誌記錄的優先級,分爲 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 ALL 或者您定義的級別。 Log4j 建議只使用四個級別 ,優先級從高到低分別是 ERROR 、 WARN 、 INFO 、 DEBUG 。經過在這裏定義的級別,您能夠控制到應用程序中相應級別的日誌信息的開關。好比在這裏定 義了 INFO 級別,則應用程序中全部 DEBUG 級別的日誌信息將不被打印出來 。 appenderName 就是指 B 日誌信息輸出到哪一個地方。您能夠同時指定多個輸出目的地。
2 )配置日誌信息輸出目的地 Appender ,其語法爲:
log4j.appender.appenderName = fully.qualified.name.of.appender.class. 其中, Log4j 提供的 appender 有如下幾種:
1.org.apache.log4j.ConsoleAppender (控制檯),
2.org.apache.log4j.FileAppender (文件),
3.org.apache.log4j.DailyRollingFileAppender (天天產生一個日誌文件),
4.org.apache.log4j.RollingFileAppender (文件大小到達指定尺寸的時候產生一個 新的文件)
5.org.apache.log4j.WriterAppender (將日誌信息以流格式發送到任意指定的地方)
3) . 配置日誌信息的格式(佈局),其語法爲:
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
其中, Log4j 提供的 layout 有以 e 幾種:
1.org.apache.log4j.HTMLLayout (以 HTML 表格形式佈局),
2.org.apache.log4j.PatternLayout (能夠靈活地指定佈局模式),
3.org.apache.log4j.SimpleLayout (包含日誌信息的級別和信息字符串),
4.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 輸出日誌事件的發生位置,包括類目名、發生的線程,以及在代碼中的行數。舉例: Testlog4.main(TestLog4.java:10)
2. 在代碼中使用 Log4j
1. 獲得記錄器
使用 Log4j ,第一步就是獲取日誌記錄器,這個記錄器將負責控制日誌信息。其語法爲:
public static Logger getLogger( String name)
經過指定的名字得到記錄器,若是必要的話,則爲這個名字建立一個新的記錄器。 Name 通常取本類的名字,好比:
static Logger logger = Logger.getLogger ( ServerWithLog4j.class.getName () )
2. 讀取配置文件
當得到了日誌記錄器以後,第二步將配置 Log4j 環境,其語法爲:
BasicConfigurator.configure () : 自動快速地使用缺省 Log4j 環境。
PropertyConfigurator.configure ( String configFilename) :讀取使用 Java 的特性文件編寫的配置文件。
DOMConfigurator.configure ( String filename ) :讀取 XML 形式的配置文件。
3. 插入記錄信息(格式化日誌信息)
當上兩個必要步驟執行完畢,您就能夠輕鬆地使用不一樣優先級別的日誌記錄語句插入到您想記錄日誌的任何地方,其語法以下:
Logger.debug ( Object message ) ;
Logger.info ( Object message ) ;
Logger.warn ( Object message ) ;
Logger.error ( Object message ) ;
3. 示例 2 ~示例 8
【示例 2 】 輸出爲文本文件或 HTML 文件
Porperties 代碼
【 示例3 】 輸出爲文本文件或HTML 文件
Properties 代碼
【 示例 4 】 SimpleLayout 樣式
Properties 代碼
控制檯代碼
DEBUG - This is debug message.
INFO - This is info message.
ERROR - This is error message.
【示例5 】 自定義樣式
Java 代碼
# 自定義樣式
# %r 時間 0
# %t 方法名 main
# %p 優先級 DEBUG/INFO/ERROR
# %c 所屬類的全名 ( 包括包名 )
# %l 發生的位置,在某個類的某行
# %m 輸出代碼中指定的訊息,如 log(message) 中的 message
# %n 輸出一個換行
log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n 輸出結果:
控制檯代碼
0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j
-com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16 ) -This is debug message.
31 [main] [INFO] - com.coderdream.log4j.HelloLog4j -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18 ) -This is info message.
31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j
-com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20 ) -This is error message.
【示例6 】 多目的地、自定義樣式
Properties 代碼
【示例 7 】 【企業應用】設置 特定包的級別和目的地
先增長一個包,新建一個類:
Java 代碼
若是這個類做爲基類,如 J2EE 中的 BaseDao 、 BaseAction 、 BaseService 等等,則咱們能夠將各層的日誌信息分類輸出到各個文件。
Properties 代碼
【示例 8 】 log4j.xml 的配置方式
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="appender1"
class="org.apache.log4j.RollingFileAppender">
<param name="File" value="logfile08.html" />
<param name="MaxFileSize" value="1MB" />
<param name="MaxBackupIndex" value="5" />
<layout class="org.apache.log4j.HTMLLayout">
</layout>
</appender>
<root>
<level value="debug" />
<appender-ref ref="appender1" />
</root>
</log4j:configuration>
特別說明:
爲了提升效率,咱們能夠在寫日誌前增長判斷:
Java 代碼
另附一些詳細東西:
1.java 中的應用
Logger.debug(Object message);// 調試信息
Logger.info(Object message);// 通常信息
Logger.warn(Object message);// 警告信息
Logger.error(Object message);// 錯誤信息
Logger.fatal(Object message);// 致命錯誤信息
2 、配置根 Logger ,其語法爲:
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
level : 是日誌記錄的優先級,分爲 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 ALL 或者您定義的級別。 Log4j 建議只使用四個級別,優 先級從高到低分別是 ERROR 、 WARN 、 INFO 、 DEBUG 。經過在這裏定義的級別,您能夠控制到應用程序中相應級別的日誌信息的開關。好比在這裏定 義了 INFO 級別,則應用程序中全部 DEBUG 級別的日誌信息將不被打印出來。
appenderName: 就是指定日誌信息輸出到哪一個地方。您能夠同時指定多個輸出目的地。
例如: log4j.rootLogger = info,A1,B2,C3
3 、配置日誌信息輸出目的地,其語法爲:
log4j.appender.appenderName = fully.qualified.name.of.appender.class //
"fully.qualified.name.of.appender.class" 能夠指定下面五個目的地中的一個:
1.org.apache.log4j.ConsoleAppender (控制檯)
2.org.apache.log4j.FileAppender (文件)
3.org.apache.log4j.DailyRollingFileAppender (天天產生一個日誌文件)
4.org.apache.log4j.RollingFileAppender (文件大小到達指定尺寸的時候產生一個新的文件)
5.org.apache.log4j.WriterAppender (將日誌信息以流格式發送到任意指定的地方)
1.ConsoleAppender 選項
Threshold=WARN: 指定日誌消息的輸出最低層次。
ImmediateFlush=true: 默認值是 true, 意謂着全部的消息都會被當即輸出。
Target=System.err :默認狀況下是: System.out, 指定輸出控制檯
2.FileAppender 選項
Threshold=WARN: 指定日誌消息的輸出最低層次。
ImmediateFlush=true: 默認值是 true, 意謂着全部的消息都會被當即輸出。
File=mylog.txt: 指定消息輸出到 mylog.txt 文件。
Append=false: 默認值是 true, 即將消息增長到指定文件中, false 指將消息覆蓋指定的文件內容。
3.DailyRollingFileAppender 選項
Threshold=WARN: 指定日誌消息的輸出最低層次。
ImmediateFlush=true: 默認值是 true, 意謂着全部的消息都會被當即輸出。
File=mylog.txt: 指定消息輸出到 mylog.txt 文件。
Append=false: 默認值是 true, 即將消息增長到指定文件中, false 指將消息覆蓋指定的文件內容。
DatePattern='.'yyyy-ww: 每週滾動一次文件 ,即每週產生一個新的文件。固然也能夠指定按月、周、天、時和分。即對應的格式以下:
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: 每分鐘
4.RollingFileAppender 選項
Threshold=WARN: 指定日誌消息的輸出最低層次。
ImmediateFlush=true: 默認值是 true, 意謂着全部的消息都會被當即輸出。
File=mylog.txt: 指定消息輸出到 mylog.txt 文件。
Append=false: 默認值是 true, 即將消息增長到指定文件中, false 指將消息覆蓋指定的文件內容。
MaxFileSize=100KB: 後綴能夠是 KB, MB 或者是 GB. 在日誌文件到達該大小時,將會自動滾動,即將原來的內容移到 mylog.log.1 文件。
MaxBackupIndex=2: 指定能夠產生的滾動文件的最大數。
實際應用:
log4j.appender.A1=org.apache.log4j.ConsoleAppender // 這裏指定了日誌輸出的第一個位置 A1 是控制檯 ConsoleAppender
3 、配置日誌信息的格式,其語法爲:
A. log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
"fully.qualified.name.of.layout.class" 能夠指定下面 4 個格式中的一個:
1.org.apache.log4j.HTMLLayout (以 HTML 表格形式佈局),
2.org.apache.log4j.PatternLayout (能夠靈活地指定佈局模式),
3.org.apache.log4j.SimpleLayout (包含日誌信息的級別和信息字符串),
4.org.apache.log4j.TTCCLayout (包含日誌產生的時間、線程、類別等等信息)
1.HTMLLayout 選項
LocationInfo=true: 默認值是 false, 輸出 java 文件名稱和行號
Title=my app file: 默認值是 Log4J Log Messages.
2.PatternLayout 選項
ConversionPattern=%m%n : 指定怎樣格式化指定的消息。
3.XMLLayout 選項
LocationInfo=true: 默認值是 false, 輸出 java 文件和行號
實際應用:
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
這裏須要說明的就是日誌信息格式中幾個符號所表明的含義:
- X 號 : X 信息輸出時左對齊;
%p: 輸出日誌信息優先級,即 DEBUG , INFO , WARN , ERROR , FATAL,
%d: 輸出日誌時間點的日期或時間,默認格式爲 ISO8601 ,也能夠在其後指定格式,好比: %d{yyy MMM dd HH:mm:ss,SSS} ,輸出相似: 2002 年 10 月 18 日 22 : 10 : 28 , 921
%r: 輸出自應用啓動到輸出該 log 信息耗費的毫秒數
%c: 輸出日誌信息所屬的類目,一般就是所在類的全名
%t: 輸出產生該日誌事件的線程名
%l: 輸出日誌事件的發生位置,至關於 %C.%M(%F:%L) 的組合 , 包括類目名、發生的線程,以及在代碼中的行數。舉例: Testlog4.main(TestLog4.java:10)
%x: 輸出和當前線程相關聯的 NDC( 嵌套診斷環境 ), 尤爲用到像 java servlets 這樣的多客戶多線程的應用中。
%%: 輸出一個 "%" 字符
%F: 輸出日誌消息產生時所在的文件名稱
%L: 輸出代碼中的行號
%m: 輸出代碼中指定的消息 , 產生的日誌具體信息
%n: 輸出一個回車換行符, Windows 平臺爲 "/r/n" , Unix 平臺爲 "/n" 輸出日誌信息換行
能夠在 % 與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如:
1)%20c :指定輸出 category 的名稱,最小的寬度是 20 ,若是 category 的名稱小於 20 的話,默認的狀況下右對齊。
2)%-20c: 指定輸出 category 的名稱,最小的寬度是 20 ,若是 category 的名稱小於 20 的話, "-" 號指定左對齊。
3)%.30c: 指定輸出 category 的名稱,最大的寬度是 30 ,若是 category 的名稱大於 30 的話,就會將左邊多出的字符截掉,但小於 30 的話也不會有空格。
4)%20.30c: 若是 category 的名稱小於 20 就補空格,而且右對齊,若是其名稱長於 30 字符,就從左邊交遠銷出的字符截掉。
這裏上面三個步驟是對前面 Log4j 組件說明的一個簡化;下面給出一個具體配置例子,在程序中能夠參照執行:
log4j.rootLogger=INFO,A1 , B2
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
4. # 當輸出信息於回滾文件時
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender // 指定以文件的方式輸出日誌
log4j.appender.ROLLING_FILE.Threshold=ERROR
log4j.appender.ROLLING_FILE.File=rolling.log // 文件位置 , 也能夠用變量 ${java.home} 、 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
5. Log4j 比較全面的配置
LOG4J 的配置之簡單使它遍佈於愈來愈多的應用中了: Log4J 配置文件實現了輸出到控制檯、文件、回滾文件、發送日誌郵件、輸出到數據庫日誌表、自定義標籤等全套功能。擇其一二使用就夠用了,
log4j.rootLogger=DEBUG,CONSOLE,A1,im
log4j.addivity.org.apache=true
# 應用於控制檯
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.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 // 文件位置 , 也能夠用變量 ${java.home} 、 rolling.log
log4j.appender.ROLLING_FILE.Append=true //true: 添加 false: 覆蓋
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
www.wuset.com ">log4j.appender.MAIL.From=web@www.wuset.com
log4j.appender.MAIL.SMTPHost=www.wusetu.com
log4j.appender.MAIL.Subject=Log4J Message
www.wusetu.com ">log4j.appender.MAIL.To=web@www.wusetu.com
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.IMAppender
log4j.appender.im.host = mail.cybercorlin.net
log4j.appender.im.username = username
log4j.appender.im.password = password
log4j.appender.im.recipient = corlin@cybercorlin.net
log4j.appender.im.layout=org.apache.log4j.PatternLayout log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n