脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → spring boot logback多环境日志配置

spring boot使用logback实现多环境日志配置详解

 更新时间：2018年08月21日 10:28:53   作者：封巍  
这篇文章主要介绍了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>

查阅官方文档（ 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">
    <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。

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

您可能感兴趣的文章:

相关文章

  • JVM内存飙升线上问题排查方式

    JVM内存飙升线上问题排查方式

    文章主要介绍了线上CMS服务内存增长问题的排查过程,通过分析GC日志和堆栈快照,定位问题为Nacos的NamingService对象无法回收和MySQL的CallableStatement对象增长迅速,最终通过将NamingService改为单例模式解决了内存增长问题
    2025-03-03
  • 详解spring cloud构建微服务架构的网关(API GateWay)

    详解spring cloud构建微服务架构的网关(API GateWay)

    这篇文章主要介绍了详解spring cloud构建微服务架构的网关(API GateWay)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-01-01
  • JAVA发送http get/post请求，调用http接口、方法详解

    JAVA发送http get/post请求，调用http接口、方法详解

    这篇文章主要介绍了Java发送http get/post请求调用接口/方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • Java开发中的容器概念、分类与用法深入详解

    Java开发中的容器概念、分类与用法深入详解

    这篇文章主要介绍了Java开发中的容器概念、分类与用法,结合实例形式较为详细的分析了java容器的相关概念、分类、使用方法与注意事项,需要的朋友可以参考下
    2017-11-11
  • SpringCloud Gateway详细分析实现负载均衡与熔断和限流

    SpringCloud Gateway详细分析实现负载均衡与熔断和限流

    这篇文章主要介绍了SpringCloud Gateway实现路由转发，负载均衡，熔断和限流，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-07-07
  • 深入JAVA对象深度克隆的详解

    深入JAVA对象深度克隆的详解

    本篇文章是对JAVA对象深度克隆进行了详细的分析介绍，需要的朋友参考下
    2013-05-05
  • JavaWeb验证码校验功能代码实例

    JavaWeb验证码校验功能代码实例

    这篇文章主要介绍了JavaWeb验证码校验功能代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Mybatis collection查询集合属性报错的解决方案

    Mybatis collection查询集合属性报错的解决方案

    这篇文章主要介绍了Mybatis collection查询集合属性报错的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-09-09
  • Java数据类型之引用数据类型解读

    Java数据类型之引用数据类型解读

    这篇文章主要介绍了Java数据类型之引用数据类型,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • 23种设计模式（6）java装饰者模式

    23种设计模式（6）java装饰者模式

    这篇文章主要为大家详细介绍了23种设计模式之java装饰者模式，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2017-11-11

最新评论