spring boot使用logback實現(xiàn)多環(huán)境日志配置詳解

更新時間：2018年08月21日 10:28:53 作者：封巍

這篇文章主要介紹了spring boot使用logback實現(xiàn)多環(huán)境日志配置詳解，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧

軟件生存周期中，涉及代碼運行的環(huán)節(jié)有編碼、測試和維護階段，而一套成熟的代碼，在此三個階段，數(shù)據(jù)庫、日志路徑、日志級別、線程池大小等配置一般會不一樣。作為開發(fā)人員，希望將代碼與配置解耦合，不同的環(huán)境，代碼一套，而配置多套。

針對于多環(huán)境的配置，可以使用maven的profile及filter配置，在打包環(huán)節(jié)通過打包命令 mvn clean package -P dev/test/product決定所打環(huán)境的war/jar包。此種解決方案，產生的war\jar包在不同環(huán)境的是不同的，因此MD5校驗和也不同。一次敏捷開發(fā)結束后，開發(fā)、測試、線上的的war/jar包，只能人為添加標識來識別，比如test-1.0.1和prod-1.0.1是功能相同、環(huán)境不同的war/jar包。如果是spring boot項目，可以使用yaml配置，實現(xiàn)多環(huán)境配置，在項目啟動時，通過添加參數(shù)--spring.profiles.active=dev/test/production，指定項目運行的環(huán)境。此方案的jar包在不同運行環(huán)境均是一個，不會出現(xiàn)測試與生產的war/jar包代碼不一致的問題（第一種方案在測試打包后，生產打包前，可能會有代碼提交，需人工控制此階段的行為）。

本文基于第二種配置方案，但在使用logback作為日志方案時，產生了一些問題，具體見下文。

問題1：

使用application.yml配置多環(huán)境變量，使用logback.xml實現(xiàn)日志配置，不能實現(xiàn)多環(huán)境配置（即logback配置未生效），打印的日志路徑和日志級別不是配置文件中的值。

項目配置文件-application.yml

spring:
 profiles.active: dev
---
spring:
 profiles: dev
log:
 path: ./logs
 level: debug
---
spring:
 profiles: test
log:
 path: /home/user/logs/
 level: info
---

日志配置文件-logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true" scan="true" scanPeriod="30 seconds">

  <appender name="STDOUT">
    <encoder>
      <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
    </encoder>
  </appender>


  <appender name="FILE-OUT">
    <file>${log.path}/xxx.log</file>
    <encoder>
      <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
    </encoder>
    <rollingPolicy>
      <fileNamePattern>${log.path}/xxx.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
      <!-- 30 days -->
      <maxHistory>30</maxHistory>
    </rollingPolicy>
  </appender>


  <root level="${log.level}">
    <appender-ref ref="STDOUT" />
    <appender-ref ref="FILE-OUT" />
  </root>
</configuration>

查閱官方文檔（ http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-custom-log-levels），發(fā)現(xiàn)問題之所在

即，logback.xml加載早于application.yml，需改用logback-spring.xml實現(xiàn)日志配置

問題2：

經上修改后，發(fā)現(xiàn)配置文件已生效，但logback-spring.xml中的變量并未生效，日志內容見下

11:41:11,450 |-INFO in c.q.l.core.rolling.TimeBasedRollingPolicy@962287291 - Will use the pattern log.path_IS_UNDEFINED/error.%d{yyyy-MM-dd}.log for the active file
11:41:11,453 |-INFO in c.q.l.core.rolling.DefaultTimeBasedFileNamingAndTriggeringPolicy - The date pattern is 'yyyy-MM-dd' from file name pattern 'log.path_IS_UNDEFINED/error.%d{yyyy-MM-dd}.log.zip'.

...

11:41:11,471 |-INFO in ch.qos.logback.classic.joran.action.RootLoggerAction - Setting level of ROOT logger to DEBUG

看似log.level已生效，log.path未生效，其實不然，經修改application.yml中l(wèi)og.path: others(info, error)，日志都為以上內容

查看官方文檔

官方文檔指明，需要使用<springProperty>,才可使用application.properties（或application.yml）中的值

經修改logback-spring.xml后，問題解決

最終的日志配置文件-logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true" scan="true" scanPeriod="30 seconds">
  <springProperty scope="context" name="logLevel" source="log.level"/>
  <springProperty scope="context" name="logPath" source="log.path"/>

  <appender name="STDOUT">
    <encoder>
      <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
    </encoder>
  </appender>

  <appender name="FILE-OUT">
    <file>${logPath}/xxx.log</file>
    <encoder>
      <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
    </encoder>
    <rollingPolicy>
      <fileNamePattern>${logPath}/xxx.%d{yyyy-MM-dd}.log.zip</fileNamePattern>
      <!-- 30 days -->
      <maxHistory>30</maxHistory>
    </rollingPolicy>
  </appender>

  <root level="${logLevel}">
    <appender-ref ref="STDOUT" />
    <appender-ref ref="FILE-OUT" />
  </root>
</configuration>

備注：

1.本文暫不討論使用配置中心實現(xiàn)多環(huán)境配置管理

2. How to package a maven program?

mvn clean package [-Dmaven.test.skip]

3.How to start a spring boot program?

java -jar xxx-1.0.0.jar --spring.profiles.active=dev(default)/test/production [--log.level=debug]

其中，--log.level仍可以修改--spring.profiles.active生效后的變量值，可用于線上環(huán)境debug（不用重新打包，重新啟動即可），但是不建議線上debug。

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: