spring boot使用logback實現多環境日誌配置

軟體生存週期中，涉及程式碼執行的環節有編碼、測試和維護階段，而一套成熟的程式碼，在此三個階段，資料庫、日誌路徑、日誌級別、執行緒池大小等配置一般會不一樣。作為開發人員，希望將程式碼與配置解耦合，不同的環境，程式碼一套，而配置多套。

針對於多環境的配置，可以使用maven的profile及filter配置，在打包環節通過打包命令 mvn clean package -P dev/test/product決定所打環境的war/jar包。此種解決方案，產生的war\jar包在不同環境的是不同的，因此MD5校驗和也不同。一次敏捷開發結束後，開發、測試、線上的的war/jar包，只能人為新增標識來識別，比如test-1.0.1和prod-1.0.1是功能相同、環境不同的war/jar包。如果是spring boot專案，可以使用yaml配置，實現多環境配置，在專案啟動時，通過新增引數--spring.profiles.active=dev/test/production，指定專案執行的環境。此方案的jar包在不同執行環境均是一個，不會出現測試與生產的war/jar包程式碼不一致的問題（第一種方案在測試打包後，生產打包前，可能會有程式碼提交，需人工控制此階段的行為）。

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

問題1：

使用application.yml配置多環境變數，使用logback.xml實現日誌配置，不能實現多環境配置（即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" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
        </encoder>
    </appender>


    <appender name="FILE-OUT" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${log.path}/xxx.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <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），發現問題之所在

即，logback.xml載入早於application.yml，需改用logback-spring.xml實現日誌配置

問題2：

經上修改後，發現配置檔案已生效，但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中log.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" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
        </encoder>
    </appender>


    <appender name="FILE-OUT" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${logPath}/xxx.log</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} [%level] [%class:%line] - %m %n</pattern>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <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.本文暫不討論使用配置中心實現多環境配置管理

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生效後的變數值，可用於線上環境debug（不用重新打包，重新啟動即可），但是不建議線上debug。