Spring boot+ logback环境下，日志存放路径未定义的问题

时间：2022-03-07 22:36:53

日志路径未定义

  • 环境：Spring boot + logback
  • 配置文件： 
    <configuration>
    
<springProfile name="dev">
    
    <property name="LOGHOME" value="/logdir/dir"></property>
    
</springProfile>
    
<appender name="syslog"
    
          class="ch.qos.logback.core.rolling.RollingFileAppender">
    
    <File>${LOG    HOME}/sys.log
    
    <encoder>
    
        <pattern>
    
            %d{yyyy-MM-dd HH:mm:SSS} %p [%thread] (%file:%line)- %m%n
    
        </pattern>
    
        <charset>UTF-8</charset>
    
    </encoder>
    
</appender>
  • 问题：
    • 描述：微服务项目启动时，项目src同级目录下会新建一个以日志路径变量名为命名的文件夹。例如上面File标签中的<File>LOG_HOME。
    • 原因：logback先于Spring boot初始化(可以打开logback的debug查看项目初始化日志)，logback初始化时会去查找LOG_HOME变量的值，但是上面的配置<springProfile>标签已经决定了该LOG_HOME的值由Spring来解析，所以先行初始化的logback找不到该变量的值，导致出现上面描述的情况。
    • 补充：虽然logback在项目刚刚启动时，没有找到LOG_HOME的值，但是当Spring Boot初始化到文件解析出LOG_HOME的值时，LOG_HOME的值不再是IS_UNDEFINED的了，而是上面定义的我们想要的路径。
    • 分析：据*上的大神，logback不支持文件的懒加载(其实这个问题想都不用想，spring boot都开始加载了，logback怎么能不先初始化？)。我们这里的问题其实是因为动态改变导致的：开发在windows环境，部署在Linux环境，这就要求开发和生产环境的日志不在相同的路径，但是如果不依赖Java代码，logback是无法在xml文件中动态解析变量值的。
  • 解决方案：
    • 方案1：实现logback的接口，从文件中动态加载变量值，比如我们的application.yml文件里的环境属性dev、prod，以这些值为条件为logback的context添加变量LOG_HOME，及对应的值。这种方案，要新增logback相关代码，并且要在spring boot加载前执行，非常不好！
    • 方案2：添加额外的jar包，在xml文件中进行条件判断。这种方案太麻烦了，xml文件新增好几倍。
    • 方案3：在上面的文件中新增一个 <property name="LOG_HOME" value = "logdir">属性，作为logback初始化时LOG_HOME变量的默认值。这个默认值推荐采用部署服务器上的路径。这种方案最简单，成本最低：没有方案1的代码污染，没有方案2的jar包引入和一大堆xml标签。【最佳实践】

相关文章