springboot超級詳細的日誌配置(基於logback)

煩囂的人發表於2019-06-06
Spring Boot

嘿

前言

  java web 下有好幾種日誌框架，比如：logback，log4j，log4j2（slj4f 並不是一種日誌框架，它相當於定義了規範，實現了這個規範的日誌框架就能夠用 slj4f 呼叫）。其中效能最高的應該使 logback 了，而且 springboot 預設使用的也是 logback 日誌，所以本篇將會詳細的講解 logback 的日誌配置方案。

本篇主要內容如下：

  • logback 配置檔案的構成
  • 如何將日誌輸出到檔案
  • 如何按時間，按大小切分日誌
  • 如何將讓一個日誌檔案中只有一種日誌級別
  • 如何將指定包下的日誌輸出到指定的日誌檔案中

簡單使用

  如果無需複雜的日誌配置，執行簡單設定日誌列印級別，列印方式可直接再 application.yml 中配置。

  預設情況下 Spring Boot 將 info 級別的日誌輸出到控制檯中，不會寫到日誌檔案，且不能進行復雜配置。

列印到檔案中

  想要將日誌輸出到檔案中，可通過如下兩個配置：

logging:
  # 配置輸出額日誌檔名,可以帶路徑
  #  file: out.log
  # 配置日誌存放路徑,日誌檔名為：spring.log
  path: ./log
  file:
    # 設定日誌檔案大小
    max-size: 10MB

注意:file 和 path 是不能同時配置的，如果同時配置path不會生效。

列印級別控制

  可通過配置控制日誌列印級別，格式如下：

logging.level.*=TRACE/DEBUG/INFO/...

*可以為包名或 Logger 名，如下：

logging:
  level:
    # root日誌以WARN級別輸出
    root: info
    # 此包下所有class以DEBUG級別輸出
    com.example.log_demo.log1: warn

logback 詳細配置

  接下來說明如何通過獨立的 xml 配置檔案來配置日誌列印。雖然 springboot 是要消滅 xml 的，但是有些複雜功能還是得編寫 xml。使用 xml 後要將 application.yml 中的配置去掉，避免衝突.

  根據不同的日誌系統，按照指定的規則組織配置檔名，並放在 resources 目錄下，就能自動被 spring boot 載入：

  • Logback：logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
  • Log4j: log4j-spring.properties, log4j-spring.xml, log4j.properties, log4j.xml
  • Log4j2: log4j2-spring.xml, log4j2.xml
  • JDK (Java Util Logging)： logging.properties

想要自定義檔名的可配置：logging.config指定配置檔名:

logging.config=classpath:logging-config.xml

Spring Boot 官方推薦優先使用帶有 -spring 的檔名作為你的日誌配置（如使用 logback-spring.xml ，而不是 logback.xml ），命名為 logback-spring.xml 的日誌配置檔案， spring boot 可以為它新增一些 spring boot 特有的配置項（下面會提到）。

logback 配置檔案的組成

  根節點<configuration>有 5 個子節點，下面來進行一一介紹。

<root>節點

  root 節點是必選節點，用來指定最基礎的日誌輸出級別，只有一個 level 屬性，用於設定列印級別，可選如下：TRACE,DEBUG,INFO,WARN,ERROR,ALL,OFF。

  root 節點可以包含 0 個或多個元素，將appender新增進來。如下：

<root level="debug">
 <appender-ref ref="console" />
 <appender-ref ref="file" />
</root>

appender 也是子節點之一，將會在後面說明。

<contextName>節點

  設定上下文名稱，預設為default，可通過%contextName來列印上下文名稱，一般不使用此屬性。

<property>節點

  用於定義變數，方便使用。有兩個屬性：name,value。定義變數後，可以使用${}來使用變數。如下：

<property name="path" value="./log"/>
<property name="appname" value="app"/>

<appender>節點

  appender 用來格式化日誌輸出的節點，這個最重要。有兩個屬性：

  • name:該本 appender 命名
  • class:指定輸出策略，通常有兩種：控制檯輸出，檔案輸出

下面通過例子來說明這個怎麼用：

  1. 輸出到控制檯/按時間輸出日誌
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--設定儲存路徑變數-->
    <property name="LOG_HOME" value="./log"/>

    <!--控制檯輸出appender-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <!--設定輸出格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示執行緒名，%-5level：級別從左顯示5個字元寬度%msg：日誌訊息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <!--設定編碼-->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--檔案輸出,時間視窗滾動-->
    <appender name="timeFileOutput" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!--日誌名,指定最新的檔名，其他檔名使用FileNamePattern -->
        <File>${LOG_HOME}/timeFile/out.log</File>
        <!--檔案滾動模式-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日誌檔案輸出的檔名,可設定檔案型別為gz,開啟檔案壓縮-->
            <FileNamePattern>${LOG_HOME}/timeFile/info.%d{yyyy-MM-dd}.%i.log.gz</FileNamePattern>
            <!--日誌檔案保留天數-->
            <MaxHistory>30</MaxHistory>
            <!--按大小分割同一天的-->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <!--輸出格式-->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化輸出：%d表示日期，%thread表示執行緒名，%-5level：級別從左顯示5個字元寬度%msg：日誌訊息，%n是換行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <!--設定編碼-->
            <charset>UTF-8</charset>
        </encoder>

    </appender>

    <!--指定基礎的日誌輸出級別-->
    <root level="INFO">
        <!--appender將會新增到這個loger-->
        <appender-ref ref="console"/>
        <appender-ref ref="timeFileOutput"/>
    </root>
</configuration>
  1. 設定只輸出單個級別

  在 appender 中設定,filter 子節點，在預設級別上再此過濾，配置 onMatch，onMismatch 可實現只輸出單個級別

<appender ...>
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>INFO</level>
        <!--接受匹配-->
        <onMatch>ACCEPT</onMatch>
        <!--拒絕不匹配的-->
        <onMismatch>DENY</onMismatch>
    </filter>
</appender>

<logger>節點

構成

  此節點用來設定一個包或具體的某一個類的日誌列印級別、以及指定<appender>，有以下三個屬性：

  • name: 必須。用來指定受此 loger 約束的某個包或者某個具體的類
  • level：可選。設定列印級別。預設為 root 的級別。
  • addtivity: 可選。是否向上級 loger(也就是 root 節點)傳遞列印資訊。預設為 true。

使用示例如下：

  1. 不指定級別，不指定 appender
<!-- 控制com.example.service下類的列印，使用root的level和appender -->
<logger name="com.example.service"/>

2.指定級別，不指定 appender

<!-- 控制com.example.service下類的列印，使用root的appender列印warn級別日誌 -->
<logger name="com.example.service" level="WARN"/>

3.指定級別，指定 appender

<!-- 控制com.example.service下類的列印，使用console列印warn級別日誌 -->
<!-- 設定addtivity是因為這裡已經指定了appender，如果再向上傳遞就會被root下的appender再次列印 -->
<logger name="com.example.service" level="WARN" addtivity="false">
    <appender-ref ref="console">
</logger>

通過指定 appender 就能將指定的包下的日誌列印到指定的檔案中。

多環境日誌輸出

  通過設定檔名為-spring 結尾，可分環境配置 logger，示例如下：

<configuration>
    <!-- 測試環境+開發環境. 多個使用逗號隔開. -->
    <springProfile name="test,dev">
        <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="console"/>
        </logger>
    </springProfile>
    <!-- 生產環境. -->
    <springProfile name="prod">
        <logger name="com.example.demo" level="INFO" additivity="false">
            <appender-ref ref="timeFileOutput"/>
        </logger>
    </springProfile>
</configuration>

通過配置spring.profiles.active也能做到切換上面的 logger 列印設定

結束

  日誌列印可以很複雜， 這裡只是說明了常用的 logback 配置，程式碼詳見：github

本文原創釋出於：http://www.tapme.top/blog/detail/2019-03-21-10-38

相關文章