Log4j

Log4j是一款基於Java的開源日誌組件，Log4j功能很是強大，咱們能夠將日誌信息輸出到控制檯、文件、用戶界面，也能夠輸出到操做系統的事件記 錄器和一些系統常駐進程。更值得一提的是，Log4j能夠容許你很是便捷地自定義日誌格式和日誌等級，能夠幫助開發人員全方位地掌控日誌信息。

1、概要介紹
        log4j是Apache的一個開放源代碼項目，經過使用log4j，咱們能夠控制日誌信息輸送的目的地是控制檯、文件、GUI組件、甚 至是socket服務器、NT的事件記錄器、UNIX Syslog守護進程等；咱們也能夠控制每一條日誌的輸出格式；經過定義每一條日誌信息的級別，咱們可以更加細緻地控制日誌的生成過程。 
        log4j由三個重要的組件構成：日誌信息的優先級，日誌信息的輸出目的地，日誌信息的輸出格式。日誌信息的優先級從高到低有 ERROR、WARN、 INFO、DEBUG，分別用來指定這條日誌信息的重要程度；日誌信息的輸出目的地指定了日誌將打印到控制檯仍是文件中；而輸出格式則控制了日誌信息的顯 示內容。 
        log4j對日誌系統抽象出logger、logger工廠、appender、日誌級別、日誌格式等核心概念，這幾個概念被普遍借鑑於其它日誌系統的設計，經久不衰，其核心類圖以下：

圖1 log4j核心類圖

2、配置文件 
        log4j支持兩種配置文件格式，一種是XML格式的文件，一種是properties格式的文件。下面以使用properties格式作爲配置文件爲例說明之： 
        log4j.rootLogger=INFO, 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 
一、配置根Logger
        其語法格式以下： 
        log4j.rootLogger = [ level ] , appenderName, appenderName, … 
        其中，level是日誌記錄的優先級，分爲OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。 log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。經過在這裏定義的級別，您能夠控制到應用程序中相應級 別的日誌信息的開關。好比在這裏定義了INFO級別，則應用程序中全部DEBUG級別的日誌信息將不被打印出來。 
        appenderName就是指定日誌信息輸出到哪一個地方。您能夠同時指定多個輸出目的地。 
二、配置日誌信息輸出目的地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（將日誌信息以流格式發送到任意指定的地方） 
        （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.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.appender.A1.layout.ConversionPattern設置日誌輸出格式，參數以下： 
        %p：輸出日誌信息優先級，即DEBUG、INFO、WARN、ERROR、FATAL
        %d：輸出日誌時間點的日期或時間，默認格式爲ISO8601，也能夠在其後指定格式，好比：%d{yyy MMM dd HH:mm:ss,SSS}，輸出相似：2014年04月13日 20:15: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配置文件實現了輸出到控制檯、文件、回滾文件、發送日誌郵件、輸出到數據庫日誌表、自定義標籤等全套功能，下面列出經常使用配置，擇其一二使用就能夠了：
        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
        log4j.appender.MAIL.From=web@www.wuset.com
        log4j.appender.MAIL.SMTPHost=www.wusetu.com
        log4j.appender.MAIL.Subject=Log4J Message
        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

實例描述以下：

能夠在數據庫中輸出日誌信息：創建表以下

create table log4j
(
    logId int not null auto_increment,--流水號
    createDate varchar(45) default null,--日誌生成時間
    thread varchar(45) default null,--當前線程
    level varchar(45) default null,--當前日誌的級別
    class varchar(45) default null,--生成日誌的類
    message varchar(245) default null,--日誌具體信息
    
    primary key(logId)
)

第一步：編寫配置文件myLog4j.properties:

log4j.appender.A1.layout.ConversionPattern=%4p [%t] (%F:%L) - %m%n

#定義A2輸出到文件
log4j.appender.A2=org.apache.log4j.RollingFileAppender
#定義A2輸出到哪一個文件
log4j.appender.A2.File=./logRecord.log
#定義A2輸出文件的最大長度
log4j.appender.A2.MaxFileSize = 1KB
#定義A2的備份文件數
log4j.appender.A2.MaxBackupIndex = 3
#定義A2的佈局模式爲PatternLayout
log4j.appender.A2.layout=org.apache.log4j.PatternLayout
#定義A2的輸出模式
log4j.appender.A2.layout.ConversionPattern=%d{yyyy-MM-dd hh:mm:ss}:%p %t %c - %m%n

#定義A3輸出到數據庫
log4j.appender.A3=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.A3.URL=jdbc:mysql://localhost:3306/study
log4j.appender.A3.driver=com.mysql.jdbc.Driver
log4j.appender.A3.user=root
log4j.appender.A3.password=root
#定義A3的佈局和執行的SQL語句
log4j.appender.A3.layout=org.apache.log4j.PatternLayout
log4j.appender.A3.layout.ConversionPattern=INSERT INTO log4j(createDate,thread,level,class,message) values(\'%d\',\'%t\',\'%-5p\',\'%c\',\'%m\')

第二步：java程序：

package com.sk.Test;

import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;

public class LogTest {
    public static Logger log = Logger.getLogger(LogTest.class.getName());
      public static void main(String[] args) {
            PropertyConfigurator.configure("src/log4j.properties");
            log.debug("yes,debug");
            log.info("yes,info");
            log.error("yes,errror");
            log.warn("yes,warn");

            
/*            //使用默認的配置信息，不須要寫log4j.properties
            BasicConfigurator.configure();
            //設置日誌輸出級別爲info，這將覆蓋配置文件中設置的級別
            log.setLevel(Level.INFO);
            //下面的消息將被輸出
            log.info("this is an info");
            log.warn("this is a warn");
            log.error("this is an error");
            log.fatal("this is a fatal");*/

        }

    }

這樣當咱們運行該程序的時候會同時將上述日誌信息轉入到三個地方：
控制檯：

數據庫：

文件：

 

 

引用自：http://www.cnblogs.com/eflylab/archive/2007/01/12/618080.html