Spring Boot 日志框架与配置详解

2.2 日志框架

在使用 Logger 类的时候，会有很多包。

这几个包的关系如下：

以电视机和遥控器来举例，日志实现就相当于不同品牌的电视，而日志门面就相当于一个通用的遥控器。

2.2.1 门面 / 外观模式

门面模式： 门面模式（Facade Pattern）又称为外观模式，提供了一个统一的接口，用来访问子系统中的一群接口。其主要特征是定义了一个高层接口，让子系统更容易使用。

门面模式主要包含 2 种角色:

外观角色 (Facade): 也称门面角色，系统对外的统一接口.

子系统角色 (SubSystem): 可以同时有一个或多个 SubSystem。每个 SubSystem 不是一个单独的类，而是一个类的集合。SubSystem 并不知道 Facade 的存在，对于 SubSystem 而言，Facade 只是另一个客户端而已 (即 Facade 对 SubSystem 透明)

2.3 日志级别

2.3.1 六大分类

日志的级别从高到低依次为：FATAL、ERROR、WARN、INFO、DEBUG、TRACE

FATAL: 致命信息，表示需要立即被处理的系统级错误。 ERROR: 错误信息，级别较高的错误日志信息，但仍然不影响系统的继续运行。 WARN: 警告信息，不影响使用，但需要注意的问题。 INFO: 普通信息，用于记录应用程序正常运行时的一些信息，例如系统启动完成、请求处理完成等。 DEBUG: 调试信息，需要调试时候的关键信息打印。 TRACE: 追踪信息，比 DEBUG 更细粒度的信息事件 (除非有特殊用意，否则请使用 DEBUG 级别替代)

2.3.2 使用

对于不同级别的日志，Spring Boot 的 Logger 类下面有对应名字的方法（FATAL 除外）。

Spring Boot 默认的日志框架是 Logback，Logback 没有 FATAL 级别，它被映射到 ERROR。出现 fatal 日志，表示服务已经出现了某种程度的不可用，需要系统管理员紧急介入处理。通常情况下，一个进程生命周期中应该最多只有一次 FATAL 记录。

package com.example.captcha.Controller;

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

@RequestMapping("/log")
@RestController
public class LogController {
    private final static Logger LOGGER = LoggerFactory.getLogger(LogController.class);

    @RequestMapping("/print")
    public String print() {
        //LOGGER.info("日志");
        LOGGER.trace("trace 级别日志");
        LOGGER.debug("debug 级别日志");
        LOGGER.info("info 级别日志");
        LOGGER.warn("warn 级别日志");
        LOGGER.error("error 级别日志");
        return "日志";
    }
}

上述代码的结果如下：

只会显示 info 级别及其以上级别的日志，这是因为 Spring 在默认的配置下是显示 info 级以上级别日志。

2.4 日志级别配置

我们只需要在配置文件加上 logging.level.目录 就可以配置相对应目录下的日志显示级别。

如果我们在配置文件中加上这样的配置信息：

logging:
  level:
    com.example.captcha.Controller: trace

那么我们打印的日志就会变成下面的这样：

2.5 日志的持久化

日志如果不进行配置，默认日志都是输出在控制台上的，然而在线上环境中，我们需要把日志保存下来，以便出现问题之后追溯问题。把日志保存下来就叫持久化。

我们可以将日志写入文件。Spring 中有以下两个配置项，来配置日志写入的文件。

• logging.file.name 配置项，可以包含文件的路径和文件名。
• logging.file.path 配置项，只能包含文件路径。
• 当两个配置项同时存在的时候，只有 logging.file.name 会有作用。

我们进行如下配置：

logging:
  file:
    name: logger/log.log
    path: all

得到如下结果：

2.6 日志文件分割

日志文件分割有以下两个相关的配置项：

• logging.logback.rollingPolicy.maxFileSize 配置项，用于配置每个文件的大小。
• logging.logback.rollingPolicy.fileNamePattern 配置项，用于配置每个文件的名字及其格式。

我们写下如下配置：

logging:
  logback:
    rollingPolicy:
      maxFileSize: 1KB
      fileNamePattern: ${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

结果就如下：

注意事项：

• logging.logback.rollingPolicy.maxFileSize 配置项，并不是严格的每个文件都不会超过配置的大小，而是按照必须将当前的日志行写完才分割。
• logging.logback.rollingPolicy.fileNamePattern 配置项，默认格式 ${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

2.7 日志文件格式

日志文件格式分割有以下两个相关的配置项：

配置项说明:

1. %clr(表达式){颜色} 设置输入日志的颜色。支持 blue cyan faint green magenta red yellow
2. %d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}} 日期和时间–精确到毫秒
3. %5p 显示日志级别 ERROR, WARN, INFO, DEBUG, TRACE.
4. %t 线程名.
5. %c 类的全限定名.
6. %M method.
7. %L 为行号.
8. %thread 线程名称.
9. %m 或者 %msg 显示输出消息.
10. %n 换行符
11. %5 若字符长度小于 5，则右边用空格填充.
12. %-5 若字符长度小于 5，则左边用空格填充.
13. %.15 若字符长度超过 15，截去多余字符.
14. %15.15 若字符长度小于 15，则右边用空格填充。若字符长度超过 15，截去多余字符

2.8 @Slf4j 简单打印日志

我们可以使用 lombok 提供的 @Slf4j 注解来打印日志，这个注解的作用相当于就是 Spring 帮我们创建 Logger 对象，对象名为 log。

例如下面代码：

package com.example.captcha.Controller;

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

@RequestMapping("/log")
@RestController
@Slf4j
public class LogController {
    @RequestMapping("/print")
    public String print() {
        //LOGGER.info("日志");
        log.trace("trace 级别日志");
        log.debug("debug 级别日志");
        log.info("info 级别日志");
        log.warn("warn 级别日志");
        log.error("error 级别日志");
        return "日志";
    }
}

结果如下：