簡介

Log4J 是 Apache 的一個開源項目（官網(wǎng) http://jakarta.apache.org/log4j），通過在項目中使用 Log4J，我們可以控制日志信息輸出到控制臺、文件、GUI 組件、甚至是數(shù)據(jù)庫中。我們可以控制每一條日志的輸出格式，通過定義日志的輸出級別，可以更靈活的控制日志的輸出過程。方便項目的調(diào)試。

組成

Log4J 主要由 Loggers (日志記錄器)、Appenders（輸出端）和 Layout（日志格式化器）組成。其中 Loggers 控制日志的輸出級別與日志是否輸出；Appenders 指定日志的輸出方式（輸出到控制臺、文件等）；Layout 控制日志信息的輸出格式。

日志級別

Log4J 在 org.apache.log4j.Level 類中定義了OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL七種日志級別：

• OFF 最高日志級別，關(guān)閉左右日志
• FATAL 將會導致應用程序退出的錯誤
• ERROR 發(fā)生錯誤事件，但仍不影響系統(tǒng)的繼續(xù)運行
• WARN 警告，即潛在的錯誤情形
• INFO 一般和在粗粒度級別上，強調(diào)應用程序的運行全程
• DEBUG 一般用于細粒度級別上，對調(diào)試應用程序非常有幫助
• ALL 最低等級，打開所有日志記錄

注：一般只使用4個級別，優(yōu)先級從高到低為 ERROR > WARN > INFO > DEBUG

Appender（輸出端）

Appender 用來指定日志輸出到哪個地方，可以同時指定日志的輸出目的地。Log4j 常用的輸出目的地有以下幾種：

Layout（日志格式化器）

快速入門

首先在 maven 中引入 log4j 的依賴:

<dependency>
 <groupId>log4j</groupId>
 <artifactId>log4j</artifactId>
 <version>1.2.17</version>
</dependency>

創(chuàng)建 Log4jTest 類，測試 Log4j 的使用：

public class Log4JTest {
 
  public static void main(String[] args) {  
        //獲取Logger對象的實例     
        Logger logger = Logger.getLogger(Log4JTest.class);
    //使用默認的配置信息，不需要寫log4j.properties
    BasicConfigurator.configure();
    //設置日志輸出級別為WARN，這將覆蓋配置文件中設置的級別，只有日志級別高于WARN的日志才輸出
    logger.setLevel(Level.WARN);
    logger.debug("這是debug");
    logger.info("這是info");
    logger.warn("這是warn");
    logger.error("這是error");
    logger.fatal("這是fatal");
  }
 
}

這里首先通過 Logger.getLogger(Log4Test.class) 創(chuàng)建 Logger 實例，然后調(diào)用 BasicConfigurator.configure() 方法指定該 Logger 使用默認的配置信息，接著調(diào)用 looger.setLevel(Level.WARN) 設置 Logger 的日志輸出級別為 WARN 。運行 main 函數(shù)，控制臺將會輸出 warn 以上的錯誤信息。控制臺輸出如下：

0 [main] WARN com.huang.log4j.Log4JTest - 這是warn
0 [main] WARN com.huang.log4j.Log4JTest - 這是error
0 [main] WARN com.huang.log4j.Log4JTest - 這是fatal

注：如果沒有調(diào)用 BasicConfigurator.configure() 方法，則運行 main 函數(shù)的時候則會報錯，因為 Log4j 框架在運行的時候會加載項目路徑下的 log4j.properties 配置文件（關(guān)于配置文件的使用，會在后面講解）。而我們此時的項目中是沒有該文件的。如果配置文件的名稱不是 log4j.properties，則可以通過 PropertyConfigurator.configure(String configFilename) 指定配置文件的名稱。

格式化器的使用

修改 Log4JTest 中的代碼：

public class Log4JTest {
 
  public static void main(String[] args) {
    Logger logger = Logger.getLogger(Log4JTest.class);
    BasicConfigurator.configure();
    HTMLLayout layout = new HTMLLayout();
    // SimpleLayout layout = new SimpleLayout();
    try {
      FileAppender appender = new FileAppender(layout, "D:\\out.html", false);
      logger.addAppender(appender);
      //設置日志輸出級別為info，這將覆蓋配置文件中設置的級別，只有日志級別高于WARN的日志才輸出
      logger.setLevel(Level.WARN);
      logger.debug("這是debug");
      logger.info("這是info");
      logger.warn("這是warn");
      logger.error("這是error");
      logger.fatal("這是fatal");
    } catch (IOException e) {
      e.printStackTrace();
    }
  }
}

首先創(chuàng)建一個HTML格式的格式化器（HTMLLayout），然后創(chuàng)建文件輸出端（FileAppender）指定輸出端的格式為 HTML 格式，這里我指定輸出路徑為 D 盤下的 out.html 文件。然后通過 logger.addAppender(appender) 將文件輸出端加載到 Logger 中。運行 main 函數(shù)，在 D 盤下會生成一個 out.html 文件，打開文件，里面的信息就是代碼中輸出的日志信息：

log4j.properties配置文件的使用

上面使用代碼的方式設置 Logger 的輸出格式，這樣在我們每個要輸出日志的類上都得設置一遍配置未免也太麻煩了吧。有一種更加方便的方法，我們只需要在項目路徑下新建 log4j.properties 配置文件，并配置日志的輸出格式等信息，Log4J 框架會自動的加載配置文件，并將配置信息設置到 Logger 中。最簡單的配置文件如下：

# 控制臺輸出配置
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
 
# 文件輸出配置
log4j.appender.A = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A.File = D:/log.txt #指定日志的輸出路徑
log4j.appender.A.Append = true
log4j.appender.A.Threshold = DEBUG
log4j.appender.A.layout = org.apache.log4j.PatternLayout #使用自定義日志格式化器
log4j.appender.A.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss} [ %t:%r ] - [ %p ] %m%n #指定日志的輸出格式
log4j.appender.A.encoding=UTF-8 #指定日志的文件編碼
 
#指定日志的輸出級別與輸出端
log4j.rootLogger=DEBUG,Console,A

在 log4j.properties 配置文件中，我們定義了日志輸出級別與輸出端，在輸出端中分別配置日志的輸出格式。

log4j 采用類似 C 語言的 printf 函數(shù)的打印格式格式化日志信息，具體的占位符及其含義如下：

%m   輸出代碼中指定的日志信息

%p    輸出優(yōu)先級，及 DEBUG、INFO 等

%n    換行符（Windows平臺的換行符為 "\n"，Unix 平臺為 "\n"）

%r     輸出自應用啟動到輸出該 log 信息耗費的毫秒數(shù)

%c    輸出打印語句所屬的類的全名

%t     輸出產(chǎn)生該日志的線程全名

%d    輸出服務器當前時間，默認格式為 ISO8601，也可以在后面指定格式。如：%d{yyyy年MM月dd日 HH:mm:ss}

%l     輸出日志時間發(fā)生的位置，包括類名、發(fā)生的線程，以及在代碼中的行數(shù)，如：Test.main(Test.java:10)

%F    輸出日志消息產(chǎn)生時所在的文件名稱

%L    輸出代碼中的行號

%x    輸出和當前線程相關(guān)的 NDC（嵌套診斷環(huán)境）

%%   輸出一個 "%" 字符

可以在 % 與字符之間加上修飾符來控制最小寬度、最大寬度和文本的對其方式。如：

%5c    輸出category名稱，最小寬度是5，category<5，默認的情況下右對齊
%-5c   輸出category名稱，最小寬度是5，category<5，"-"號指定左對齊,會有空格
%.5c   輸出category名稱，最大寬度是5，category>5，就會將左邊多出的字符截掉，<5不會有空格
%20.30c   category名稱<20補空格，并且右對齊，>30字符，就從左邊交遠銷出的字符截掉

然后編寫測試類 Log4JTest.java ：

public class Log4JTest {
 
  public static void main(String[] args) {  
    //獲取Logger對象的實例     
    Logger logger = Logger.getLogger(Log4JTest.class);
    logger.debug("這是debug");
    logger.info("這是info");
    logger.warn("這是warn");
    logger.error("這是error");
    logger.fatal("這是fatal");
  }
}

程序運行后控制臺輸出文本：

2018-07-12 14:36:36,114 [main] WARN  [com.huang.log4j.Log4JTest] - 這是warn
2018-07-12 14:36:36,114 [main] ERROR [com.huang.log4j.Log4JTest] - 這是error
2018-07-12 14:36:36,114 [main] FATAL [com.huang.log4j.Log4JTest] - 這是fatal

并會在 D 盤生成一份 log.txt 文件。文本內(nèi)容如下：

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對腳本之家的支持。

最新評論