Spring Boot 使用 SLF4J 进行日志记录

在开发中，我们经常使用 System.out.println() 打印一些信息，但是这样做不好， 因为大量使用 System.out 会增加资源的消耗。

在实际项目中，我们则使用 SLF4J 的 Logback 来输出日志，效率更高，Spring Boot 提供了一套日志系统，Logback 是最优的选择，本节课重点讲解 SLF4J 及 Logback，核心内容有：

• 认识 SLF4J
• 在 application.yml 中配置日志
• 解析 logback.xml 配置文件
• 使用 Logger 打印日志

3.1 认识 SLF4J

根据官方的说明，SLF4J 是一个用于日志系统的简单 Facade，允许最终用户在部署其应用时使用其所希望的日志系统。大概意思是指你只需要按统一的方式写记录日志的代码，而无需关心日志是通过哪个日志系统，以什么风格输出的，因为它们取决于部署项目时绑定的日志系统。

例如，在项目中使用了 SLF4J 记录日志，并且绑定了 Log4j（即导入相应的依赖），则日志会以 Log4j 的风格输出；后期需要改为以 Logback 的风格输出日志，只需要将 Log4j 替换成 Logback 即可，不用修改项目中的代码。

可以说，引入不同第三方组件的日志系统，其学习成本几乎为零，当然它的优点不仅仅这一个，还有简洁的占位符和日志级别的判断。

正因为 SLF4J 有如此多的优点，阿里巴巴已经将 SLF4J 作为他们的日志框架了。在《 阿里巴巴 Java 开发手册（正式版）》中，日志规约一项第一条就强制要求使用 SLF4J ：

1.【强制】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

“强制” 两个字体现出了 SLF4J 的优势，所以建议在实际项目中，使用 SLF4J 作为自己的日志框架。

使用 SLF4J 记录日志非常简单，直接使用 LoggerFactory 创建即可。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Test {
    private static final Logger logger = LoggerFactory.getLogger(Test.class);
    // ……
}

3.2 在 application.yml 中配置日志

Spring Boot 对 SLF4J 支持得很好，内部已经集成了 SLF4J，一般我们在使用的时候，会对 SLF4J 做一下配置。

application.yml 文件是 Spring Boot 中唯一一个需要配置的文件。一开始创建工程的时候是 application.properties 文件，而我个人比较喜欢用 yml 文件。

yml 文件的层次感特别好，看起来更直观，但是 yml 文件对格式要求比较高，比如英文冒号后面必须要有个空格，否则项目将无法启动，而且也不报错。用 properties 还是 yml 视个人习惯而定，两者都可以。本课程使用 yml。

我们看一下 application.yml 文件中对日志的配置：

logging:
  config: logback.xml
  level:
    com.itcodai.course03.dao: trace

logging.config 用来指定项目启动的时候，读取哪个配置文件，这里指定的日志配置文件是根路径下的 logback.xml 文件。关于日志的相关配置信息，都放在了 logback.xml 文件中。

logging.level 用来指定具体的 Mapper 中日志的输出级别，上面的配置表示 com.itcodai.course03.dao 包下的所有 Mapper 日志输出级别为 Trace，会将操作数据库的 SQL 打印出来。开发时设置成 trace 方便定位问题，在生产环境上，将这个日志级别再设置成 error 级别即可（本文不讨论 Mapper 层，在后面 Spring Boot 集成 MyBatis 时再详细讨论）。

常用的日志级别按照从高到低依次为：ERROR、WARN、INFO、DEBUG。

3.3 解析 logback.xml 配置文件

在上面的 application.yml 文件中，我们指定了日志配置文件 logback.xml。

logback.xml 文件主要用来做日志的相关配置。在 logback.xml 中，我们可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长，等等。下面来分析一下。

3.3.1 定义日志输出格式和存储路径

<configuration>
    <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
    <property name="FILE_PATH" value="D:/logs/course03/demo.%d{yyyy-MM-dd}.%i.log" />
</configuration>

我们来看一下这个定义的含义。首先定义一个格式，命名为 “LOG_PATTERN”，该格式中 %date 表示日期，%thread 表示线程名，%-5level 表示级别从左显示 5 个字符宽度，%logger{36} 表示 Logger 名字最长 36 个字符，%msg 表示日志消息，%n 是换行符。

然后再定义名为 FILE_PATH 的文件路径，日志都会存储在该路径下。%i 表示第 i 个文件，当日志文件达到指定大小时，会将日志生成到新的文件里，这里的 i 就是文件索引，日志文件允许的大小可以设置，下面会讲解。这里需要注意的是，不管是 Windows 系统还是 Linux 系统，日志存储的路径必须是绝对路径。

3.3.2 定义控制台输出

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <!-- 按照上面配置的 LOG_PATTERN 来打印日志 -->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
</configuration>

使用 节点设置控制台输出的配置，定义为 CONSOLE。使用上面定义好的输出格式（LOG_PATTERN）来输出，使用 ${} 引用进来即可。

3.3.3 定义日志文件的相关参数

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按照上面配置的 FILE_PATH 路径来保存日志 -->
            <fileNamePattern>${FILE_PATH}</fileNamePattern>
            <!-- 日志保存 15 天 -->
            <maxHistory>15</maxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!-- 单个日志文件的最大值，超过则新建日志文件存储 -->
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>

        <encoder>
            <!-- 按照上面配置的 LOG_PATTERN 来打印日志 -->
            <pattern>${LOG_PATTERN}</pattern>
        </encoder>
    </appender>
</configuration>

使用 定义一个名为 FILE 的文件配置，主要是配置日志文件保存的时间、单个日志文件存储的大小，以及文件保存的路径和日志的输出格式。

3.3.4 定义日志输出级别

<configuration>
    <logger name="com.itcodai.course03" level="INFO" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

有了上面那些定义后，最后我们使用 来定义一下项目中默认的日志输出级别，这里定义级别为 INFO，然后针对 INFO 级别的日志，使用 引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml 文件中的配置就设置完了。

3.4 使用 Logger 打印日志

在代码中，我们一般使用 Logger 对象打印 Log 信息，可以指定打印出的日志级别，也支持占位符，很方便。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

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

    @RequestMapping("/log")
    public String testLog() {
        logger.debug("=====测试日志 Debug 级别打印====");
        logger.info("======测试日志 Info 级别打印=====");
        logger.error("=====测试日志 Error 级别打印====");
        logger.warn("======测试日志 Warn 级别打印=====");

        // 可以使用占位符打印出一些参数信息
        String str1 = "blog.itcodai.com";
        String str2 = "blog.csdn.net/eson_15";
        logger.info("======倪升武的个人博客：{}；倪升武的 CSDN 博客：{}", str1, str2);

        return "success";
    }
}

启动该项目，在浏览器中输入：localhost:8080/test/log 后可以看到控制台的日志记录：

 ======测试日志 Info 级别打印=====
=====测试日志 Error 级别打印====
======测试日志 Warn 级别打印=====
======倪升武的个人博客：blog.itcodai.com；倪升武的 CSDN 博客：blog.csdn.net/eson_15

因为 Info 级别比 Debug 级别高，所以 Debug 这条没有打印出来，如果将 logback.xml 中的日志级别设置成 Debug，那么四条语句都会打印出来，这个大家自己去测试了。同时可以打开 D:\logs\course03\ 目录，里面有项目刚刚启动时及后面生成的所有日志记录。项目部署后，我们大部分都通过查看日志文件来定位问题。