526互联

Spring Boot使用slf4j进行日志记录

发布时间 2023-04-07 14:49:34作者: 且行且思

1.1 简介

在开发中，我们经常使用 System.out.println()来打印一些信息，但是这样不好，因为大量的使用 System.out 会增加资源的消耗。我们实际项目中使用的是 slf4j的logback 来输出日志，效率挺高的，Spring Boot提供了一套日志系统，logback是最优的选择。
1.2 slf4j介绍

引用百度百科里的一段话：
SLF4J，即简单日志门面（Simple Logging Facade for Java），不是具体的日志解决方案，它只服务于各种各样的日志系统。按照官方的说法，SLF4J是一个用于日志系统的简单Facade，允许最终用户在部署其应用时使用其所希望的日志系统。

这段的大概意思是：你只需要按统一的方式写记录日志的代码，而无需关心日志是通过哪个日志系统，以什么风格输出的。因为它们取决于部署项目时绑定的日志系统。例如，在项目中使用了slf4j记录日志，并且绑定了log4j（即导入相应的依赖），则日志会以 log4j的风格输出；后期需要改为以logback的风格输出日志，只需要将log4j替换成logback即可，不用修改项目中的代码。这对于第三方组件的引入的不同日志系统来说几乎零学习成本，况且它的优点不仅仅这一个而已，还有简洁的占位符的使用和日志级别的判断。

正因为 sfl4j有如此多的优点，阿里巴巴已经将 slf4j作为他们的日志框架了。在《阿里巴巴Java开发手册(正式版)》中，日志规约一项第一条就强制要求使用 slf4j：
【强制】应用中不可直接使用日志系统（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);
    // ……
}

 

1.3 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级别即可。

常用的日志级别按照从高到低依次为：ERROR、WARN、INFO、DEBUG。
1.4 logback.xml 配置文件解析

在上面application.yml文件中，我们指定了日志配置文件logback.xml，logback.xml文件中主要用来做日志的相关配置。在 logback.xml中，我们可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长等等。下面来分析一下：
1.4.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系统，日志存储的路径必须要是绝对路径。

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

 

使用 <appender> 节点设置个控制台输出（class="ch.qos.logback.core.ConsoleAppender"）的配置，定义为 “CONSOLE”。使用上面定义好的输出格式（LOG_PATTERN）来输出，使用 ${}引用进来即可。

1.4.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>

 

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

1.4.4 定义日志输出级别

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

 

有了上面那些定义后，最后我们使用 <logger> 来定义一下项目中默认的日志输出级别，这里定义级别为 INFO，然后针对 INFO级别的日志，使用 <root>引用上面定义好的控制台日志输出和日志文件的参数。这样logback.xml文件中的配置就设置完了。
1.4.5 使用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
@RequestMapping("/test")
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";
        logger.info("======个人博客：{}；CSDN博客：{}", str1, str2);

        return "success";
    }
}

 

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

 

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

本节课主要对 slf4j 做了一个简单的介绍，并且对Spring Boot中如何使用 slf4j输出日志做了详细的说明，着重分析了logback.xml文件中对日志相关信息的配置，包括日志的不同级别。最后针对这些配置，在代码中使用Logger打印出一些进行测试。在实际项目中，这些日志都是排查问题的过程中非常重要的资料。