技術標籤：SSMlog4j

日誌：Log

1 概述

• 用於記錄系統中發生的各種事件。記錄的位置常見的有 ：控制檯、磁碟檔案等
• 日誌的級別：
  • TRACE < DEBUG < INFO < WARN < ERROR < FATAL
• 日誌的作用：
  • 通過日誌觀察、分析專案的執行情況 (專案維護)
  • 通過日誌分析使用者的使用情況 (大資料分析)

2 日誌方案一：Log4j+Commons-Logging

2.1 匯入相關依賴

• 專案中新增 Log4j和Commons-Logging的依賴

<!-- https://mvnrepository.com/artifact/log4j/log4j -->
 

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

2.2 基本使用

• 基本API

public class LogTest {

    //建立一個Log物件，用於輸出日誌
    //使用org.apache.commons.logging.Log
    Log log = LogFactory.getLog(LogTest.class);

    @Test
    public void testLog
 
() {
        this.log.trace("hello trace");
        this.log.debug("hello debug");
        this.log.info("hello info");
        this.log.warn("hello warn");
        this.log.error("hello error");
        this.log.fatal("hello fatal");
    }
}

• 配置log4j.xml

<?xml version="1.0"  encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration PUBLIC "-//LOGGER"
        "http://org/apache/log4j/xml/log4j.dtd">
<log4j:configuration>

    <!--配置追加器，org.apache.log4j.ConsoleAppender為控制檯追加器，日誌輸出到控制檯-->
    <appender name="myConsole" class="org.apache.log4j.ConsoleAppender">
        <!--定義輸出格式-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>
    <!--
        配置org.apache.log4j.RollingFileAppender：檔案追加器，日誌輸出到檔案
        第一種檔案輸出方式，可以設定檔案大小和備份檔案數量
    -->
    <appender name="myFile1" class="org.apache.log4j.RollingFileAppender">
        <param name="File" value="./log/hello.log"/><!--檔案位置-->
        <param name="Append" value="true"/><!--是否選擇追加-->
        <param name="MaxFileSize" value="1kb"/><!--檔案最大位元組數-->
        <param name="MaxBackupIndex" value="2"/><!--新檔案數量-->
        <!--定義輸出格式-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern" value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>
    <!--
        org.apache.log4j.DailyRollingFileAppender，日誌輸出到檔案
        第二種檔案輸出方式，在同一個檔案中追加
    -->
    <appender name="myFile2" class="org.apache.log4j.DailyRollingFileAppender">
        <param name="File" value="log/hello2.log"/><!--檔案位置-->
        <param name="Append" value="true"/><!--是否選擇追加-->
        <layout class="org.apache.log4j.PatternLayout">
            <param name="ConversionPattern"
                   value="%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n"/>
        </layout>
    </appender>
    <!-- 根logger的設定-->
    <root>
        <!--優先順序設定，all < trace < debug < info < warn < error < fatal < off -->
        <priority value="all"/>
        <appender-ref ref="myConsole"/>
        <appender-ref ref="myFile1"/>
        <appender-ref ref="myFile2"/>
    </root>
</log4j:configuration>

• 輸出格式說明

3 日誌方案二：Logback+SLF4j

3.1 匯入相關依賴

<!-- Logback依賴，還會傳遞 slf4j 和 logback-core -->
<dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
    <version>1.2.3</version>
</dependency>

3.2 基本使用

• 基本API

public class LogTest {

    //建立Logger物件，使用import org.slf4j.Logger
    Logger logger = LoggerFactory.getLogger(LogTest.class);

    @Test
    public void testLogger() {
        System.out.println(this.logger.getClass());
        this.logger.trace("hello trace");
        this.logger.debug("hello debug");
        this.logger.info("hello info");
        this.logger.warn("hello warn");
        this.logger.error("hello error");
        // 注意，logback中沒有fatal日誌
    }
}

• 配置logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- scan:當此屬性設定為true時，配置檔案如果發生改變，將會被重新載入，預設值為true -->
<!-- scanPeriod:設定監測配置檔案是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒。當scan為true時，此屬性生效。
	 預設的時間間隔為1分鐘。 -->
<!-- debug:當此屬性設定為true時，將打印出logback內部日誌資訊，實時檢視logback執行狀態。預設值為false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="true">

    <!-- 定義變數，可通過 ${log.path}和${CONSOLE_LOG_PATTERN} 得到變數值 -->
    <property name="log.path" value="log"/>
    <property name="CONSOLE_LOG_PATTERN"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} |-[%-5p] in %logger.%M[line-%L] -%m%n"/>

    <!-- 輸出到控制檯 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!-- Threshold=即最低日誌級別，此appender輸出大於等於對應級別的日誌
             (當然還要滿足root中定義的最低級別)
        -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
        <encoder>
            <!-- 日誌格式(引用變數) -->
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 設定字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>
    <!-- 追加到檔案中 -->
    <appender name="file" class="ch.qos.logback.core.FileAppender">
        <file>${log.path}/hello2.log</file>
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <!-- 滾動追加到檔案中 -->
    <appender name="file2" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 正在記錄的日誌檔案的路徑及檔名 -->
        <file>${log.path}/hello.log</file>
        <!--日誌檔案輸出格式-->
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset> <!-- 設定字符集 -->
        </encoder>
        <!-- 日誌記錄器的滾動策略，按日期，按大小記錄
             檔案超過最大尺寸後，會新建檔案，然後新的日誌檔案中繼續寫入
             如果日期變更，也會新建檔案，然後在新的日誌檔案中寫入當天日誌
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 新建檔案後，原日誌改名為如下  %i=檔案序號，從0開始 -->
            <fileNamePattern>${log.path}/hello-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- 每個日誌檔案的最大體量 -->
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>8kb</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!-- 日誌檔案保留天數，1=則只保留昨天的歸檔日誌檔案 ,不設定則保留所有日誌-->
            <maxHistory>1</maxHistory>
        </rollingPolicy>
    </appender>

    <root level="trace">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="file"/>
        <appender-ref ref="file2"/>
    </root>

</configuration>

• 輸出格式說明