脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → 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。

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

您可能感兴趣的文章:

相关文章

  • Maven编译错误:程序包com.sun.*包不存在的三种解决方案

    Maven编译错误:程序包com.sun.*包不存在的三种解决方案

    J2SE中的类大致可以划分为以下的各个包：java.*,javax.*,org.*,sun.*,本文文章主要介绍了maven编译错误:程序包com.sun.xml.internal.ws.spi不存在的解决方案,感兴趣的可以了解一下
    2024-02-02
  • Java中Map.merge()方法使用示例详解

    Java中Map.merge()方法使用示例详解

    这篇文章主要介绍了Map.merge()方法使用和介绍,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2023-08-08
  • Java日常练习题,每天进步一点点(3)

    Java日常练习题,每天进步一点点(3)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧，希望可以帮到你
    2021-07-07
  • 解决Springboot @WebFilter拦截器未生效问题

    解决Springboot @WebFilter拦截器未生效问题

    这篇文章主要介绍了解决Springboot @WebFilter拦截器未生效问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • 解决IDEA中maven导入jar包一直报错问题

    解决IDEA中maven导入jar包一直报错问题

    这篇文章主要介绍了解决IDEA中maven导入jar包一直报错问题，本文通过实例图文的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-04-04
  • Java 高并发九：锁的优化和注意事项详解

    Java 高并发九：锁的优化和注意事项详解

    本文主要介绍Java高并发锁的优化和注意事项，这里整理了详细的资料，并讲解了 1. 锁优化的思路和方法 2. 虚拟机内的锁优化 3. 一个错误使用锁的案例 4. ThreadLocal及其源码分析等知识，有需要的小伙伴可以参考下
    2016-09-09
  • Spring中的代理ProxyFactory解析

    Spring中的代理ProxyFactory解析

    这篇文章主要介绍了Spring中的ProxyFactory解析,在Java中,代理模式的实现通常依靠Proxy类和InvocationHandler接口,本文将介绍如何使用ProxyFactory来创建代理模式,需要的朋友可以参考下
    2023-12-12
  • Java Lambda表达式原理及多线程实现

    Java Lambda表达式原理及多线程实现

    这篇文章主要介绍了Java Lambda表达式原理及多线程实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • java servlet手机app访问接口(一)数据加密传输验证

    java servlet手机app访问接口(一)数据加密传输验证

    这篇文章主要为大家详细介绍了java servlet手机app访问接口(一)，数据加密传输验证，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2016-12-12
  • 详解java中的synchronized关键字

    详解java中的synchronized关键字

    这篇文章主要介绍了java中的synchronized关键字，可用来给对象和方法或者代码块加锁，当它锁定一个方法或者一个代码块的时候，同一时刻最多只有一个线程执行这段代码，感兴趣的小伙伴们可以参考一下
    2015-12-12

最新评论