Log4j詳解與實戰

時間  2019-11-19
標籤 log4j log 詳解 實戰 欄目 Log4j 简体版
原文   原文鏈接

og4j是一個很是強大的log記錄軟件，下面咱們就來看看在項目中如何使log4j。javascript

 

首先固然是獲得log4j的jar檔，推薦使用1.2.X版，下載地址：html

http://logging.apache.org/log4j/1.2/download.htmljava

 

咱們先看一個最簡單的示例：程序員

【示例1】apache

項目結構：app



【注：因爲這裏的多個項目公用一個jar檔，咱們能夠建立一個專門放置jar檔的Java工程，而後將jar檔放到lib目錄下。在要使用的工程中按圖所示進行引用 】函數

Java代碼 佈局

package com.coderdream.log4j;  
  
import org.apache.log4j.Logger;  
  
public class HelloLog4j {  
  
    private static Logger logger = Logger.getLogger(HelloLog4j.class);  
  
    /** 
     * @param args 
     */  
    public static void main(String[] args) {  
        // System.out.println("This is println message.");  
          
        // 記錄debug級別的信息  
        logger.debug("This is debug message.");  
        // 記錄info級別的信息  
        logger.info("This is info message.");  
        // 記錄error級別的信息  
        logger.error("This is error message.");  
    }  
}  

  配置文件log4j.properties:spa

Properties代碼 .net

 

 

#能夠設置級別：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  

輸出結果：

[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個方面的內容：

一、根目錄（級別和目的地）；

二、目的地（控制檯、文件等等）；

三、輸出樣式。


下面咱們來看看Log4J的類圖：


 

Logger - 日誌寫出器，供程序員輸出日誌信息 
Appender - 日誌目的地，把格式化好的日誌信息輸出到指定的地方去 
ConsoleAppender - 目的地爲控制檯的Appender 
FileAppender - 目的地爲文件的Appender 
RollingFileAppender - 目的地爲大小受限的文件的Appender 
Layout - 日誌格式化器，用來把程序員的logging request格式化成字符串 
PatternLayout - 用指定的pattern格式化logging request的Layout


Log4j基本使用方法 

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

　　1、定義配置文件 

　　其實您也能夠徹底不使用配置文件，而是在代碼中配置Log4j環境。可是，使用配置文件將使您的應用程序更加靈活。Log4j支持兩種配置文件格式，一種是XML格式的文件，一種是Java特性文件（鍵=值）。下面咱們介紹使用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.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（將日誌信息以流格式發送到任意指定的地方）

　　3.配置日誌信息的格式（佈局），其語法爲： 

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

　　其中，Log4j提供的layout有以e幾種：
　　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平臺爲「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 ) ;

 

示例2～示例8

 

【示例2】 輸出爲文本文件或HTML文件

Porperties代碼 

 收藏代碼

  1. #設置級別：  
  2. log4j.rootLogger=debug,appender1  
  3.   
  4. #輸出到文件(這裏默認爲追加方式)  
  5. log4j.appender.appender1=org.apache.log4j.FileAppender  
  6. #設置文件輸出路徑  
  7. #【1】文本文件  
  8. #log4j.appender.appender1.File=c:/Log4JDemo02.log  
  9. #【2】HTML文件  
  10. log4j.appender.appender1.File=c:/Log4JDemo02.html  
  11. #設置文件輸出樣式  
  12. #log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  
  13. log4j.appender.appender1.layout=org.apache.log4j.HTMLLayout  

 

【 示例3】 輸出爲文本文件或HTML文件

Properties代碼 

 收藏代碼

  1. #設置級別和多個目的地  
  2. log4j.rootLogger=debug,appender1,appender2  
  3.   
  4. #輸出到控制檯  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #設置輸出樣式  
  7. log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout  
  8.   
  9. #輸出到文件(這裏默認爲追加方式)  
  10. log4j.appender.appender2=org.apache.log4j.FileAppender  
  11. #設置文件輸出路徑  
  12. #【1】文本文件  
  13. #log4j.appender.appender2.File=c:/Log4JDemo02.log  
  14. #【2】HTML文件  
  15. log4j.appender.appender2.File=c:/Log4JDemo02.html  
  16. #設置文件輸出樣式  
  17. #log4j.appender.appender2.layout=org.apache.log4j.TTCCLayout  
  18. log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout  

 

【示例4】 SimpleLayout樣式

Properties代碼 

 收藏代碼

  1. #設置級別和目的地  
  2. log4j.rootLogger=debug,appender1  
  3.   
  4. #輸出到控制檯  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #設置輸出樣式  
  7. log4j.appender.appender1.layout=org.apache.log4j.SimpleLayout  

  輸出結果：

控制檯代碼 

 收藏代碼

  1. DEBUG - This is debug message.  
  2. INFO - This is info message.  
  3. ERROR - This is error message.  

 

【示例5】 自定義樣式

Java代碼 

 收藏代碼

  1. #設置級別和目的地  
  2. log4j.rootLogger=debug,appender1  
  3.   
  4. #輸出到控制檯  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #設置輸出樣式  
  7. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  8. #自定義樣式  
  9. # %r 時間 0  
  10. # %t 方法名 main  
  11. # %p 優先級 DEBUG/INFO/ERROR  
  12. # %c 所屬類的全名(包括包名)  
  13. # %l 發生的位置，在某個類的某行  
  14. # %m 輸出代碼中指定的訊息，如log(message)中的message  
  15. # %n 輸出一個換行  
  16.   
  17. log4j.appender.appender1.layout.ConversionPattern=%r [%t] [%p] - %c -%l -%m%n  

輸出結果：

控制檯代碼 

 收藏代碼

  1. 0 [main] [DEBUG] - com.coderdream.log4j.HelloLog4j   
  2. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:16) -This is debug message.  
  3. 31 [main] [INFO] - com.coderdream.log4j.HelloLog4j   
  4. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:18) -This is info message.  
  5. 31 [main] [ERROR] - com.coderdream.log4j.HelloLog4j   
  6. -com.coderdream.log4j.HelloLog4j.main(HelloLog4j.java:20) -This is error message.  

 

【示例6】 多目的地、自定義樣式

Properties代碼 

 收藏代碼

  1. #設置級別和目的地  
  2. log4j.rootLogger=debug,appender1,appender2  
  3.   
  4. #輸出到控制檯  
  5. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  6. #設置輸出樣式  
  7. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  8. #自定義樣式  
  9. # %r 時間 0  
  10. # %t 方法名 main  
  11. # %p 優先級 DEBUG/INFO/ERROR  
  12. # %c 所屬類的全名(包括包名)  
  13. # %l 發生的位置，在某個類的某行  
  14. # %m 輸出代碼中指定的訊息，如log(message)中的message  
  15. # %n 輸出一個換行符號  
  16. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
  17.   
  18. #輸出到文件(這裏默認爲追加方式)  
  19. log4j.appender.appender2=org.apache.log4j.FileAppender  
  20. #設置文件輸出路徑  
  21. #【1】文本文件  
  22. log4j.appender.appender2.File=c:/Log4JDemo06.log  
  23. #設置文件輸出樣式  
  24. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
  25. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

 

【示例7】 【企業應用】設置 特定包的級別和目的地

先增長一個包，新建一個類：

Java代碼 

 收藏代碼

  1. package com.coderdream.log4jDao;  
  2.   
  3. import org.apache.log4j.Logger;  
  4.   
  5. public class HelloDao {  
  6.     private static Logger logger = Logger.getLogger(HelloDao.class);  
  7.   
  8.     /** 
  9.      * @param args 
  10.      */  
  11.     public static void main(String[] args) {  
  12.         // 記錄debug級別的信息  
  13.         logger.debug("This is debug message from Dao.");  
  14.         // 記錄info級別的信息  
  15.         logger.info("This is info message from Dao.");  
  16.         // 記錄error級別的信息  
  17.         logger.error("This is error message from Dao.");  
  18.     }  
  19. }  

      若是這個類做爲基類，如J2EE中的BaseDao、BaseAction、BaseService等等，則咱們能夠將各層的日誌信息分類輸出到各個文件。

 

Properties代碼 

 收藏代碼

  1. #省略根，只設置特定包的級別和目的地  
  2. log4j.logger.com.coderdream.log4j=debug,appender1  
  3. log4j.logger.com.coderdream.log4jDao=info,appender1,appender2  
  4.   
  5. #輸出到控制檯  
  6. log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
  7. #設置輸出樣式  
  8. log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
  9. #自定義樣式  
  10. # %r 時間 0  
  11. # %t 方法名 main  
  12. # %p 優先級 DEBUG/INFO/ERROR  
  13. # %c 所屬類的全名(包括包名)  
  14. # %l 發生的位置，在某個類的某行  
  15. # %m 輸出代碼中指定的訊息，如log(message)中的message  
  16. # %n 輸出一個換行符號  
  17. log4j.appender.appender1.layout.ConversionPattern=[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
  18.   
  19. #輸出到文件(這裏默認爲追加方式)  
  20. log4j.appender.appender2=org.apache.log4j.FileAppender  
  21. #設置文件輸出路徑  
  22. #【1】文本文件  
  23. log4j.appender.appender2.File=c:/Log4JDemo07_Dao.log  
  24. #設置文件輸出樣式  
  25. log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
  26. log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n  

 

【示例8】 log4j.xml的配置方式

Xml代碼 

 收藏代碼

  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">  
  3.   
  4. <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">  
  5.   
  6.     <appender name="appender1"  
  7.         class="org.apache.log4j.RollingFileAppender">  
  8.         <param name="File" value="logfile08.html" />  
  9.         <param name="MaxFileSize" value="1MB" />  
  10.         <param name="MaxBackupIndex" value="5" />  
  11.         <layout class="org.apache.log4j.HTMLLayout">  
  12.         </layout>  
  13.     </appender>  
  14.   
  15.     <root>  
  16.         <level value="debug" />  
  17.         <appender-ref ref="appender1" />  
  18.     </root>  
  19. </log4j:configuration>  

 

爲了提升效率，咱們能夠在寫日誌前增長判斷：

Java代碼 

 收藏代碼

  1. // 記錄debug級別的信息  
  2. if (logger.isDebugEnabled()) {  
  3.     logger.debug("This is debug message from Dao.");  
  4. }  
  5.   
  6. // 記錄info級別的信息  
  7. if (logger.isInfoEnabled()) {  
  8.     logger.info("This is info message from Dao.");  
  9. }  
  10.   
  11. // 記錄error級別的信息  
  12. logger.error("This is error message from Dao.");  

參考資料：

一、log4j 詳 解( 一)

二、log4j 詳解(二)

三、Log4j基本使用方法

四、Log4j 用法(一)

五、log4j.properties 使用說明

六、Apache Log4j詳解

七、log4j.xml配置詳解

八、log4j.xml配置詳解

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程