五、Java中SpringBoot组件集成接入【slf4j日志文档】

系列文章目录

一、SpringBoot框架搭建
二、Java中SpringBoot组件集成接入【MySQL和MybatisPlus】
三、SpringBoot项目中根据数据表自动生成entity\DAO\DTO\VO\QO\Convertor\service\service.impl\controller等基础CRUD代码
四、Java中SpringBoot组件集成接入【Knife4j接口文档（swagger增强）】
五、Java中SpringBoot组件集成接入【slf4j日志文档】
六、Java中SpringBoot组件集成接入【MQTT中间件】
七、Java中SpringBoot组件集成接入【Minio文件服务器】

1.slf4j简介

SLF4J（Simple Logging Facade for Java）是一个为Java应用程序提供统一日志接口的日志门面框架。它旨在解决Java应用程序中日志系统的复杂性和不一致性问题。

SLF4J的设计理念是将日志接口和具体的日志实现框架解耦，使开发人员能够在不改变应用程序代码的情况下更换和切换不同的日志系统。通过使用SLF4J，开发人员只需使用SLF4J提供的API进行日志记录，而具体的日志实现可以通过配置文件来切换，从而实现灵活的日志记录。

SLF4J支持多种日志框架，如logback、log4j、java.util.logging等。开发人员可以根据自己的需求选择适合的日志框架，并通过配置文件将其与SLF4J进行绑定。

使用SLF4J的好处包括：

• 提供统一的日志接口，简化了日志记录的编程工作。
• 可以在不修改应用程序代码的情况下切换不同的日志实现框架。
• 提供了更好的日志性能和灵活性。
• 提供了更多的日志配置选项和功能，如日志级别、日志输出格式等。

SLF4J将日志分为trace、debug、info、warn、error五个级别，每个级别对应记录不同的日志，对应不同的使用场景。优先级从高到低依次为trace、debug、info、warn、error，相对而言，打印的日志会越来越少。

• trace:
  一般用来追踪详细的程序运行流，比如程序的运行过程中，运行到了哪一个方法，进入了哪一条分支。通过trace程序的运行流程，可以判断程序是否按照期望的逻辑在运行。
• debug: 这类日志往往用在判断是否有出现bug的场景，且往往记录了代码运行的详细信息，比如方法调用传入的参数信息。
• info：用来记录程序运行的一些关键信息，它不像trace那样记录程序运行的整个流程，也不像debug那样为了解决问题而记录详细的信息。info记录的是整个系统的运行信息，比如系统运行到了哪一个阶段，到达了哪一个状态。
• warn：用来记录一些警告信息。警告信息表示，程序进入了一个特殊的状态，在该状态下程序可以继续运行，但是不建议让程序进入该状态，因为该状态可能导致结果出现问题。
• error：用来记录运行时的错误信息，表示程序运行过程中出现了需要被解决的问题，往往是一些异常。使用error日志的时候，一般会将详细的异常出现的原因记录。

总的来说，SLF4J是Java应用程序中使用广泛的日志门面框架，它提供了统一的日志接口，并与多种日志实现框架进行适配，使得日志记录更加简单、灵活和易于管理。

2.maven依赖

SpringBoot会默认使用logback作为日志框架，在生成springboot项目的时候可以直接勾选logback，那么就可以直接使用logback了。
手动添加的话，建议使用slf4j+logback，后面项目更容易维护

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.25</version>
    </dependency>

3.配置

在springboot的配置文件application.yaml中配置日志的打印级别和存放位置

logging:
  level:
    com.funfan.autoCodeDemo: DEBUG
  file:
    name: /logs/autocodedemo/autocodedemo.log

如有其他特殊需求（比如自定义日志输出模板，日志按时分片保存等），可以参考SpringBoot-3：集成SLF4J+logback进行日志记录来配置日志输出相关信息

4.使用

在类上面添加@Slf4j注解，代码中直接使用log.XX记录日志即可。

@RestController
@Slf4j
public class Slf4jTestController {
    @RequestMapping(value = "/testLog", method = {RequestMethod.GET})
    @ApiOperation(value = "Slf4j测试", notes = "Slf4j测试")
    public String testLog() {
        log.info("infoTest");
        log.warn("warnTest");
        log.error("errorTest");
        return "Slf4j测试";
    }
}

5.展示

6.参考文章

SpringBoot-3：集成SLF4J+logback进行日志记录