日志管理-log4j與slf4j的使用

一、概述

1、log4j：

Log4j是Apache的一個開源項目，通過使用Log4j，我們可以控制日志信息輸送的目的地是控制台、文件、GUI組件，甚至是套接口服務器、NT的事件記錄器、UNIX Syslog守護進程等；我們也可以控制每一條日志的輸出格式；通過定義每一條日志信息的級別，我們能夠更加細致地控制日志的生成過程。最令人感興趣的就是，這些可以通過一個配置文件來靈活地進行配置，而不需要修改應用的代碼。

 

2、slf4j：

SLF4J，即簡單日志門面（Simple Logging Facade for Java），不是具體的日志解決方案，它只服務於各種各樣的日志系統。按照官方的說法，SLF4J是一個用於日志系統的簡單Facade，允許最終用戶在部署其應用時使用其所希望的日志系統。實際上，SLF4J所提供的核心API是一些接口以及一個LoggerFactory的工廠類。從某種程度上，SLF4J有點類似JDBC，不過比JDBC更簡單，在JDBC中，你需要指定驅動程序，而在使用SLF4J的時候，不需要在代碼中或配置文件中指定你打算使用那個具體的日志系統。如同使用JDBC基本不用考慮具體數據庫一樣，SLF4J提供了統一的記錄日志的接口，只要按照其提供的方法記錄即可，最終日志的格式、記錄級別、輸出方式等通過具體日志系統的配置來實現，因此可以在應用中靈活切換日志系統。

 

二、實踐

1、導入對應的jar包,推薦使用maven工程導入。

 

　　a、使用傳統jar的方式引入

                                                                    

 　　

　　b、使用maven工程導入

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.turtle</groupId>
  <artifactId>log</artifactId>
  <version>1.0-SNAPSHOT</version>

  <name>log</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!-- https://mvnrepository.com/artifact/log4j/log4j -->
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.17</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.25</version>
    </dependency>

  </dependencies>

</project>

 

 

 2、編寫測試代碼：

package com.turtle.log; import com.turtle.OutputStreamUtil; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import java.text.SimpleDateFormat; import java.util.Date; public class TestLog_01 { private final static Logger logger = LoggerFactory.getLogger(TestLog_01.class); public static void main(String[] args) { logger.info("programer processing......"); try{ // 會產生除以0的異常信息
            System.out.println(1/0); }catch (Exception e){ // 將異常信息打印到日志文件中去
            String exception = new OutputStreamUtil().util(e); // 輸出日志文件
            logger.error("Programer error:"+ exception+"\t"+"【"+new SimpleDateFormat("yyyy-MM-dd/HH.mm.ss").format(new Date())+"】"); } logger.debug("start Debug detail......"); } }

 

3、配置文件

### set log levels ###
log4j.rootLogger = DEBUG,stdout,D,E

# 配置日志信息輸出目的地
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
# Target是輸出目的地的目標
log4j.appender.stdout.Target = System.out
# 指定日志消息的輸出最低層次
log4j.appender.stdout.Threshold = INFO
# 定義名為stdout的輸出端的layout類型
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
# 如果使用pattern布局就要指定的打印信息的具體格式ConversionPattern
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n



# 名字為D的對應日志處理
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
# File是輸出目的地的文件名
log4j.appender.D.File = LOG//app_debug.log
#false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.TTCCLayout



# 名字為E的對應日志處理
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = LOG//app_error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

 

 

三、詳細解釋

1、log4j定義了8個級別的log（除去OFF和ALL，可以說分為6個級別）

優先級從高到低依次為：OFF、FATAL、ERROR、WARN、INFO、DEBUG、TRACE、 ALL。

• 　　　　ALL LEVEL 最低等級的，用於打開所有日志記錄。
• 　　　　TRACE 很低的日志級別，一般不會使用。
• 　　　　DEBUG 指出細粒度信息事件對調試應用程序是非常有幫助的，主要用於開發過程中打印一些運行信息。
• 　　　　INFO 消息在粗粒度級別上突出強調應用程序的運行過程。打印一些你感興趣的或者重要的信息，這個可以用於生產環境中輸出程序運行的一些重要信息，但是不能濫用，避免打印過多的日志。
• 　　　　WARN 表明會出現潛在錯誤的情形，有些信息不是錯誤信息，但是也要給程序員的一些提示。
• 　　　　ERROR 指出雖然發生錯誤事件，但仍然不影響系統的繼續運行。打印錯誤和異常信息，如果不想輸出太多的日志，可以使用這個級別。
• 　　　　FATAL 指出每個嚴重的錯誤事件將會導致應用程序的退出。這個級別比較高了。重大錯誤，這種級別你可以直接停止程序了。
• 　　　　OFF LEVEL 最高等級的，用於關閉所有日志記錄。

　　如果將log level設置在某一個級別上，那么比此級別優先級高的log都能打印出來。例如，如果設置優先級為WARN，那么OFF、FATAL、ERROR、WARN 4個級別的log能正常輸出，而INFO、DEBUG、TRACE、 ALL級別的log則會被忽略。Log4j建議只使用四個級別，優先級從高到低分別是ERROR、WARN、INFO、DEBUG。

 

2、rootLogger = DEBUG,stdout,D,E   #配置根logger，

基本格式為 log4j.rootLogger = LEVEL, appenderName1 ,  appenderName2  ，只能有一個等級的哦，不能存在多個等級，否則會報錯

 

3、log4j.appender.stdout=org.apache.log4j.ConsoleAppender  #配置日志信息輸出目的地Appender

• 　　org.apache.log4j.ConsoleAppender（控制台）
• 　　org.apache.log4j.FileAppender（文件）
• 　　org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件）
• 　　org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件）
• 　　org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方）

 

4、Target , File 分別就是輸出目的地的目標、文件名啦。此處可將相應的內容寫到相應的目的地及文件中.

 

5、Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容。

 

6、Threshold=DEBUG:指定日志消息的輸出最低層次。

　　應當注意每個appender的級別應該是不同的，比如error類的單獨放到一個文件中，更方便我們排除錯誤，所以推薦對不同級別的日志輸出到不同的日志文件中。

 

7、當選擇RollingFileAppender時，MaxFileSize=100KB

　　后綴可以是KB, MB 或者是 GB. 在日志文件到達該大小時，將會自動滾動，即將原來的內容移到mylog.log.1文件。MaxBackupIndex=2:指定可以產生的滾動文件的最大數。

 

8、log4j.appender.stdout.layout=org.apache.log4j.PatternLayout  # 定義名為stdout的輸出端的layout類型

• 　　org.apache.log4j.HTMLLayout（以HTML表格形式布局）
• 　　org.apache.log4j.PatternLayout（可以靈活地指定布局模式）
• 　　org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串）
• 　　org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息）

 

9、log4j.appender.stdout.layout.ConversionPattern= [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n 

如果使用pattern布局就要指定的打印信息的具體格式ConversionPattern，打印參數如下：

• 　　%p: 輸出日志信息優先級，即DEBUG，INFO，WARN，ERROR，FATAL,
• 　　%r: 輸出自應用啟動到輸出該log信息耗費的毫秒數
• 　　%c: 輸出日志信息所屬的類目，通常就是所在類的全名
• 　　%t: 輸出產生該日志事件的線程名
• 　　%l: 輸出日志事件的發生位置，相當於%C.%M(%F:%L)的組合,包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main (TestLog4.Java:10)
• 　　%x: 輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像Java servlets這樣的多客戶多線程的應用中。
• 　　%%: 輸出一個"%"字符
• 　　%F: 輸出日志消息產生時所在的文件名稱
• 　　%L: 輸出代碼中的行號
• 　　%m: 輸出代碼中指定的消息,產生的日志具體信息 （注意下文log的使用時傳入的參數）
• 　　%n: 輸出一個回車換行符，Windows平台為"/r/n"，Unix平台為"/n"輸出日志信息換行
• 　　%d: 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式

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

• 　　%20c：指定輸出category的名稱，最小的寬度是20，如果category的名稱小於20的話，默認的情況下右對齊。
• 　　%-20c:指定輸出category的名稱，最小的寬度是20，如果category的名稱小於20的話，"-"號指定左對齊。
• 　　%.30c:指定輸出category的名稱，最大的寬度是30，如果category的名稱大於30的話，就會將左邊多出的字符截掉，但小於30的話也不會有空格。
• 　　%20.30c:如果category的名稱小於20就補空格，並且右對齊，如果其名稱長於30字符，就從左邊較遠輸出的字符截掉。

四、案例：

運行對應的代碼，就可以得到對應的日志，這是log4j與slf4j日志系統的使用　　　　　　　　　

                                                               

 

代碼：

package com.turtle.log;

import com.turtle.utils.ExceptionOutputStreamUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.text.SimpleDateFormat;
import java.util.Date;

public class LogTest {

    private final static Logger logger = LoggerFactory.getLogger(LogTest.class);

    public static void main(String[] args) {
        logger.info("programer processing......");
        try{
            // 會產生除以0的異常信息
            System.out.println(1/0);
        }catch (Exception e){
            // 將異常信息打印到日志文件中去
            String exception = ExceptionOutputStreamUtil.getTrace(e);
            // 輸出日志文件
            logger.error("Programer error:"+ exception+"\t"+"【"+new SimpleDateFormat("yyyy-MM-dd/HH.mm.ss").format(new Date())+"】");
        }
        logger.debug("start Debug detail......");
    }
}

package com.turtle.log1;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogTest {

    private final  static Logger logger = LoggerFactory.getLogger(LogTest.class);

    public static void main(String [] args){

        logger.info("com.turtle.log1.LogTest的Info級別日志");
        logger.debug("com.turtle.log1.LogTest的Debug級別日志");

    }
}

package com.turtle.log2;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogTest {

    private final  static Logger logger = LoggerFactory.getLogger(LogTest.class);

    public static void main(String [] args){

        logger.info("com.turtle.log2.LogTest的Info級別日志");
        logger.debug("com.turtle.log2.LogTest的Debug級別日志");

    }
}

package com.turtle.utils;

import java.io.PrintWriter;
import java.io.StringWriter;

public class ExceptionOutputStreamUtil {

    /**
     * 將傳入的具體錯誤信息轉換為輸出流進行輸出
     * @param t
     * @return
     */
    public static String getTrace(Throwable t) {
        StringWriter stringWriter= new StringWriter();
        PrintWriter writer= new PrintWriter(stringWriter);
        t.printStackTrace(writer);
        writer.close();
        StringBuffer buffer= stringWriter.getBuffer();
        return buffer.toString();
    }
}

### set log levels ###
log4j.rootLogger = DEBUG,stdout,D,E

# 配置日志信息輸出目的地
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
# Target是輸出目的地的目標
log4j.appender.stdout.Target = System.out
# 指定日志消息的輸出最低層次
log4j.appender.stdout.Threshold = INFO
# 定義名為stdout的輸出端的layout類型
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
# 如果使用pattern布局就要指定的打印信息的具體格式ConversionPattern
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss} %l%m%n


# 名字為D的對應日志處理
log4j.appender.D = org.apache.log4j.DailyRollingFileAppender
# File是輸出目的地的文件名
log4j.appender.D.File = LOG//app_debug.log
#false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容
log4j.appender.D.Append = true
log4j.appender.D.Threshold = DEBUG
log4j.appender.D.layout = org.apache.log4j.TTCCLayout

# 名字為E的對應日志處理
log4j.appender.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = LOG//app_error.log
log4j.appender.E.Append = true
log4j.appender.E.Threshold = ERROR
log4j.appender.E.layout = org.apache.log4j.PatternLayout
log4j.appender.E.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n



log4j.logger.com.turtle.log1 = DEBUG,A1
log4j.logger.com.turtle.log2 = ERROR,A2

log4j.appender.A1 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A1.File = LOG//A1_app_debug.log
log4j.appender.A1.Append = true
log4j.appender.A1.Threshold = DEBUG
log4j.appender.A1.layout = org.apache.log4j.TTCCLayout

log4j.appender.A2 = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A2.File = LOG//A2_app_error.log
log4j.appender.A2.Append = true
log4j.appender.A2.Threshold = ERROR
log4j.appender.A2.layout = org.apache.log4j.TTCCLayout

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.turtle</groupId>
  <artifactId>log</artifactId>
  <version>1.0-SNAPSHOT</version>

  <name>log</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>

    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!-- https://mvnrepository.com/artifact/log4j/log4j -->
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.17</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.25</version>
    </dependency>

  </dependencies>

</project>

 

五、總結：

日志的關鍵配置包括輸出目標，信息等級，文件形式和格式控制，各個配置靈活調整，可在不同的文件中找到不同的有用的信息，格式控制中%c/%t/%l在一個龐大的項目中十分有用。有些配置文件自己老是會忘記，所以花點時間，把log4j與slf4j的使用進行一個匯總，總結一下，理出屬於自己的思路，方便后面的復習。