前言

日志可以用来帮助开发人员进行故障排查、性能监控、安全监控以及业务流程跟踪等。相比于最原始的System.out.println()输出，日志框架可以对日志程序信息进行分级分类展示，具有更好的可读性，同时可以方便地对日志信息进行控制与存储，十分便利！这里主要记录如何使用Spring Boot默认支持的Logback进行日志的配置。如果有误，还望指出~

在哪里打印

日志打印行为一般发生在Service层。

Service层是业务逻辑的主要实现地点，包含了应用程序的核心逻辑，在Service层打印日志可以更加紧贴业务逻辑。

此外，Service层通常包含可重用的业务逻辑，这些逻辑可能被多个Controller调用。通过在Service层记录日志，可以确保在每个调用点都有相同的日志记录，而不需要在每个Controller中重复编写日志记录代码。

如何打印

在需要打印日志信息的Java类中引入Logger实例，并调用相关方法即可。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RestController
public class LoggingController {

    Logger logger = LoggerFactory.getLogger(LoggingController.class);

    @RequestMapping("/")
    public String index() {
        logger.trace("A TRACE Message");
        logger.debug("A DEBUG Message");
        logger.info("An INFO Message");
        logger.warn("A WARN Message");
        logger.error("An ERROR Message");
        return "Howdy! Check out the Logs to see the output...";
    }
}

如果项目中引入了lombok依赖，可以通过@Log4j2注解，直接将Logger实例添加到类中。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@RestController
@Log4j2  // 使用 @Log4j2 
public class LombokLoggingController {
 
    @RequestMapping("/lombok")
    public String index() {

        // log 变量是 Lombok 在编译时生成的，可以直接使用
        log.trace("A TRACE Message");
        log.debug("A DEBUG Message");
        log.info("An INFO Message");
        log.warn("A WARN Message");
        log.error("An ERROR Message");
 
        return "Howdy! Check out the Logs to see the output...";
    }
}

如何设置打印格式

Spring Boot会扫描项目src\main\resources路径下的logback.xml / logback-spring.xml（优先级更高）来设置日志打印格式，下面是一个配置文件的示例。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<?xml version="1.0" encoding="UTF-8" ?>

<configuration>
    <!-- 从高到低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
    <!-- 日志输出规则  根据当前ROOT 级别，日志输出时，级别高于root默认的级别时  会输出 -->
    <!-- 以下  每个配置的 filter 是过滤掉输出文件里面，会出现高级别文件，依然出现低级别的日志信息，通过filter 过滤只记录本级别的日志-->
    <!-- 定义日志文件 输入位置 -->
    <property name="logPath" value="D:/temp/logback/log-back.log"/>
    <!-- 日志最大的历史 30天，这个参数要看你基于哪一种滚动策略【基于天，单位为天，月同理】本文件设置的多事基于天滚动策略 -->
    <property name="maxHistory" value="30"/>
    <!-- 日志输出格式【控制台】-->
    <!--<property name="logPatternConsoleLog"-->
    <!--          value="%date{yyyy-MM-dd HH:mm:ss} | %highlight(%-5.5p) | %boldYellow(%-80.80c) | %boldGreen(%-8.8L): %magenta(%-30M) : %boldBlue(%-20.20t) | %cyan(%m) %n"/>-->
    <!--提供两个格式的输出，如果觉得上面的信息太过详细，可使用下面的格式-->
    <property name="logPatternConsoleLog" value="%highlight(%-5.5p) | %boldYellow(%-40.40c{40}) | %boldGreen(%-8.8L)| %cyan(%m) %n"/>

    <property name="logPattern" value="%date{yyyy-MM-dd HH:mm:ss} | %p | %c | %M:%L | %m%n"/>
    <!-- 日志输出编码格式 -->
    <property name="logCharset" value="UTF-8"/>

    <!--配置控制台的输出-->
    <appender name="consoleLog" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${logPatternConsoleLog}</pattern>
            <charset>${logCharset}</charset>
        </encoder>
    </appender>

    <!--配置文件输出:error-->
    <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录ERROR级别的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>       <!--如果是匹配，就接受这条规则【整个appender块】，FilterReply类（DENY，NEUTRAL，ACCEPT）-->
            <onMismatch>DENY</onMismatch>   <!--如果没有匹配，就禁止-->
            <!--<onMismatch>NEUTRAL</onMismatch>-->     <!--如果没有匹配，就忽略这条规则，看下一个【appender块规则是否接受】-->
        </filter>
        <encoder>
            <pattern>${logPattern}</pattern>
            <charset>${logCharset}</charset>
        </encoder>
        <!--滚动策略：每天一个日志文件-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--路径-->
            <fileNamePattern>${logPath}/%d{yyyy-MM-dd}/error.%d.log</fileNamePattern>
            <!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件假设设置每个月滚动，且<maxHistory>是30，
            则只保存最近30天的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除-->
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
    </appender>

    <!--配置文件输出：info-->
    <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <pattern>${logPattern}</pattern>
            <charset>${logCharset}</charset>
        </encoder>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${logPath}/%d{yyyy-MM-dd}/info.%d.log</fileNamePattern>
            <maxHistory>${maxHistory}</maxHistory>
        </rollingPolicy>
    </appender>

    <!--设置日志级别-->
    <root level="info">
        <appender-ref ref="consoleLog"/>        <!--控制台-->
        <appender-ref ref="fileErrorLog"/>      <!--error文件-->
        <appender-ref ref="fileInfoLog"/>       <!--info文件-->
    </root>

    <!-- 设置某个包的日志级别 -->
    <logger name="cn.wrenxr.arcc.web.service" level="trace"/>
</configuration>

该配置文件的架构如下：

logback配置文件.drawio

其中：

  • appender节点

    Logback 允许日志在多个地方进行输出。站在 Logback 的角度来说，输出目的地叫做 appender。appender 包括console、file、remote socket server、MySQL、PostgreSQL、Oracle 或者其它的数据库、JMS、remote UNIX Syslog daemons 中。

  • logger节点

    一个 logger 可以有多个 appender。对于给定的 logger，每一个允许输出的日志都会被转发到该 logger 的所有 appender 中去。

    如果再给一个叫做 L 的 logger 添加了一个 file appender，那么 L 以及 L 的子级 logger 都可以在文件和控制台打印日志。

    <root />是根日志记录器，相当于<logger name="root" />，是所有logger的父节点。

  • additivity属性

    logger 的 additivity 属性是用来控制日志事件是否向父节点 logger 传递。

    • 当 additivity 属性设置为 true 时，日志事件不仅会被当前 logger 处理，也会被传递给父节点 logger 处理。
    • 当 additivity 属性设置为 false 时，日志事件只会被当前 logger 处理，不会被传递给父节点 logger 处理。

    如果一个 logger 的 additivity 属性设置为 false，表示该 logger 不会将日志事件传递给其父节点 logger。这通常用于避免日志事件在多个 logger 中重复输出的情况。比如，如果我们在应用程序中有一个名为 com.example 的 logger，而其父节点是 root logger，如果我们想要避免输出重复的日志，我们可以将 com.example logger 的 additivity 属性设置为 false，这样日志事件就只会被 com.example logger 处理，不会再传递给 root logger 处理了。

几种日志框架的区别

SLF4J

slf4j 就是众多日志接口的集合，他不负责具体的日志实现，只在编译时负责寻找合适的日志系统进行绑定。具体有哪些接口，全部都定义在 slf4j-api 中。查看 slf4j-api 源码就可以发现，里面除了 publicfinalclassLoggerFactory 类之外，都是接口定义。

因此，slf4j-api 本质就是一个接口定义。总之，Slf4j 更好的兼容了各种具体日志实现的框架，如图：

img

Log4j

Apache Log4j 是一个非常古老的日志框架，并且是多年来最受欢迎的日志框架。 它引入了现代日志框架仍在使用的基本概念，如分层日志级别和记录器。

2015 年 8 月 5 日，该项目管理委员会宣布 Log4j 1.x 已达到使用寿命。 建议用户使用 Log4j 1 升级到 Apache Log4j 2。

Log4j2

Apache Log4j 2是对 Log4j 的升级，它比其前身 Log4j 1.x 提供了重大改进，并提供了 Logback 中可用的许多改进，同时修复了 Logback 架构中的一些固有问题。

与 Logback 一样，Log4j2 提供对 SLF4J 的支持，自动重新加载日志配置，并支持高级过滤选项。 除了这些功能外，它还允许基于 lambda 表达式对日志语句进行延迟评估，为低延迟系统提供异步记录器，并提供无垃圾模式以避免由垃圾收集器操作引起的任何延迟。

所有这些功能使 Log4j2 成为这三个日志框架中最先进和最快的。

Logback

logback 是由 log4j 创始人设计的又一个开源日志组件，作为流行的 log4j 项目的后续版本，从而替代 log4j。

Logback 的体系结构足够通用，以便在不同情况下应用。 目前，logback 分为三个模块：logback-core，logback-classic和logback-access。

  • logback-core：模块为其他两个模块的基础。
  • logback-classic：模块可以被看做是log4j的改进版本。此外，logback-classic 本身实现了 SLF4J API，因此可以在 logback 和其他日志框架（如 log4j 或 java.util.logging（JUL））之间来回切换。
  • logback-access：模块与 Servlet 容器（如 Tomcat 和 Jetty）集成，以提供 HTTP 访问日志功能。

总结

建议直接选择 SLF4J 而不是 Log4j，commons logging，logback 或 java.util.logging。

  • 在开源库或内部库中使用 SLF4J，将使其独立于任何特定的日志记录实现，这意味着无需为多个库管理多个日志记录配置，您的客户端将会很需要这一点；
  • SLF4J 提供了基于占位符的日志记录，通过删除检查（isDebugEnabled()，isInfoEnabled()等）来提高代码的可读性；
  • 另外，临时字符串数量越少意味着垃圾收集器的工作量就越少，这意味着应用程序的吞吐量和性能会更好。

参考链接