SpringBoot项目在logback.xml中读取配置中的日志路径问题

一、问题

在SpringBoot项目，使用logback.xml中配置日志的存储位置时，读取application.properties或application.yml中配置的路径，在logback.xml中引用如下：

<property name="LOG_HOME" value="${log.path}"/>

发现application.properties配置的路径可以读取的到，但是application.yml中的就不能读取到。

二、原因

因为最先加载的是application.properties，logback.xml的加载晚于application.properties，所以logback.xml可以读到application.properties里面配置的值。logback.xml的加载要先于application.yml，所以直接通过${参数key}的形式获取是无法获取到application.yml对应参数值的。

三、logback.xml中读取配置中的日志路径方案

（1）方案一：使用application.properties配置生成日志文件的路径。

logback.xml配置如下：

启动项目发现可以在指定的目录下生成日志：

（2）方案二：使用application.yml配置生成日志文件的路径。

这种方案虽然受到配置文件加载顺序的影响，但是还是有解决办法的。我们可以使用Spring提供的标签来对此参数进行设置：

<springProperty scope="context" name="LOG_HOME" source="log.path"/>

对于上面的配置，其中property替换成了springProperty标签。两个配置的属性name的效果是一样的，只不过springProperty的source指向application.yml中的key，此处是不需要加${}来获取值的。此时，不要着急，还有一步就是将logback.xml文件名改为logback-spring.xml

yml配置：

logback-spring.xml配置文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <property resource="application.properties"/>
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径     使用spring-boot的配置项LOG_PATH-->
    <springProperty scope="context" name="LOG_HOME" source="log.path"/>
<!--    <property name="LOG_HOME" value="${log.path}" />-->
    <property name="LOG_LEVEL" value="INFO" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
             <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>   
        </encoder> 
    </appender>
    <!-- 按照每天生成日志文件 -->   
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/springbootjpa.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>   
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"> 
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符--> 
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>   
        </encoder> 
        <!--日志文件最大的大小-->
       <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
         <MaxFileSize>10MB</MaxFileSize>
       </triggeringPolicy>
    </appender> 
  
    <logger name="com.wm.springbootjpa01" level="INFO"/>
    <logger name="org.apache.ibatis" level="${LOG_LEVEL}"/>
    <logger name="org.mybatis.spring" level="${LOG_LEVEL}"/>
    <logger name="org.springframework" level="${LOG_LEVEL}"/>
    <logger name="java.sql.Connection" level="${LOG_LEVEL}"/>
    <logger name="java.sql.Statement" level="${LOG_LEVEL}"/>
    <logger name="java.sql.PreparedStatement" level="${LOG_LEVEL}"/>

    <!--设置为OFF,即屏蔽; 留下sqltiming作为INFO级别输出-->
    <logger name="jdbc.connection" level="OFF"/>
    <logger name="jdbc.resultset" level="OFF"/>
    <logger name="jdbc.resultsettable" level="OFF"/>
    <logger name="jdbc.audit" level="OFF"/>
    <logger name="jdbc.sqltiming" level="INFO"/>
    <logger name="jdbc.sqlonly" level="OFF"/>

    <!-- 日志输出级别 -->
    <root level="${LOG_LEVEL}">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root> 
</configuration>