org.apache.log4j.Logger詳解

本文轉載自查看原文 2018-08-12 21:28 1049 Java

1、簡介

應用程序中添加日志記錄有三個作用：

1、監視代碼中變量的變化情況，周期性的記錄到文件中供其他應用進行統計分析工作；

2、跟蹤代碼運行時軌跡，作為日后審計的依據；

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

　　比較好的做法就是構造一個日志操作類來封裝此類操作，而不是讓一系列的打印語句充斥了代碼的主體。

使用 Log4j ：

可以控制日志信息輸送的目的地是控制台、文件、 GUI 組件、甚至是套接口服務器、 NT 的事件記錄器、 UNIX Syslog 守護進程等；

可以控制每一條日志的輸出格式；

可以通過定義每一條日志信息的級別，能夠更加細致地控制日志的生成過程。

2、簡單例子

#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

　　通過配置文件可知，我們需要配置 3 個方面的內容：

　　1 、優先級：日志信息的重要程度，日志將打印到控制台還是文件中

　　2 、目的地（控制台、文件等等）：日志將打印到控制台還是文件中

　　3 、輸出樣式：控制了日志信息的顯示內容

Logger        日志寫出器 ，供程序員輸出日志信息 
Appender    日志目的地 ，把格式化好的日志信息輸出到指定的地方去 
Layout         日志格式化器 ，用來把程序員的 logging request 格式化成字符串

3、Log4j基本用法

日志信息的優先級從高到低有 ERROR 、 WARN 、 INFO 、 DEBUG ，

配置日志信息輸出目的地 Appender ，其語法為：
　　 log4j.appender.appenderName = fully.qualified.name.of.appender.class. 其中， Log4j 提供的appender 有以下幾種：
　　        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
　　其中， Log4j 提供的 layout 有以 e 幾種：
　　        1.org.apache.log4j.HTMLLayout （以 HTML 表格形式布局），
　　        2.org.apache.log4j.PatternLayout （可以靈活地指定布局模式），
　　        3.org.apache.log4j.SimpleLayout （包含日志信息的級別和信息字符串），
　　        4.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)

在代碼中使用 Log4j
　　 1. 得到記錄器
　　第一步就是獲取日志記錄器，記錄器將負責控制日志信息。其語法為：
　　 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 ) ;

輸出HTML文件

# 設置級別：   
log4j.rootLogger=debug,appender1    
log4j.appender.appender1=org.apache.log4j.FileAppender  
# 設置文件輸出路徑   
log4j.appender.appender1.File=c:/Log4JDemo02.html  
# 設置文件輸出樣式   
log4j.appender.appender1.layout=org.apac he.log4j.HTMLLayout

　輸出文本與HTML文件

# 設置級別和多個目的地   
log4j.rootLogger=debug,appender1,appender2    
# 輸出到控制台   
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
log4j.appender.appender1.layout=org.apache.log4j.TTCCLayout    
# 輸出到文件 ( 這里默認為追加方式 )  
log4j.appender.appender2=org.apache.log4j.FileAppender  
log4j.appender.appender2.File=c:/Log4JDemo02.html  
log4j.appender.appender2.layout=org.apache.log4j.HTMLLayout

　自定義樣式

# 設置級別和目的地   
log4j.rootLogger=debug,appender1    
# 輸出到控制台   
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
# 設置輸出樣式   
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
# 自定義樣式   
log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n

# 自定義樣式
# %r 時間 0
# %t 方法名 main
# %p 優先級 DEBUG/INFO/ERROR
# %c 所屬類的全名 ( 包括包名 )
# %l 發生的位置，在某個類的某行
# %m 輸出代碼中指定的訊息，如 log(message) 中的 message
# %n 輸出一個換行
log4j.appender.appender1.layout.ConversionPattern =%r [%t] [%p] - %c -%l -%m%n

輸出結果：

0 [main] [DEBUG] - com.smart.test.HelloLog4j -com.smart.test.HelloLog4j.main(HelloLog4j.java:10) -This is debug message
 4 [main] [INFO] - com.smart.test.HelloLog4j -com.smart.test.HelloLog4j.main(HelloLog4j.java:12) -This is info message
 4 [main] [ERROR] - com.smart.test.HelloLog4j -com.smart.test.HelloLog4j.main(HelloLog4j.java:14) -This is error message

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

新增一個包與類

package com.smart.test.Log4jDao;

import com.smart.test.HelloLog4j;
import org.apache.log4j.Logger;

public class Log4jDao {
    private static Logger logger= Logger.getLogger(Log4jDao.class);

    public static void main(String[] args){
        logger.debug("This is debug message");

        logger.info("This is info message");

        logger.error("This is error message");
    }
}

log4j.logger.com.smart.test.Log4jDao=debug,appender1,appender2
log4j.appender.appender1=org.apache.log4j.ConsoleAppender  
log4j.appender.appender1.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender1.layout.ConversionPattern =[%d{yy/MM/dd HH:mm:ss:SSS}][%C-%M] %m%n  
# 輸出到文件 ( 這里默認為追加方式 )
log4j.appender.appender2=org.apache.log4j.FileAppender  
log4j.appender.appender2.File=d:/Log4JDemo07_Dao.log  
log4j.appender.appender2.layout=org.apache.log4j.PatternLayout  
log4j.appender.appender2.layout.ConversionPattern=[%d{HH:mm:ss:SSS}][%C-%M] -%m%n

log4j.xml 的配置方式

<?xml version="1.0" encoding="GB2312" ?>
<!DOCTYPE log4j:configuration SYSTEM "http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/xml/doc-files/log4j.dtd">

<log4j:configuration debug="true">
    <appender name="appender1"
              class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="d:/logfile08.html" />
        <param name="MaxFileSize" value="1MB" />
        <param name="MaxBackupIndex" value="5" />
        <layout class="org.apache.log4j.HTMLLayout">
        </layout>
    </appender>
    <root>
        <level value="debug" />
        <appender-ref ref="appender1" />
    </root>
</log4j:configuration>

　　為提高效率可以增加判斷

//  記錄 debug 級別的信息   
if (logger.isDebugEnabled ()) {  
    logger.debug("This is debug message from Dao.");  
}    
//  記錄 info 級別的信息   
if (logger.isInfoEnabled ()) {  
    logger.info("This is info message from Dao.");  
}    
//  記錄 error 級別的信息   
logger.error("This is error message from Dao.");

配置日志信息輸出目的地，其語法為：

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 比較全面的配置

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 
 www.wuset.com ">log4j.appender.MAIL.From=web@www.wuset.com 
 log4j.appender.MAIL.SMTPHost=www.wusetu.com 
 log4j.appender.MAIL.Subject=Log4J Message 
 www.wusetu.com ">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

　　參考文檔：https://www.cnblogs.com/liaojie970/p/7634838.html

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。