Spring Boot与logback总结

我们都知道，Spring Boot默认是用logback做为日志系统，同时在logback的基础之上增加了很多Spring特色的feature。在这里将结合实际使用系统地总结一下Spring Boot与logback间千丝万缕的联系。

一、默认配置

同其他Spring Boot支持的组件一样，Spring Boot支持对日志在application.yml或bootstrap.yml进行配置。这里推荐使用bootstrap.yml。在多数情况下，用Spring Boot自带的配置就可以了。这里列出Spring Boot支持的配置

清单1 Spring Boot关于logging的配置

# LOGGING
logging.config= # logback配置文件
logging.exception-conversion-word=%wEx # 定义当日志发生异常时的转换字
logging.file= # 输出的日志文件
logging.file.max-history=0 # 日志保存的天数
logging.file.max-size=10MB # 单个日志文件大小
logging.level.*= # 对某个特定包的输出指定级别的日志 `logging.level.org.springframework=DEBUG`.
logging.path= # 日志的输出路径
logging.pattern.console= # 日志的输出格式，对控制台有效
logging.pattern.dateformat=yyyy-MM-dd HH:mm:ss.SSS # 日志的日期显示格式
logging.pattern.file= # 日志的输出格式，对文件有效
logging.pattern.level=%5p # 日志的级别显示格式
logging.register-shutdown-hook=false # Register a shutdown hook for the logging system when it is initialized.

二、自定义logback配置

有些时候，我们还是需要一些定制化日志配置的。通常情况下，可以通过logback.xml或者logback-spring.xml来进行日志配置。这里强烈推荐使用logback-spring.xml。logback-spring.xml相比原生的logback配置文件多了一些功能，比如可以根据Spring的Profile应用不同的配置。在使用logback-spring.xml之前，我们还需要了解下Spring Boot默认的logback配置。

打开spring-boot-x.x.x.jar包，在org.springframework.boot.logging.logback中可以找到base.xml，这个就是Spring Boot对logback的默认配置了。该文件内容如下：

清单2 base.xml内容

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

<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->

<included>
	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
	<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
	<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="FILE" />
	</root>
</included>

可以看到base.xml中的root logger配置了控制台和文件这两个appender。其中，defaults.xml配置了各个appender的pattern（像是控制台日志酷炫的彩色效果就是在这里面配的）和一些包的日志级别，LOG_FILE等价于Spring Boot中的logging.file，LOG_PATH等价于Spring Boot中的logging.path，从这里我们可以看出LOG_FILE这个属性各个配置变量的优先级。console-appender.xml和file-appender.xml分别对应了控制台和文件appender的配置。这里把base.xml里面的子配置也贴出来。

清单3 defaults.xml

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

<!--
Default logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
	<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
	<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
	<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
	<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
	<property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{yyyy-MM-dd HH:mm:ss.SSS} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

	<appender name="DEBUG_LEVEL_REMAPPER" class="org.springframework.boot.logging.logback.LevelRemappingAppender">
		<destinationLogger>org.springframework.boot</destinationLogger>
	</appender>

	<logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>
	<logger name="org.apache.catalina.util.LifecycleBase" level="ERROR"/>
	<logger name="org.apache.coyote.http11.Http11NioProtocol" level="WARN"/>
	<logger name="org.apache.sshd.common.util.SecurityUtils" level="WARN"/>
	<logger name="org.apache.tomcat.util.net.NioSelectorPool" level="WARN"/>
	<logger name="org.crsh.plugin" level="WARN"/>
	<logger name="org.crsh.ssh" level="WARN"/>
	<logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="ERROR"/>
	<logger name="org.hibernate.validator.internal.util.Version" level="WARN"/>
	<logger name="org.springframework.boot.actuate.autoconfigure.CrshAutoConfiguration" level="WARN"/>
	<logger name="org.springframework.boot.actuate.endpoint.jmx" additivity="false">
		<appender-ref ref="DEBUG_LEVEL_REMAPPER"/>
	</logger>
	<logger name="org.thymeleaf" additivity="false">
		<appender-ref ref="DEBUG_LEVEL_REMAPPER"/>
	</logger>
</included>

清单4 file-appender.xml

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

<!--
File appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
	<appender name="FILE"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<encoder>
			<pattern>${FILE_LOG_PATTERN}</pattern>
		</encoder>
		<file>${LOG_FILE}</file>
		<rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
			<fileNamePattern>${LOG_FILE}.%i</fileNamePattern>
		</rollingPolicy>
		<triggeringPolicy
			class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
			<MaxFileSize>10MB</MaxFileSize>
		</triggeringPolicy>
	</appender>
</included>

清单5 console-appender.xml

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

<!--
Console appender logback configuration provided for import, equivalent to the programmatic
initialization performed by Boot
-->

<included>
	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${CONSOLE_LOG_PATTERN}</pattern>
			<charset>utf8</charset>
		</encoder>
	</appender>
</included>

看到这里，我们不难看出，只要在我们自定义的logback配置文件中include Spring Boot默认的logback配置就可以了。不过需要注意的是，最好不要直接include base.xml，因为base.xml里面已经规定了root里面有默认的CONSOLE和FILE两个appender，在自定义logback配置的时候这两个appender也会加进去，如果你不需要这两个appender就会很麻烦。笔者就曾经遇到过这样的一个问题，无论如何配置logback，都会在/tmp文件夹下生成一个spring.log，后来看到base.xml的时候，恍然大悟。而include的方法很简单，复制base.xml中include节点的前两行即可。如果需要Spring Boot酷炫的彩色控制台输出，那就复制前三行。这里有一个样例，可以根据Spring的Profile进行不同的日志配置，大家可以参考一下。

清单6 bootstrap.yml

logging:
  path: ./log

清单7 logback-spring.yml

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

<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}/}spring.log}"/>
    <springProfile name="dev">
        <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
        <logger name="org.fhp.xxx" level="DEBUG" />

        <root level="INFO">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>

    <springProfile name="test">
        <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
        <logger name="org.fhp.xxx" level="DEBUG" />

        <root level="info">
            <appender-ref ref="CONSOLE" />
        </root>
    </springProfile>

    <springProfile name="prod">
        <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
        <appender name="MY_FILE_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
            <encoder>
                <pattern>${FILE_LOG_PATTERN}</pattern>
            </encoder>
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${LOG_PATH}/stdout.log.%d</fileNamePattern>
            </rollingPolicy>
        </appender>

        <root level="INFO">
            <appender-ref ref="CONSOLE" />
            <appender-ref ref="MY_FILE_APPENDER" />
        </root>
    </springProfile>
</configuration>