SpringBoot項目讀取外置logback配置文件的問題及解決

Posted on by

SpringBoot讀取外置logback配置文件

springboot項目可以讀取外置配置文件，避免瞭修改配置文件需要重新打包部署的問題。

部署項目的時候可以在jar包同一目錄下新建瞭config文件夾，將所有的配置文件都放在config文件夾下統一管理，springboot會優先讀取jar包同一目錄下config目錄下的配置文件。

下次需要修改配置文件內容就直接在config目錄下修改，然後重啟項目即可。

問題

啟動jar包，卻出現瞭問題：springboot讀取的logback-spring.xml還是項目內置的，並沒有讀取外置的config目錄下的logback-spring.xml。經過測試，發現其他配置文件如application.yml的讀取都是沒問題的，就隻有logback配置文件讀取沒有按預想來。

解決

猜想是因為springboot默認讀取的就是項目的resources目錄下的logback配置文件。

所以解決思路是在啟動jar包命令中指定logback配置文件路徑：

java -jar -Dlogging.config=./config/logback-spring.xml datasync-web.jar

這樣啟動jar包即可讀取config目錄下的logback-spring.xml瞭。

SpringBoot Logback的使用

springboot引入logback jar以後，自動的會在資源根目錄找logback.xml 或 logback-spring.xml文件。

標簽定義

  • configuration
屬性 作用
scan 當此屬性設置為true時，配置文件如果發生改變，將會被重新加載，默認值為
truescanPeriod 設置監測配置文件是否有修改的時間間隔，如果沒有給出時間單位，默認單位是毫秒。當scan為true時，此屬性生效。默認的時間間隔為1分鐘。
debug 當此屬性設置為true時，將打印出logback內部日志信息，實時查看logback運行狀態。默認值為false。

property

和redis的key和value的作用相同。

屬性 作用
name 變量的名稱
value 變量的值
  • appender

用來格式化日志輸出節點。

字段 類型 作用
name 屬性 定義名稱，方便root引用這個輸出策略
class 屬性 指定哪種輸出策略，常用就是控制臺輸出策略和文件輸出策略
layout 節點 控制臺輸出使用
encode 節點 文件輸出使用
  • loger

設置某一個包或某一個類的日志打印級別。

屬性 作用
name 用來指定受此loger約束的某一個包或者具體的某一個類
level 用來設置打印級別，大小寫無關：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，還有一個特俗值INHERITED或者同義詞NULL，代表強制執行上級的級別。如果未設置此屬性，那麼當前loger將會繼承上級的級別。
addtivity 是否向上級loger傳遞打印信息。默認是true。
  • root

必選節點，用來指定最基礎的日志輸出級別，隻有一個level屬性用來設置打印級別，隻會輸出>=level級別的日志。

日志級別，從低到高TRACE > DEBUG > INFO > WARN > ERROR > FATAL。

yml設置打印級別

設置隻打印com.spring.logback包下info級別的日志。

logging:
  level:
    com.spring.logback: info

示例

<appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--如果隻是想要 Info 級別的日志，隻是過濾 info 還是會輸出 Error 日志，因為 Error 的級別高，
    所以我們使用下面的策略，可以避免輸出 Error 的日志-->
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <!--過濾 Error-->
        <level>ERROR</level>
        <!--匹配到就禁止-->
        <onMatch>DENY</onMatch>
        <!--沒有匹配到就允許-->
        <onMismatch>ACCEPT</onMismatch>
    </filter>
    <!--日志名稱，如果沒有File 屬性，那麼隻會使用FileNamePattern的文件路徑規則
        如果同時有<File>和<FileNamePattern>，那麼當天日志是<File>，明天會自動把今天
        的日志改名為今天的日期。即，<File> 的日志都是當天的。
    -->
    <File>${logback.logdir}/info.${logback.appname}.log</File>
    <!--滾動策略，按照時間滾動 TimeBasedRollingPolicy-->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <!--文件路徑,定義瞭日志的切分方式——把每一天的日志歸檔到一個文件中,以防止日志填滿整個磁盤空間-->
        <FileNamePattern>${logback.logdir}/info.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern>
        <!--隻保留最近90天的日志-->
        <maxHistory>90</maxHistory>
        <!--用來指定日志文件的上限大小，那麼到瞭這個值，就會刪除舊的日志-->
        <!--<totalSizeCap>1GB</totalSizeCap>-->
    </rollingPolicy>
    <!--日志輸出編碼格式化-->
    <encoder>
        <charset>UTF-8</charset>
        <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern>
    </encoder>
</appender>
<appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <!--如果隻是想要 Error 級別的日志，那麼需要過濾一下，默認是 info 級別的，ThresholdFilter-->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>Error</level>
    </filter>
    <!--日志名稱，如果沒有File 屬性，那麼隻會使用FileNamePattern的文件路徑規則
        如果同時有<File>和<FileNamePattern>，那麼當天日志是<File>，明天會自動把今天
        的日志改名為今天的日期。即，<File> 的日志都是當天的。
    -->
    <File>${logback.logdir}/error.${logback.appname}.log</File>
    <!--滾動策略，按照時間滾動 TimeBasedRollingPolicy-->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
        <!--文件路徑,定義瞭日志的切分方式——把每一天的日志歸檔到一個文件中,以防止日志填滿整個磁盤空間-->
        <FileNamePattern>${logback.logdir}/error.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern>
        <!--隻保留最近90天的日志-->
        <maxHistory>90</maxHistory>
        <!--用來指定日志文件的上限大小，那麼到瞭這個值，就會刪除舊的日志-->
        <!--<totalSizeCap>1GB</totalSizeCap>-->
    </rollingPolicy>
    <!--日志輸出編碼格式化-->
    <encoder>
        <charset>UTF-8</charset>
        <pattern>%d [%thread] %-5level %logger{36} %line - %msg%n</pattern>
    </encoder>
</appender>

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。 

推薦閱讀：