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">
    <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>

查阅官方文档（ ），发现问题之所在

即，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">
    <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.本文暂不讨论使用配置中心实现多环境配置管理

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。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。