LOG4J.PROPERTIES配置詳解（轉載）

標籤：blog   http   java   使用   os   io   strong   檔案   

Log4J的設定檔(Configuration File)就是用來設定記錄器的層級、存放器和布局的，它可接key=value格式的設定或xml格式的設定資訊。通過配置，可以建立出Log4J的運行環境。

1. 設定檔
Log4J設定檔的基本格式如下：

#配置根Logger
log4j.rootLogger = [ level ] , appenderName1 , appenderName2 , …

#配置日誌資訊輸出目的地Appender
log4j.appender.appenderName = fully.qualified.name.of.appender.class 
　　log4j.appender.appenderName.option1 = value1 
　　… 
　　log4j.appender.appenderName.optionN = valueN 

#配置日誌資訊的格式（布局）
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class 
　　log4j.appender.appenderName.layout.option1 = value1 
　　… 
　　log4j.appender.appenderName.layout.optionN = valueN

其中 [level] 是日誌輸出層級，共有5級：

FATAL       0 
ERROR     3 
WARN      4 
INFO         6 
DEBUG     7 

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

org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（檔案），
org.apache.log4j.DailyRollingFileAppender（每天產生一個記錄檔），
org.apache.log4j.RollingFileAppender（檔案大小到達指定尺寸的時候產生一個新的檔案），
org.apache.log4j.WriterAppender（將日誌資訊以流格式發送到任意指定的地方）

Layout：日誌輸出格式，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平台為“\r\n”，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. 在代碼中初始化Logger: 
1）在程式中調用BasicConfigurator.configure()方法：給根記錄器增加一個ConsoleAppender，輸出格式通過PatternLayout設為"%-4r [%t] %-5p %c %x - %m%n"，還有根記錄器的預設層級是Level.DEBUG. 
2）配置放在檔案裡，通過命令列參數傳遞檔案名稱字，通過PropertyConfigurator.configure(args[x])解析並配置；
3）配置放在檔案裡，通過環境變數傳遞檔案名稱等資訊，利用log4j預設的初始化過程解析並配置；
4）配置放在檔案裡，通過應用伺服器配置傳遞檔案名稱等資訊，利用一個特殊的servlet來完成配置。

3. 為不同的 Appender 設定日誌輸出層級：
當調試系統時，我們往往注意的只是異常層級的日誌輸出，但是通常所有層級的輸出都是放在一個檔案裡的，如果日誌輸出的層級是BUG！？那就慢慢去找吧。
這時我們也許會想要是能把異常資訊單獨輸出到一個檔案裡該多好啊。當然可以，Log4j已經提供了這樣的功能，我們只需要在配置中修改Appender的Threshold 就能實現,比如下面的例子：

[設定檔]

 ### 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 = %d{ABSOLUTE} %5p %c{ 1 }:%L - %m%n

### 輸出到記錄檔 ###
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/log.log
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG ## 輸出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.D = org.apache.log4j.DailyRollingFileAppender
log4j.appender.D.File = logs/error.log ## 異常記錄檔名
log4j.appender.D.Append = true
log4j.appender.D.Threshold = ERROR ## 只輸出ERROR層級以上的日誌!!!
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

[代碼中使用] 

 public class TestLog4j {
    public static void main(String[] args) {
        PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );
        Logger logger = Logger.getLogger(TestLog4j. class );
        logger.debug( " debug " );
        logger.error( " error " );
    } 
}

運行一下，看看異常資訊是不是儲存在了一個單獨的檔案error.log中

log4j.properties 使用
一.參數意義說明
輸出層級的種類
ERROR、WARN、INFO、DEBUG
ERROR 為嚴重錯誤 主要是程式的錯誤
WARN 為一般警告，比如session丟失
INFO 為一般要顯示的資訊，比如登入登出
DEBUG 為程式的調試資訊
配置日誌資訊輸出目的地
log4j.appender.appenderName = 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（將日誌資訊以流格式發送到任意指定的地方）
配置日誌資訊的格式
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
2.org.apache.log4j.PatternLayout（可以靈活地指定配置模式），
3.org.apache.log4j.SimpleLayout（包含日誌資訊的層級和資訊字串），
4.org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等資訊）
控制台選項
Threshold=DEBUG:指定日誌訊息的輸出最低層次。
ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
Target=System.err：預設情況下是：System.out,指定輸出控制台
FileAppender 選項
Threshold=DEBUF:指定日誌訊息的輸出最低層次。
ImmediateFlush=true:預設值是true,意謂著所有的訊息都會被立即輸出。
File=mylog.txt:指定訊息輸出到mylog.txt檔案。
Append=false:預設值是true,即將訊息增加到指定檔案中，false指將訊息覆蓋指定的檔案內容。
RollingFileAppender 選項
Threshold=DEBUG:指定日誌訊息的輸出最低層次。
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.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字元，就從左邊較遠輸出的字元截掉。
二.檔案配置Sample1
log4j.rootLogger=DEBUG,A1,R
#log4j.rootLogger=INFO,A1,R
# ConsoleAppender 輸出
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n
# File 輸出 一天一個檔案,輸出路徑可以定製,一般在根路徑下
log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File=blog_log.txt
log4j.appender.R.MaxFileSize=500KB
log4j.appender.R.MaxBackupIndex=10
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%t] [%c] [%p] - %m%n
檔案配置Sample2
下面給出的Log4J設定檔實現了輸出到控制台，檔案，復原檔案，發送日誌郵件，輸出到資料庫日誌表，自訂標籤等全套功能。
log4j.rootLogger=DEBUG,CONSOLE,A1,im 
#DEBUG,CONSOLE,FILE,ROLLING_FILE,MAIL,DATABASE
log4j.addivity.org.apache=true
################### 
# Console Appender 
################### 
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
##################### 
# File Appender 
##################### 
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
######################## 
# Rolling File 
######################## 
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 Appender 
#################### 
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
######################## 
# SMTP Appender 
####################### 
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender 
log4j.appender.MAIL.Threshold=FATAL 
log4j.appender.MAIL.BufferSize=10 
[email protected]
log4j.appender.MAIL.SMTPHost=mail.hollycrm.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
######################## 
# JDBC Appender 
####################### 
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 = [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
三.進階使用
實驗目的：
1.把FATAL級錯誤寫入2000NT日誌
2. WARN，ERROR，FATAL級錯誤發送email通知管理員
3.其他層級的錯誤直接在後台輸出
實驗步驟：
輸出到2000NT日誌
1.把Log4j壓縮包裡的NTEventLogAppender.dll拷到WINNT\SYSTEM32目錄下
2.寫設定檔log4j.properties
# 在2000系統日誌輸出
log4j.logger.NTlog=FATAL, A8
# APPENDER A8
log4j.appender.A8=org.apache.log4j.nt.NTEventLogAppender
log4j.appender.A8.Source=JavaTest
log4j.appender.A8.layout=org.apache.log4j.PatternLayout
log4j.appender.A8.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
3.調用代碼：
Logger logger2 = Logger.getLogger("NTlog"); //要和設定檔中設定的名字相同
logger2.debug("debug!!!");
logger2.info("info!!!");
logger2.warn("warn!!!");
logger2.error("error!!!");
//只有這個錯誤才會寫入2000日誌
logger2.fatal("fatal!!!");
發送email通知管理員：
1. 首先下載JavaMail和JAF, 
  http://java.sun.com/j2ee/ja/javamail/index.html
  http://java.sun.com/beans/glasgow/jaf.html
在項目中引用mail.jar和activation.jar。
2. 寫設定檔
# 將日誌發送到email
log4j.logger.MailLog=WARN,A5
#  APPENDER A5
log4j.appender.A5=org.apache.log4j.net.SMTPAppender
log4j.appender.A5.BufferSize=5
[email protected]
[email protected]
log4j.appender.A5.Subject=ErrorLog
log4j.appender.A5.SMTPHost=smtp.263.net
log4j.appender.A5.layout=org.apache.log4j.PatternLayout
log4j.appender.A5.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
3.調用代碼：
//把日誌發送到mail
Logger logger3 = Logger.getLogger("MailLog");
logger3.warn("warn!!!");
logger3.error("error!!!");
logger3.fatal("fatal!!!");
在後台輸出所有類別的錯誤：
1. 寫設定檔
# 在後台輸出
log4j.logger.console=DEBUG, A1
# APPENDER A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
2．調用代碼
Logger logger1 = Logger.getLogger("console");
logger1.debug("debug!!!");
logger1.info("info!!!");
logger1.warn("warn!!!");
logger1.error("error!!!");
logger1.fatal("fatal!!!");
--------------------------------------------------------------------
全部設定檔：log4j.properties
# 在後台輸出
log4j.logger.console=DEBUG, A1
# APPENDER A1
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
# 在2000系統日誌輸出
log4j.logger.NTlog=FATAL, A8
# APPENDER A8
log4j.appender.A8=org.apache.log4j.nt.NTEventLogAppender
log4j.appender.A8.Source=JavaTest
log4j.appender.A8.layout=org.apache.log4j.PatternLayout
log4j.appender.A8.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
# 將日誌發送到email
log4j.logger.MailLog=WARN,A5
#  APPENDER A5
log4j.appender.A5=org.apache.log4j.net.SMTPAppender
log4j.appender.A5.BufferSize=5
[email protected]
[email protected]
log4j.appender.A5.Subject=ErrorLog
log4j.appender.A5.SMTPHost=smtp.263.net
log4j.appender.A5.layout=org.apache.log4j.PatternLayout
log4j.appender.A5.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
全部代碼：Log4jTest.java
  
/* 
  * 建立日期 2003-11-13 
  */ 
package edu.bcu.Bean; 
import org.apache.log4j.*; 
//import org.apache.log4j.nt.*; 
//import org.apache.log4j.net.*; 
/** 
  * @author yanxu 
  */ 
public class Log4jTest 
{ 
  public static void main(String args[]) 
  { 
   PropertyConfigurator.configure("log4j.properties"); 
   //在後台輸出 
   Logger logger1 = Logger.getLogger("console"); 
   logger1.debug("debug!!!"); 
   logger1.info("info!!!"); 
   logger1.warn("warn!!!"); 
   logger1.error("error!!!"); 
   logger1.fatal("fatal!!!");
//在NT系統日誌輸出 
   Logger logger2 = Logger.getLogger("NTlog"); 
   //NTEventLogAppender nla = new NTEventLogAppender(); 
   logger2.debug("debug!!!"); 
   logger2.info("info!!!"); 
   logger2.warn("warn!!!"); 
   logger2.error("error!!!"); 
   //只有這個錯誤才會寫入2000日誌 
   logger2.fatal("fatal!!!");
//把日誌發送到mail 
   Logger logger3 = Logger.getLogger("MailLog"); 
   //SMTPAppender sa = new SMTPAppender(); 
   logger3.warn("warn!!!"); 
   logger3.error("error!!!"); 
   logger3.fatal("fatal!!!"); 
  } 
}