spring boot使用logback实现多环境日志配置详解
作者:封巍 发布时间:2022-10-03 20:38:24
软件生存周期中,涉及代码运行的环节有编码、测试和维护阶段,而一套成熟的代码,在此三个阶段,数据库、日志路径、日志级别、线程池大小等配置一般会不一样。作为开发人员,希望将代码与配置解耦合,不同的环境,代码一套,而配置多套。
针对于多环境的配置,可以使用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。
来源:https://blog.csdn.net/vitech/article/details/53812137
猜你喜欢
- 前言本文以用户名/密码验证方式为例,讲解 Spring Security 的认证流程,在此之前,需要你了解 Spring Security
- 一、前言让我们先理一下springfox与swagger的关系。swagger是一个流行的API开发框架,这个框架以“开放API声明”(Op
- 目录一、Java 类加载过程1、字节码编译2、加载3、连接4、初始化总结一、Java 类加载过程1、字节码编译编写好 Java 源码 Stu
- package TestList;import java.util.ArrayList;import java.util.Iterator;
- 首先要引用一下类库:using Ionic.Zip;这个类库可以到网上下载。下面对类库使用的封装方法:得到指定的输入流的ZIP压
- 将索引设置为只读可能听起来很奇怪,但在 Elasticsearch 中执行此类操作是可能的。想象一下这样一种情况,你特别需要限制对索引的写入
- 使用类的全权名: System.Text.StringBuilder sb = new System.Text.StringBuilder(
- 前言本文章主要从spring security安全认证登录内部调用流程来流程分析登录过程。一、登录时序图时序原图二、配置与代码1.引入库po
- 本文实例讲述了Java实现的Base64加密算法。分享给大家供大家参考,具体如下:一 算法实现1、JDK2、Commonc Codec3、B
- 说明:在填写表数据时当输入完一个文本框后,输入下一个文本框时需要用Tab键切换,但是有的人喜欢用Enter键切换下一个,此方法是Enter取
- 概述线程池的好处和使用本篇文章就不赘叙了,不了解的可以参考下面两篇文章:一文全貌了解线程池的正确使用姿势学习线程池原理从手写一个线程池开始那
- 网上很多资料在描述Java内存模型的时候,都会介绍有一个主存,然后每个工作线程有自己的工作内存。数据在主存中会有一份,在工作内存中也有一份。
- 1、简单又有效的方法是使用PreparedStatement采用预编译语句集,它内置了处理SQL注入的能力,只要使用它的setXXX(如:s
- 本文为大家分享了使用entrySet方法获取Map集合中元素的具体代码,供大家参考,具体内容如下/*--------------------
- IDEA service层跳转实现类的快捷图标消失了,但别人IDEA同样的代码可以正常看到跳转图标。。(暗示:这只是你的IDEA 编译器的b
- @Autowired使用构造函数注入public Class Outer { private Inner inner; @Autowired
- 本次为了记录开发一个基于webservice接口,去解析对方传送过来的xml字符串。实际使用时遇到的一些问题。传输过来的xml格式大致如下:
- 目录1,基本介绍2,HttpURLConnection实现3.HttpClient实现4.Spring的RestTemplate1,基本介绍
- 1.雪崩效应 雪崩效应如上图所示,假设我们有3个微服务A,B,C,A调用B,B调用C,如果C挂掉了,由于B是同步调用,不断等待,导致资源耗尽
- 三层架构将整个业务应用划分为:(1)界面UI层(2)业务逻辑层(3)数据访问层对于复杂的系统分层可以让结构更加清晰,模块更加独立,便于维护。