springboot之旅第三篇-日誌_ZenDei技術網路在線

一、前言日誌對於一個系統的重要性不言而喻，日誌能幫我們快速定位線上問題，市場上存在非常多的日誌框架，比較常見的有 JUL，JCL，Log4j，Log4j2，Logback、SLF4j、jboss-logging等。 spring-boot-starter-logging採用了slf4j+logba ...

一、前言

日誌對於一個系統的重要性不言而喻，日誌能幫我們快速定位線上問題，市場上存在非常多的日誌框架，比較常見的有 JUL，JCL，Log4j，Log4j2，Logback、SLF4j、jboss-logging等。

spring-boot-starter-logging採用了slf4j+logback的形式，SLF4j（Simple Logging Facade for Java）是日誌門面（日誌抽象介面）,logback是日誌實現。我們開發的時候，日誌記錄方法的調用，不應該來直接調用日誌的實現類，而是調用日誌抽象層裡面的方法。

這裡我們想到一個問題，我們的系統也會依賴其他框架，比如Spring、Hibernate, 這些框架本身也存在自己的日誌框架，但我們需要做到使用slf4j進行輸出，這個可以通過適配器模式來實現的，首先我們排除原先框架使用的日誌，然後用中間包來替換原有的日誌框架，這個中間包去實現原先日誌框架的API，這樣我們只需要導入slf4j轉換包的依賴就可以解決。如圖

二、日誌使用

日誌的使用非常簡單，只要用LogFactory.getLog(getClass()) 獲取日誌，然後記錄信息。

Log log = LogFactory.getLog(getClass());
log.trace("這是trace日誌");
log.debug("這是debug日誌");
log.info("這是info日誌");
log.warn("這是warn日誌");
log.error("這是error日誌");

日誌級別由低到高，並且可以調整日誌級別，日誌就只會在這個級別以上（包括自己）的日誌生效。springboot的預設級別是info, 我們可以針對包進行調整

logging.level.com.yuanqinnan=trace

除了級別配置外，還有兩個比較重要的配置，路徑和格式

路徑有兩個配置方式：

#當前項目下生成springlog.log
#logging.file=springboot.log
#完整的路徑名稱
logging.file=G:/springboot.log
#創建路徑，由springboot生成預設的文件
logging.path=G:/springlog

這兩個是衝突配置，兩個都寫的話以logging.file為主。

我們可以對日誌的輸出進行格式配置：

#在控制台輸出的日誌的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日誌輸出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

具體參數：

%d表示日期時間，
    %thread表示線程名，
    %-5level：級別從左顯示5個字元寬度
    %logger{50} 表示logger名字最長50個字元，否則按照句點分割。 
    %msg：日誌消息，
    %n是換行符

springboot的日誌都有自己的預設文件，如果需要用自己的日誌配置，只要增加一個相同文件，那麼就會使用我們自己配置的文件。

Logging System	Customization
Logback	`logback-spring.xml`, `logback-spring.groovy`, `logback.xml` or `logback.groovy`
Log4j2	`log4j2-spring.xml` or `log4j2.xml`
JDK (Java Util Logging)	`logging.properties`

springboot推薦使用logback-spring.xml來進行配置。

SpringBoot的有高級Profile功能，如：

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
      可以指定某段配置只在某個環境下生效
</springProfile>

日誌的基本內容就是這些，另附上日誌的一些常用配置供參考：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：當此屬性設置為true時，配置文件如果發生改變，將會被重新載入，預設值為true。
scanPeriod：設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，預設單位是毫秒當scan為true時，此屬性生效。預設的時間間隔為1分鐘。
debug：當此屬性設置為true時，將列印出logback內部日誌信息，實時查看logback運行狀態。預設值為false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定義日誌的根目錄 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定義日誌文件名稱 -->
    <property name="appName" value="appName"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台輸出 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日誌輸出格式：
            %d表示日期時間，
            %thread表示線程名，
            %-5level：級別從左顯示5個字元寬度
            %logger{50} 表示logger名字最長50個字元，否則按照句點分割。 
            %msg：日誌消息，
            %n是換行符
        -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 滾動記錄文件，先將日誌記錄到指定文件，當符合某個條件時，將日誌記錄到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日誌文件的名稱 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        當發生滾動時，決定 RollingFileAppender 的行為，涉及文件移動和重命名
        TimeBasedRollingPolicy： 最常用的滾動策略，它根據時間來制定滾動策略，既負責滾動也負責出發滾動。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滾動時產生的文件的存放位置及文件名稱 %d{yyyy-MM-dd}：按天進行日誌滾動 
            %i：當文件大小超過maxFileSize時，按照i進行文件滾動
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可選節點，控制保留的歸檔文件的最大數量，超出數量就刪除舊文件。假設設置每天滾動，
            且maxHistory是365，則只保存最近365天的文件，刪除之前的舊文件。註意，刪除舊文件是，
            那些為了歸檔而創建的目錄也會被刪除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            當日誌文件超過maxFileSize指定的大小是，根據上面提到的%i進行日誌文件滾動 註意此處配置SizeBasedTriggeringPolicy是無法實現按文件大小進行滾動的，必須配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日誌輸出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
        logger主要用於存放日誌對象，也可以定義日誌類型、級別
        name：表示匹配的logger類型首碼，也就是包的前半部分
        level：要記錄的日誌級別，包括 TRACE < DEBUG < INFO < WARN < ERROR
        additivity：作用在於children-logger是否使用 rootLogger配置的appender進行輸出，
        false：表示只用當前logger的appender-ref，true：
        表示當前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.yuanqinnan" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>



    <!-- 
    root與logger是父子關係，沒有特別定義則預設為root，任何一個類只會和一個logger對應，
    要麼是定義的logger，要麼是root，判斷的關鍵在於找到這個logger，然後判斷這個logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration>