spring boot使用logback分环境配置----不是特别完美的解决方案

缘起

之前使用spring boot创建项目时，总是使用logback-dev.xml,logback-test.xml,logback-prod.xml,在yml文件中配置logging.config:logback-${spring.profiles.active}.xml，但是这样三个配置文件 存在大量重复，尝试使用一个配置文件解决。

与spring结合

使用文件名为logback-spring.xml的配置文件放在classpath下，里面配置：

<?xml version="1.0" encoding="UTF-8"?>

<configuration scan="true">

    <contextName>logback-common</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
    <!-- application.properties 需要配置log.path-->
    <springProperty scope="context" name="LOG_HOME" source="log.path" />

    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--输出到文件-->
    <!-- 时间滚动输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/test-common.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>40MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
            <totalSizeCap>3GB</totalSizeCap>
        </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>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--开发环境:打印控制台-->
    <springProfile name="dev">
        <root level="debug">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>

    <!--测试环境-->
    <springProfile name="test">
        <root level="debug">
            <appender-ref ref="FILE" />
        </root>
    </springProfile>

    <!--正式环境-->
    <springProfile name="prod">
        <root level="debug">
            <appender-ref ref="FILE" />
        </root>
    </springProfile>

</configuration>

springProperty标签下的LOG_HOME会自动获取yml文件中的log.path变量(此变量是我自己定义，与logging.path区分开)，这样能动态的配置LOG_HOME还能通过不同环境开启FILE还是CONSOLE日志输出，看起来比较不错，但是总是会出现一个文件夹：LOG_HOME_IS_UNDEFINED。看了下网上的解释，原因是logback的加载在application.yml之前，在创建输出到文件的Appender的时候，application.yml还未加载，获取不到我们自定义的log.path，这就很蛋疼了。

最后我妥协了

围绕LOG_HOME_IS_UNDEFINED，搞来搞去，没有解决根本问题，只能妥协一下，最后出现下面的解决方案：

<?xml version="1.0" encoding="UTF-8"?>

<configuration scan="true">

    <contextName>logback-sfpro-upms</contextName>
    <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 -->
    <!-- application.properties 需要配置log.path-->
    <springProfile name="dev">
        <!--输出到控制台-->
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
                <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
        </appender>
        <root level="debug">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>

    <springProfile name="test">
        <property name="LOG_HOME" value="/test/logs"/>

        <!--输出到文件-->
        <!-- 时间滚动输出 -->
        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <!--日志文件输出的文件名-->
                <FileNamePattern>${LOG_HOME}/sfpro-upms.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>40MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                <!--日志文件保留天数-->
                <MaxHistory>30</MaxHistory>
                <totalSizeCap>3GB</totalSizeCap>
            </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>
                <charset>UTF-8</charset>
            </encoder>
        </appender>

        <root level="debug">
            <appender-ref ref="FILE" />
        </root>
    </springProfile>

</configuration>

yml文件中不需要配置任何东西，只要把这个xml保存为logback-spring.xml，然后放在classpath下即可。

这个把spring和logback结合起来，虽然后面加prod环境不免会重复拷贝一个FILE Appender，但是比起使用3个文件来，感觉还是可以接受的。
如果有更简便，更完美的解决方案，欢迎留言讨论