log4J日志器

jopen 9年前發布 | 44K 次閱讀日志處理 log4j

log4J日志器

在應用程序中輸出日志有有三個目的：

（1）監視代碼中變量的變化情況，把數據周期性地記錄到文件中供其他應用進行統計分析工作。

（2）跟蹤代碼運行進軌跡，作為日后審計的依據。

（3）擔當集成開發環境中的調試器，向文件或控制臺打印代碼的調試信息。

log4J日志器（http://jakarta.apache.org/log4j）
JDK1.4 Logging日志器(JDK1.4自帶)
SimpleLog日志器(把日志消息輸出到標準系統錯誤流System.err)
NoOpLog(不輸出任何日志信息)

通用日志包中的兩個常用接口：LogFactory和Log，分別介紹如下：
Log接口

通用日志包把消息分為6個級別：FATAL、ERROR、WARN、INFO、DEBUG和TRACE。其中FATAL級別最高，
TRACE級別最低。 Log接口提供輸出不同級別消息的方法：

off---------------------------------最高等級的，用于關閉所有日志記錄

fatal(Object message)-------輸出FATAL級別的消息。

error(Object message)-------輸出ERROR級別的消息。

warn(Object message)-------輸出WARN級別的消息。

info(Object message)-------輸出INFO級別的消息。

debug(Object message)-------輸出DEBUG級別的消息。

trace(Object message)-------輸出TRACE級別的消息。

all----------------------------------最低等級的，用于打開所有日志記錄

LogFactory接口

LogFactory接口提供了獲得日志器實例的兩個靜態方法：

public static Log getLog(String name) throws LogConfigurationException;

public static Log getLog(Class class) throws LogConfigurationException;

注：name參數作為日志器的名字；class參數指定類名作為日志器名字。

log4j三個組件

       通常，我們都提供一個名為 log4j.properties的文件，在第一次調用到Log4J時，Log4J會在類路徑
（../web-inf/class/當然也可以放到其它任何目錄，只要該目錄被包含到類路徑中即可）中定位這個文件，并讀入
這個文件完成的配置。這個配置文件告訴Log4J以什么樣的格式、把什么樣的信息、輸出到什么地方。
Log4j有三個主要的組件：Loggers(記錄器)，Appenders(輸出源)和Layouts(布局)，這里可簡單理解為日志
類別，日志要輸出的地方和日志以何種形式輸出。綜合使用這三個組件可以輕松的記錄信息的類型和級別，并可
以在運行時控制日志輸出的樣式和位置。下面對三個組件分別進行說明：

1、 Loggers
Loggers組件在此系統中被分為五個級別：DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序
的，DEBUG < INFO < WARN < ERROR < FATAL，分別用來指定這條日志信息的重要程度,明白這一點很重要，
這里Log4j有一個規則：假設Loggers級別為P，如果在Loggers中發生了一個級別Q比P高，則可以啟動，否則屏蔽掉。
假設你定義的級別是info，那么error和warn的日志可以顯示而比他低的debug信息就不顯示了。

Java程序舉例來說：

//建立Logger的一個實例，命名為“com.foo”
Logger　logger = Logger.getLogger("com.foo"); //"com.foo"是實例進行命名，也可以任意
//設置logger的級別。通常不在程序中設置logger的級別。一般在配置文件中設置。
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
//下面這個請求可用，因為WARN >= INFO
logger.warn("Low fuel level.");
//下面這個請求不可用，因為DEBUG < INFO
logger.debug("Starting search for nearest gas station.");
//命名為“com.foo.bar”的實例barlogger會繼承實例“com.foo”的級別。因此，下面這個請求可用，因為INFO >= INFO
barlogger.info("Located nearest gas station.");
//下面這個請求不可用，因為DEBUG < INFO
barlogger.debug("Exiting gas station search");
這里“是否可用”的意思是能否輸出Logger信息。
在對Logger實例進行命名時，沒有限制，可以取任意自己感興趣的名字。一般情況下建議以類的所在位置來
命名Logger實例，這是目前來講比較有效的Logger命名方式。這樣可以使得每個類建立自己的日志信息，便于管理。
比如：

static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());

2、Appenders
禁用與使用日志請求只是Log4j其中的一個小小的地方，Log4j日志系統允許把日志輸出到不同的地方，
如控制臺（Console）、文件（Files）、根據天數或者文件大小產生新的文件、以流的形式發送到其它地方等等。

其語法表示為：

org.apache.log4j.ConsoleAppender（控制臺）
org.apache.log4j.FileAppender（文件）
org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件）
        org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方）

配置時使用方式為：
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
       log4j.appender.appenderName.option = valueN
這樣就為日志的輸出提供了相當大的便利。

3、Layouts
有時用戶希望根據自己的喜好格式化自己的日志輸出。Log4j可以在Appenders的后面附加Layouts來完成
       這個功能。Layouts提供了四種日志輸出樣式，如根據HTML樣式、自由指定樣式、包含日志級別與信息的樣式
       和包含日志時間、線程、類別等信息的樣式等等。

其語法表示為：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以靈活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串），
org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息）

配置時使用方式為：

log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN

log4j基本編程方法

以上是從原理方面說明Log4j的使用方法，在具體Java編程使用Log4j可以參照以下示例：

1、建立Logger實例：
語法表示：public static Logger getLogger( String name)
實際使用：static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;

2、讀取配置文件：
獲得了Logger的實例之后，接下來將配置Log4j使用環境：
語法表示：
BasicConfigurator.configure()：自動快速地使用缺省Log4j環境。
PropertyConfigurator.configure(String configFilename)：讀取使用Java的特性文件編寫的配置文件。
DOMConfigurator.configure(String filename)：讀取XML形式的配置文件。
實際使用：
PropertyConfigurator.configure("ServerWithLog4j.properties");

3、插入日志信息
完成了以上連個步驟以后，下面就可以按日志的不同級別插入到你要記錄日志的任何地方了。
語法表示：
Logger.debug(Object message);//調試信息
Logger.info(Object message);//一般信息
Logger.warn(Object message);//警告信息
Logger.error(Object message);//錯誤信息
Logger.fatal(Object message);//致命錯誤信息

實際使用：logger.info("ServerSocket before accept: " + server);

log4j配置文件

在實際編程時，要使Log4j真正在系統中運行事先還要對配置文件進行定義。定義步驟就是對Logger、
Appender及Layout的分別使用。
    Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是java properties（key=value）
【Java特性文件（鍵=值）】。下面我們介紹使用Java特性文件做為配置文件的方法
   具體如下：

1、配置根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

2、配置日志信息輸出目的地，其語法為：
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、配置日志信息的格式，其語法為：
1). 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

       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字符，
就從左邊交遠銷出的字符截掉。

這里上面三個步驟是對前面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
根據上面的日志格式，某一個程序的輸出結果如下：
0　　INFO　2003-06-13 13:23:46968 ClientWithLog4j Client socket:
Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says:
‘Java server with log4j, Fri Jun 13 13:23:46 CST 2003‘
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: ‘Command ‘HELLO‘ not understood.‘
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: ‘Vocabulary: HELP QUIT‘
16　 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT

4. 當輸出信息于回滾文件時

           log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender   //指定以文件的方式輸出日志
            log4j.appender.ROLLING_FILE.Threshold=ERROR
            log4j.appender.ROLLING_FILE.File=rolling.log //文件位置,也可以用變量、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全能配置文件(轉自gmmgood)

下面給出得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
log4j.appender.MAIL.From=chenyl@hollycrm.com
log4j.appender.MAIL.SMTPHost=mail.hollycrm.com
log4j.appender.MAIL.Subject=Log4J Message
log4j.appender.MAIL.To=chenyl@hollycrm.com
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 = 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

本文由用戶 jopen 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。

轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。

本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！

本文地址：http://www.baiduhome.net/lib/view/open1420789451515.html

日志處理 log4j

log4J日志器

相關經驗

相關資訊

相關文檔

目錄