Log4j學習

Log4j文檔

 

Log4j由三個重要的組件構成：日誌信息的優先級，日誌信息的輸出目的地，日誌信息的輸出格式。日誌信息的優先級從高到低有ERROR、WARN、INFO、DEBUG，分別用來指定這條日誌信息的重要程度；日誌信息的輸出目的地指定了日誌將打印到控制檯還是文件中；而輸出格式則控制了日誌信息的顯示內容。

 

一、       定義配置文件

 Log4j支持兩種配置文件格式，一種是Java特性文件(properties格式的屬性文件)，一種是XML格式的文件。

 

1.    以Java特性文件(properties格式的屬性文件)做爲配置文件

 Java特性文件也位於WEB-INF/classes目錄下，下面是一個Java特性文件(properties格式的屬性文件)的例子：

 

 

# For JBoss: Avoid to setup log4j outside $JBOSS_HOME/server/default/deploy/log4j.xml

# For all other servers: Comment out the Log4J listener in web.xml too

 

log4j.configuration=log4j.properties

 

log4j.rootCategory=info, stdout, logfile

 

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - <%m>%n

 

log4j.appender.logfile=org.apache.log4j.RollingFileAppender

log4j.appender.logfile.File=D:/temp/SpringMVC.log

log4j.appender.logfile.MaxFileSize=512KB

# Keep three backup files

log4j.appender.logfile.MaxBackupIndex=3

log4j.appender.logfile.layout=org.apache.log4j.PatternLayout

# Pattern to output: date priority [category] - <message>line_separator

log4j.appender.logfile.layout.ConversionPattern=%d %p [%c] - <%m>%n

 

#log4j.logger.com.opensymphony.oscache=ERROR

#log4j.logger.net.sf.navigator=ERROR

#log4j.logger.org.apache.commons=ERROR

#log4j.logger.org.apache.struts=WARN

#log4j.logger.org.displaytag=ERROR

log4j.logger.org.springframework=WARN

#log4j.logger.com.ibatis.db=WARN

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  當Tomcat服務器啓動時自動加載.properties配置文件。

其中，

log4j.configuration=log4j.properties 是指定配置文件的名字。

log4j.rootCategory= [ level ] , appenderName, appenderName, …是配置根Logger。

level 是日誌記錄的優先級，分爲OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這裏定義的級別，您可以控制到應用程序中相應級別的日誌信息的開關。比如在這裏定義了INFO級別，則應用程序中所有DEBUG級別的日誌信息將不被打印出來，默認日誌級別是ERROR；appenderName就是指定Appender組件，確定日誌輸出目的地。如上例：log4j.rootCategory=info, stdout, logfile 配置根Logger的級別是INFO，日誌輸出的目的地是stdout, logfile。

 

    log4j.appender. appenderName =org.apache.log4j.ConsoleAppender是配置日誌信息輸出目的地Appender。

 Log4j提供的appender有以下幾種：
　　org.apache.log4j.ConsoleAppender（控制檯），
　　org.apache.log4j.FileAppender（文件），
　　org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌文件），
　　org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），
　　org.apache.log4j.WriterAppender（將日誌信息以流格式發送到任意指定的地方）

 

   log4j.appender.appenderName.layout=org.apache.log4j.PatternLayout 配置日誌信息的格式（佈局）

  Log4j提供的layout有以下幾種：
　　org.apache.log4j.HTMLLayout（以HTML表格形式佈局），
　　org.apache.log4j.PatternLayout（可以靈活地指定佈局模式），
　　org.apache.log4j.SimpleLayout（包含日誌信息的級別和信息字符串），
　　org.apache.log4j.TTCCLayout（包含日誌產生的時間、線程、類別等等信息）

 

   log4j.appender. appenderName.layout.ConversionPattern=%d %p [%c] - <%m>%n 是設置打印格式格式化日誌信息。

打印參數如下：

%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)

 

  如果log4j.appender. appenderName屬性配置的日誌輸出目的地是一個文件是，還有以下屬性：

    log4j.appender. appenderName.File=D:/temp/SpringMVC.log 配置日誌文件的名稱。即存放日誌的文件。

    log4j.appender. appenderName.MaxFileSize=512KB 配置日誌文件的大小，最大可以設置爲10M。

    log4j.appender. appenderName.MaxBackupIndex=3 配置可有日誌文件的個數。

 

 Log4j.logger<.logger.name>= level 指定Logger.name這個記錄器的級別。即，logger只輸出這個級別或高出這個級別的日誌。如： 

log4j.logger.org.springframework=WARN 是配置Logger只輸出關於org.springframework的WARN級別的日誌和ERROR和FATAL級別的日誌。

    log4j.logger.org.displaytag=ERROR 是配置Logger只輸出關於displaytag的ERROR 和FATAL級別的日誌。

 

  如果將日誌以郵件的形式發送出去時得有以下屬性:

log4j.appender.mail=org.apache.log4j.net.SMTPAppender 配置日誌輸出目的地是電子郵箱

log4j.appender.mail.To= [email protected]        設置日誌將要輸出到的電子郵箱

[email protected] 設置發送日誌信息的電子郵箱

log4j.appender.mail.SMTPHost=localhost             設置運行SMTP守護程序的主機的IP地址名稱

log4j.appender.mail.Threshold=ERROR                設置記錄日誌的最低級別

log4j.appender.mail.BufferSize=1                   設置寫郵件的緩存大小

log4j.appender.mail.Subject=[localhost]dlhitech Application Error  設置電子郵件標題

     如果將日誌輸出到數據庫日誌表時有以下屬性:

log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender    配置日誌輸出目的地是數據庫
log4j.appender.DATABASE.URL=jdbc:oracle:thin:@192.168.1.10:1521:SCSORA   配置連接數據庫的url
log4j.appender.DATABASE.driver=oracle.jdbc.drivers.OracleDrivers       配置連接數據庫的驅動器
log4j.appender.DATABASE.user=newsinfo                                 配置連接數據庫的用戶名
log4j.appender.DATABASE.password=newsinfo                             配置連接數據庫的密碼
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                                                       設置打印格式格式化日誌信息。

 

 

2.以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="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">

     <param name="threshold" value="error"/>

     <layout class="org.apache.log4j. PatternLayout">

</layout>

  </appender>

  

<!—封裝apache ，這樣，可以在java程序中的

Category cat2 = Category.getInstance("your.category.name");來進行輸出日誌-->

<category name="org.apache">      --設置封裝的名稱

<priority value="info" />     --輸出指定級別的日誌

<appender-ref ref="aplog"/>   --設置輸出的目的地

</category>

<root>

     <level value ="debug" />

     <appender-ref ref="ConsoleAppender"/>

<appender-ref ref=" rollingFile.log "/> <!-- 經過過濾只記錄error級別的日誌 -->

  </root>

</log4j:configuration>

 

 

二．調用Log4j來輸出日誌

 通過訪問通用日誌接口和在java程序手動打開配置文件都可以進行日誌的輸出。其中，通過訪問通用日誌接口來指定日誌器時，Log4j的配置文件只能是java特定文件(.properties屬性文件)。

 

1.通過訪問通用日誌接口來輸出日誌

 當Tomcat服務器啓動時，通用日誌接口從名爲“commons-logging.properties”的屬性文件中獲取實現日誌接口日誌器信息，這個文件位於WEB-INF/classes目錄下。“commons-logging.properties”屬性文件的內容：

 

 

org.apache.commons.logging.Log=org.apache.commons.logging.impl.Log4JCategoryLog

 

 當Tomcat服務器運行時，通用日誌接口會檢索commons-logging.properties文件，並且實例化由“org.apache.commons.logging.Log”屬性指定的日誌實現例。上面給的日誌器是Log4J日誌器。

 Tomcat服務器會自動加載.properties配置文件。

 調用Log4j輸出日誌 如下例：

  import org.apache.commons.logging.Log;

  

public class Test{

      public static void main(args[] String){

    Log logger = LogFactory.getLog(“test”);

    logger.info("開始操作");

    int a = 5;

    int b = 6;

    System.out.println(a+b);

    logger.info("操作完畢");

}

}

 

2.手動打開配置文件輸出日誌

 程序員用手動打開配置文件來輸出日誌時，得先打開配置文件然後才能進行輸出日誌操作。由於Log4J的配置文件可以是java特性文件(.properties屬性文件)和.xml文件，所以打開配置文件的方式就不相同。當配置文件是java特性文件(.properties屬性文件)時，打開配置文件的方法是：

 

PropertyConfigurator.configure ( String configFilename);

 

當配置文件是.xml文件時，打開配置文件的方法是：

 

DOMConfigurator.configure ( String filename );

 

當打開配置文件後，配置文件就一直打開着，所以配置文件就打開一遍就可以了。

 打開配置文件後，構造Logger對象然後輸出日誌信息，以配置文件是.xml文件爲例，輸出信息實例如下：

 

import org.apache.log4j.Logger;

import org.apache.log4j.xml.DOMConfigurator;  

public class Test{

      public static void main(args[] String){

          DOMConfigurator.configure ( String filename )；

          Logger logger = Logger.getRootLogger();

          logger.info("開始操作");

          int a = 5;

          int b = 6;

         System.out.println(a+b);

         logger.info("操作完畢");

}

}

 

2.不通過配置文件手動輸出日誌

 使用Log4J來輸出日誌不一定非得通過配置文件來輸出日誌，也可以不通過配置文件來輸出日誌，手動在程序中創建Appender、Layout等對象，只不過這樣做會在java程序用留下很大的代碼量。下面是一個不通過配置文件手動輸出日誌的實例，程序實現了PatternLayout和FileAppender：

     import org.apache.log4j.Level;

import org.apache.log4j.Logger;

import org.apache.log4j.SimpleLayout;

import org.apache.log4j.FileAppender;

public class simpandfile {

         static Logger logger = Logger.getLogger(simpandfile.class);

         public static void main(String args[]) {

           String pattern = "Milliseconds since program start: %r %n";

                   pattern += "Classname of caller: %C %n";

                   pattern += "Date in ISO8601 format: %d{ISO8601} %n";

                   pattern += "Location of log event: %l %n";

                   pattern += "Message: %m %n %n";

           PatternLayout layout = new PatternLayout(pattern);

           FileAppender appender = null;

             try {

                 appender = new FileAppender(layout,"output1.txt",false);

              } catch(Exception e) {}

              logger.addAppender(appender);

              logger.setLevel((Level) Level.DEBUG);

              logger.debug("Here is some DEBUG");

              logger.info("Here is some INFO");

              logger.warn("Here is some WARN");

              logger.error("Here is some ERROR");

              logger.fatal("Here is some FATAL");

        }

}