首頁 > 軟體

SpringBoot專案讀取外接logback組態檔的問題及解決

2022-08-26 18:05:39

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>

以上為個人經驗,希望能給大家一個參考,也希望大家多多支援it145.com。 


IT145.com E-mail:sddin#qq.com