Java日志系统

一、入门

📕Java中的日志系统

1. JUL

Java Util Logging ：Java 原生的日志框架。

JUL 不需要引入第三方依赖包。包含了一些核心组件，如记录器（Logger）、处理器（Handler）、格式化器（Formatter）和过滤器（Filter）等。适用于小型应用或对日志功能要求不高的场景。

JUL 本身并没有像 Slf4j 那样专门的、广泛使用的日志门面。主要就是 Java 自身提供的一套日志机制，直接使用其相关的 API 来进行日志操作。

可以使用Lombok快速开启日志

@Log
public class Main {
    public static void main(String[] args) {
        System.out.println("自动生成的Logger名称："+log.getName());
        log.info("我是日志信息");
    }
}

只需要添加一个@Log注解即可，添加后，我们可以直接使用一个静态变量log，而它就是自动生成的Logger。

2. 日志门面

日志门面：如Slf4j，把不同的日志系统的实现进行了具体的抽象化，只提供了统一的日志使用接口，使用时只需要按照其提供的接口方法进行调用即可，由于它只是一个接口，并不是一个具体的可以直接单独使用的日志框架，所以最终日志的格式、记录级别、输出方式等都要通过接口绑定的具体的日志系统来实现，这些具体的日志系统就有log4j、logback等，也叫做日志实现。

但是不同的框架可能使用了不同的日志框架，如果这个时候出现众多日志框架并存的情况，我们现在希望的是所有的框架一律使用日志门面（Slf4j）进行日志打印，这时该怎么去解决？我们不可能将其他框架依赖的日志框架替换掉，直接更换为Slf4j吧，这样显然不现实。

这时，可以采取类似于偷梁换柱的做法，只保留不同日志框架的接口和类定义等关键信息，而将实现全部定向为Slf4j调用。相当于有着和原有日志框架一样的外壳，对于其他框架来说依然可以使用对应的类进行操作，而具体如何执行，真正的内心已经是Slf4j的了。

所以，SpringBoot为了统一日志框架的使用，做了这些事情：

• 直接将其他依赖以前的日志框架剔除
• 导入对应日志框架的Slf4j中间包
• 导入自己官方指定的日志实现，并作为Slf4j的日志实现层

SpringBoot使用的是Slf4j作为日志门面，Logback（是log4j 框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J）作为日志实现，对应的依赖为：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-logging</artifactId>
</dependency>

此依赖已经被包含了，所以我们如果需要打印日志，可以像这样：

@ResponseBody
@GetMapping("/test")
public User test(){
    Logger logger = LoggerFactory.getLogger(TestController.class);
    logger.info("用户访问了一次测试数据");
    return mapper.findUserById(1);
}

因为我们使用了Lombok，所以直接一个注解也可以搞定：

@Slf4j
@Controller
public class MainController {

  	@ResponseBody
	@GetMapping("/test")
    public User test(){
    		log.info("用户访问了一次测试数据");
    		return mapper.findUserById(1);
		}
  

3. 日志等级

日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，默认只会打印INFO以上级别的信息

二、Logback

和JUL一样，Logback也能实现定制化，我们可以编写对应的配置文件，SpringBoot推荐将配置文件名称命名为logback-spring.xml，表示这是SpringBoot下Logback专用的配置：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 配置 -->
</configuration>

最外层由configuration包裹，一旦编写，那么就会替换默认的配置，所以如果什么都不写的话，会导致我们的SpringBoot项目没有配置任何日志输出方式，控制台也不会打印日志。

在 Spring Boot 项目中，已经在 org/springframework/boot/logging/logback/defaults.xml 这个文件中为我们预先设置好了一些默认的日志输出格式等相关配置。而我们如果想要实现一个在控制台打印日志的配置，只需要去设置相应的“附加器”（appender）。

通过配置特定的 appender，比如指定将日志输出到控制台，我们就可以利用 Spring Boot 已经定义好的日志格式，直接在控制台上看到按照预设格式输出的日志信息。这样就无需我们从头去详细地定义日志的各种具体格式和规则等，极大地简化了日志配置的工作。

导入后，我们利用预设的日志格式创建一个控制台日志打印：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!--  导入其他配置文件，作为预设  -->
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />

    <!--  Appender作为日志打印器配置，这里命名随意  -->
    <!--  ch.qos.logback.core.ConsoleAppender是专用于控制台的Appender  -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>${CONSOLE_LOG_CHARSET}</charset>
        </encoder>
    </appender>

    <!--  指定日志输出级别，以及启用的Appender，这里就使用了我们上面的ConsoleAppender  -->
    <root level="INFO">
        <appender-ref ref="CONSOLE"/>
    </root>
</configuration>

配置完成后，我们发现控制台已经可以正常打印日志信息了。

接着我们来看看如何开启 文件打印 ，我们只需要配置一个对应的Appender即可：

<!--  ch.qos.logback.core.rolling.RollingFileAppender用于文件日志记录，它支持滚动  -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <encoder>
        <pattern>${FILE_LOG_PATTERN}</pattern>
        <charset>${FILE_LOG_CHARSET}</charset>
    </encoder>
    <!--  自定义滚动策略，防止日志文件无限变大，也就是日志文件写到什么时候为止，重新创建一个新的日志文件开始写  -->
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
        <!--  文件保存位置以及文件命名规则，这里用到了%d{yyyy-MM-dd}表示当前日期，%i表示这一天的第N个日志  -->
        <FileNamePattern>log/%d{yyyy-MM-dd}-spring-%i.log</FileNamePattern>
        <!--  到期自动清理日志文件  -->
        <cleanHistoryOnStart>true</cleanHistoryOnStart>
        <!--  最大日志保留时间  -->
        <maxHistory>7</maxHistory>
        <!--  最大单个日志文件大小  -->
        <maxFileSize>10MB</maxFileSize>
    </rollingPolicy>
</appender>

<!--  指定日志输出级别，以及启用的Appender，这里就使用了我们上面的ConsoleAppender  -->
<root level="INFO">
    <appender-ref ref="CONSOLE"/>
    <appender-ref ref="FILE"/>
</root>

配置完成后，我们可以看到日志文件也能自动生成了。

也可以魔改官方提供的日志格式，官方文档：https://logback.qos.ch/manual/layouts.html

三、MDC

这里需要提及的是MDC机制，Logback内置的日志字段还是比较少，如果我们需要打印有关业务的更多的内容，包括自定义的一些数据，需要借助logback MDC机制，MDC为“Mapped Diagnostic Context”（映射诊断上下文），即将一些运行时的上下文数据通过logback打印出来；此时我们需要借助org.sl4j.MDC类。

比如我们现在需要记录是哪个用户访问我们网站的日志，只要是此用户访问我们网站，都会在日志中携带该用户的ID，我们希望每条日志中都携带这样一段信息文本，而官方提供的字段无法实现此功能，这时就需要使用MDC机制：

@ResponseBody
@GetMapping("/test")
public User test(HttpServletRequest request){
   MDC.put("reqId", request.getSession().getId());
   log.info("用户访问了一次测试数据");
   return mapper.findUserById(1);
}

通过这种方式，我们就可以向日志中传入自定义参数了，我们日志中添加这样一个占位符%X{键值}，名字保持一致：

%clr([%X{reqId}]){faint} 

这样当我们向MDC中添加信息后，只要是当前线程（本质是ThreadLocal实现）下输出的日志，都会自动替换占位符。

以下是一条使用了上述机制后的日志记录示例：

[INFO] 用户访问了一次测试数据 - [reqId: some_session_id]

在这个示例中，“[reqId: some_session_id]”就是通过 MDC 机制添加并在日志中体现出来的自定义信息，其中“some_session_id”是实际放入 MDC 中的请求会话 ID。

我问了下AI，与直接字符串拼接的区别是什么

与直接在 log.info 里用字符串拼接相比，主要有以下一些区别：

灵活性方面：使用 MDC 机制可以更灵活地管理和添加自定义数据，不需要每次都在代码中进行具体的拼接操作，减少了代码中的硬编码和可能出现的重复拼接逻辑。

维护性方面：如果后续需要修改或添加更多的自定义数据，使用 MDC 只需在相应位置进行设置，而字符串拼接则可能需要在多个地方修改代码。

代码简洁性：避免了在大量地方进行复杂的字符串拼接操作，使代码看起来更简洁、清晰。

线程安全性：MDC 基于 ThreadLocal 实现，能确保在多线程环境下每个线程的数据独立性，而字符串拼接可能在多线程场景下出现一些潜在的同步问题。

比如，如果之后需要记录用户的其他信息，或者在多个不同的方法中都要记录类似的自定义信息，使用 MDC 会更加方便和高效，无需对每个地方的日志输出都进行繁琐的字符串修改。

四、MyBatis 日志系统

Mybatis也有日志系统，详细记录了所有的数据库操作等，但是我们在前面的学习中没有开启它，现在我们学习了日志之后，我们就可以尝试开启Mybatis的日志系统，来监控所有的数据库操作，要开启日志系统，我们需要进行配置：

<setting name="logImpl" value="JDK_LOGGING" />