Spring Boot 入门系列（三） 集成Logback

文章使用版本为 Spring Boot 2.1.x

前言

对于任何项目来说，打印日志都是必不可少的，日志的框架很多，这里我们要学习的就是非常流行的 logback，logback同时也是spring boot默认使用的日志框架。在spring boot中有两种方式配置logback，一是直接在application.yml中配置，这种方式可以进行简单的配置；二是在logback-spring.xml中配置，这种方式功能强大，可以进行复杂的配置。

日志级别

日志级别从低到高依次是trace、debug、info、warn、error，当我们设置了某个日志打印级别的时候，那么级别比它高的也将被打印，比如日志级别设置为info，那么info、warn、error的日志都会被打印。

在application.yml中配置

新建一个spring boot项目，在application.yml中添加一下配置

logging:
  level:
    org.schhx.springbootlearn: debug #指定日志级别
  pattern:
    console: "%d %-5level - %msg%n" #日志输出格式

添加测试类

package org.schhx.springbootlearn;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class LogTest {

    private final Logger logger = LoggerFactory.getLogger(LogTest.class);

    @Test
    public void printLog() throws Exception {
        logger.trace("msg:{}", "trace");
        logger.debug("msg:{}", "debug");
        logger.info("msg:{}", "info");
        logger.warn("msg:{}", "warn");
        logger.error("msg:{}", "error");
    }
}

启动测试类，可以看到结果如下

2018-01-21 16:30:34,470 DEBUG - msg:debug
2018-01-21 16:30:34,474 INFO  - msg:info
2018-01-21 16:30:34,474 WARN  - msg:warn
2018-01-21 16:30:34,474 ERROR - msg:error

可以看出日志级别和输出格式都是和我们的设置一致，这种方式可以做些简单的配置，但是做复杂的配置就显得有些心有余而力不足。

在logback-spring.xml中配置

logback-spring.xml其实就是一个普通的logback的配置文件，只不过这个文件会被spring boot自动加载。关于logback的常用配置，本篇文章不会过多讨论，如果不太熟悉可以参考 logback常用配置。

另外spring boot允许我们通过<springProperty>标签把application.yml中的配置引用到logback-spring.xml。例如，我们在application.yml中配置

logging:
  pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%file:%line] - %msg%n"

然后可以在logback-spring.xml使用

<springProperty name="LOG_PATTERN" source="logging.pattern"
                    defaultValue="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%file:%line] - %msg%n"/>

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

spring boot已经内置了一些引用我们可以直接使用，例如logging.path对应LOG_PATH，完整文档请参考Spring Boot官方文档。

多环境配置

一般情况下，我们想在本机测试时，把日志打印到控制台；而在服务器上运行时，把日志打印到文件。想实现这种功能我们可以使用<springProfile>标签，例如

    <springProfile name="default">
        <root level="info">
            <appender-ref ref="console"/>
        </root>
        <logger name="org.schhx.springbootlearn" level="debug"/>
    </springProfile>

    <springProfile name="dev,test,prod">
        <root level="info">
            <appender-ref ref="file-error"/>
            <appender-ref ref="file-info"/>
        </root>
    </springProfile>

完整配置

下面是总结上述所说，给出一个完整的logback-spring.xml配置。

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <springProperty name="LOG_PATTERN" source="logging.pattern"
                    defaultValue="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger [%file:%line] - %msg%n"/>

    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>

    <appender name="file-error" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_PATH:-.}/error.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <charset>UTF-8</charset>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
    <appender name="file-info" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${LOG_PATH:-.}/info.%d{yyyy-MM-dd}.%i.log</FileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <charset>UTF-8</charset>
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>


    <springProfile name="default">
        <root level="info">
            <appender-ref ref="console"/>
        </root>
        <logger name="org.schhx.springbootlearn" level="debug"/>
    </springProfile>

    <springProfile name="dev,test,prod">
        <root level="info">
            <appender-ref ref="file-error"/>
            <appender-ref ref="file-info"/>
        </root>
    </springProfile>

</configuration>

完整示例

github