Spring Boot 使用 SLF4J 进行日志记录

大家好,我是你们的导师,我每天都会在这里给大家分享一些干货内容(当然了,周末也要允许老师休息一下哈)。昨天老师跟大家分享了Spring Boot 返回 JSON 数据及数据封装,今天来跟大家分享一下如何使用 SLF4J 进行日志记录。

在开发中,我们经常使用 System.out.println() 打印一些信息,但是这样做不好,因为大量使用 System.out 会增加资源的消耗。

在实际项目中,我们则使用 SLF4J 的 Logback 来输出日志,效率更高,Spring Boot 提供了一套日志系统,Logback 是最优的选择。

在 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 文件。关于日志的相关配置信息,都放在了 logback.xml 文件中。

logging.level 用来指定具体的 Mapper 中日志的输出级别,上面的配置表示 com.itcodai.course03.dao 包下的所有 Mapper 日志输出级别为 Trace,会将操作数据库的 SQL 打印出来。开发时设置成 trace 方便定位问题,在生产环境上,将这个日志级别再设置成 error 级别即可。

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

在上面的 application.yml 文件中,我们指定了日志配置文件 logback.xml。 logback.xml 文件主要用来做日志的相关配置。在 logback.xml 中,我们可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长,等等。下面来分析一下。

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 系统,日志存储的路径必须是绝对路径。

2. 定义控制台输出

使用节点设置控制台输出的配置,定义为 CONSOLE。使用上面定义好的输出格式(LOG_PATTERN)来输出,使用 ${} 引用进来即可。

3. 定义日志文件的相关参数

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

4. 定义日志输出级别

有了上面那些定义后,最后我们使用来定义一下项目中默认的日志输出级别,这里定义级别为 INFO,然后针对 INFO 级别的日志,使用引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml 文件中的配置就设置完了。

使用 Logger 打印日志

在代码中,我们一般使用 Logger 对象打印 Log 信息,可以指定打印出的日志级别,也支持占位符,很方便。

@RestController
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 str = "blog.csdn.net/eson_15";
        logger.info("======老师的 CSDN 博客:{}", str);

        return "success";
    }
}

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

总结

本文主要对 SLF4J 做了一个简单的介绍,并且对 Spring Boot 中如何使用 SLF4J 输出日志做了详细的说明,着重分析了 logback.xml 文件中对日志相关信息的配置,包括日志的不同级别。最后针对这些配置,在代码中使用 Logger 打印出一些信息进行测试。

原文发布于微信公众号 - 挨踢小子(LN-aitixiaozi)

原文发表时间:2019-07-20

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

扫码关注云+社区

领取腾讯云代金券