1. 程式人生 > >Spring Boot中對log4j進行多環境不同日誌級別的控制

Spring Boot中對log4j進行多環境不同日誌級別的控制

之前介紹了在《Spring boot中使用log4j記錄日誌》,僅通過log4j.properties對日誌級別進行控制,對於需要多環境部署的環境不是很方便,可能我們在開發環境大部分模組需要採用DEBUG級別,在測試環境可能需要小部分採用DEBUG級別,而在生產環境時我們又希望採用INFO級別。這個時候,我們要自己手工編輯log4j.properties檔案來調整日誌級別,不論在版本庫中預設儲存哪個環境的級別設定,都會增加其他環境使用人員的工作量,雖然很細微,但是手工修改總不是一件很好的選擇,難免會發現修改後誤提交等問題。

那麼,有沒有辦法對於開發人員、運維人員都不需要改變原始碼實現不同環境的不同日誌級別呢?

是否還記得之前在《Spring Boot屬性配置檔案詳解》一文中,提到的關於Spring Boot多環境的配置以及屬性檔案中的引數引用?若沒有了解過相關內容,建議先閱讀該文後繼續此篇內容。

嘗試改造

先以chapter4-2-2工程作為基礎工程,我們來進行多環境配置的改造。

  • 建立多環境配置檔案
    • application-dev.properties:開發環境
    • application-test.properties:測試環境
    • application-prod.properties:生產環境
  • application.properties中新增屬性:spring.profiles.active=dev
    (預設啟用application-dev.properties配置)
  • application-dev.propertiesapplication-test.properties配置檔案中新增日誌級別定義:logging.level.com.didispace=DEBUG
  • application-prod.properties配置檔案中新增日誌級別定義:logging.level.com.didispace=INFO

通過上面的定義,根據logging.level.com.didispace在不同環境的配置檔案中定義了不同的級別,但是我們已經把日誌交給了log4j管理,看看我們log4j.properties中對com.didispace包下的日誌定義是這樣的,固定定義了DEBUG級別,並輸出到名為didifile定義的appender中。

# LOG4J配置
log4j.category.com.didispace=DEBUG, didifile
# com.didispace下的日誌輸出
log4j.appender.didifile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.didifile.file=logs/my.log
log4j.appender.didifile.DatePattern='.'yyyy-MM-dd
log4j.appender.didifile.layout=org.apache.log4j.PatternLayout
log4j.appender.didifile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n

那麼,要如何動態的改變這個DEBUG級別呢?在《Spring Boot屬性配置檔案詳解》中還提到了關於配置檔案中引數的引用。我們需要將DEBUG替換成application-{profile}.properties配置檔案中定義logging.level.com.didispace即可,所以配置變為如下內容:

# LOG4J配置
log4j.category.com.didispace=${logging.level.com.didispace}, didifile
# com.didispace下的日誌輸出
log4j.appender.didifile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.didifile.file=logs/my.log
log4j.appender.didifile.DatePattern='.'yyyy-MM-dd
log4j.appender.didifile.layout=org.apache.log4j.PatternLayout
log4j.appender.didifile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} %5p %c{1}:%L ---- %m%n

到這裡我們已經完成了所有配置工作,我們可以通過執行單元測試,然後看my.log檔案中輸出的日誌內容。通過修改預設的application-dev.properties配置的日誌級別為INFO,再執行單元測試的DEBUG內容是否被輸出到了my.log中驗證引數是否被正確引用了。

對於不同環境的使用人員也不需要改變程式碼或打包檔案,只需要通過執行命令中參加引數即可,比如我想採用生產環境的級別,那麼我可以這樣執行應用:

java -jar xxx.jar --spring.profiles.active=prod

 本文由 程式猿DD-翟永超 創作,採用 CC BY 3.0 CN協議 進行許可。 可自由轉載、引用,但需署名作者且註明文章出處。如轉載至微信公眾號,請在文末新增作者公眾號二維碼。

------------------------------------------------------------------------------------------------------------------------------