SpringBoot整合日志功能(slf4j+logback)详解(最新推荐)

目录

• 一、日志门面与日志实现
• 1.1 什么是日志门面和日志实现？
• 1.2 为什么需要日志门面？
• 二、简介
• 三、日志格式
• 四、记录日志
• 4.1 使用日志工厂
• 4.2 使用Lombok的@Slf4j注解http://www.devze.com
• 五、日志级别
• 5.1 日志级别介绍
• 5.2 配置日志级别
• 5.3 指定某个包下的类使用某个级别
• 5.4 占位符打印
• 六、日志分组
• 七、文件输出
• 八、文件归档与滚动切割
• 九、自定义配置
• 十、切换日志组合

一、日志门面与日志实现

1.1 什么是日志门面和日志实现？

日志门面相当于JDBC接口，而日志实现类似于mysql、oracle、SqlServer等。

在Java生态体系中，围绕着日志，有很多成熟的解决方案。关于日志输出，主要有两类工具。

一类是日志框架（Log4j、Logback），主要用来进行日志的输出的，比如输出到哪个文件，日志格式如何等。另 外一类是日志门面（slf4j，commons-logging），主要一套通用的API，用来屏蔽各个日志框架之间的差异的。

对于Java工程师来说，关于日志工具的使用，最佳实践就是在应用中使用如Log4j + SLF4J这样的组合来进行日志 输出。

这样做的最大好处，就是业务层的开发不需要关心底层日志框架的实现及细节，在编码的时候也不需要考虑日后更 换框架所带来的成本。这也是门面模式所带来的好处。

1.2 为什么需要日志门面？

前面提到过一个重要的原因，就是为了在应用中屏蔽掉底层日志框架的具体实现。这样的话，即使有一天要更换代 码的日志框架，只需要修改jar包，最多再改改日志输出相关的配置文件就可以了。这就是解除了应用和日志框架 之间的耦合。

有人或许会问了，如果我换了日志框架了，应用是不是就改了，那日志门面不还是需要改的吗？

要回答这个问题，我们先来举一个例子，再把门面模式碎了重新解释一遍。

日志门面就像饭店的服务员，而日志框架就像是后厨的厨师。对于顾客这个应用来说，我到饭店点菜，我只需要告 诉服务员我要一盘番茄炒鸡蛋即可，我不关心他后厨的所有事情。因为虽然主厨从把这道菜称之为「番茄炒蛋」的厨师 换成了把这道菜称之为「西红柿炒鸡蛋」的厨师。但是，顾客不需要关心，他只要下达「番茄炒蛋」的命令给到 服务员，由服务员再去翻译给厨师就可以了。

所以，对于一个了解了「番茄炒蛋」的多种叫法的服务员来说，无论后厨如何换厨师，他都能准确的帮用户下单。

同理，对于一个设计的全面、完善的日志门面来说，他也应该是无缝兼容了多种日志框架的。所以，底层框架的 更换，日志门面几乎不需要改动。

以上，就是日志门面的一个比较重要的好处——解耦。

二、简介

• Spring使用commons-logging作为内部日志，但底层日志实现是开放的。可对接其他日志框架。spring5及以后 commons-logging被spring直接自己写了。
• 支持 jul，log4j2,logback。SpringBoot 提供了默认的控制台输出配置，也可以配置输出为文件。
• logback是默认使用的。
• 虽然日志框架很多，但是我们不用担心，使用 SpringBoot 的默认配置就能工作的很好。

SpringBoot怎么把日志默认配置好的？

• 每个starter场景，都会导入一个核心场景spring-boot-starter
• 核心场景引入了日志的所用功能spring-boot-starter-logging
• 默认使用了slf4j + logback 组合作为默认底层日志
• 日志是系统一启动就要编程用，而xxxAutoConfiguration是系统启动好了以后放好的组件，后来用的。
• 日志是利用监听器机制配置好的。ApplicationListener。
• 日志所有的配置都可以通过修改配置文件实现。以logging开始的所有配置。

三、日志格式

2023-03-31T13:56:17.511+08:00  INFO 4944 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]

2023-03-31T13:56:17.511+08:00  INFO 4944 --- [           main] o.apache.catalina.core.StandardEngine    : Starting Servlet engine: [Apache Tomcat/10.1.7]

默认输出格式：

• 时间和日期：毫秒级精度
• 日志级别：ERROR, WARN, INFO, DEBUG, or TRACE.
• 进程 ID
• ---： 消息分割符
• 线程名： 使用[]包含
• Logger 名： 通常是产生日志的类名
• 消息： 日志记录的内容

注意： logback 没有FATAL级别，对应的是ERROR

默认值：参照：spring-boot包additional-spring-configuration-metadata.json文件

默认输出格式值：%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}

在application.properties可修改为：

%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} ===> %msg%n

启动项目发现日志变成我们修改的样子了。

四、记录日志

4.1 使用日志工厂

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    Logger log = LoggerFactory.getLogger(getClass());
    @GetMapping("/hello")
    public String hello(){
        log.info("方法进来了...");
        return "Hello,Spring Boot 3!";
    }
}

4.2 使用Lombok的@Slf4j注解

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(){
        log.info("方法进来了...");
        return "Hello,Spring Boot 3!";
    }
}

五、日志级别

5.1 日志级别介绍

• 由低到高：ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF；
  • 只会打印指定级别及以上级别的日志
  • ALL：打印所有日志
  • TRACE：追踪框架详细流程日志，一般不使用
  • DEBUG：开发调试细节日志
  • INFO：关键、感兴趣信息日志
  • WARN：警告但不是错误的信息日志，比如：版本过时
  • ERROR：业务错误日志，比如出现各种异常
  • FATAL：致命错误日志，比如jvm系统崩溃
  • OFF：关闭所有日志记录
• 不指定级别的所有类，都使用root指定的级别作为默认级别
• SpringBoot日志默认级别是 INFO

也就是说，如果你配置文件没有配置日志级别，那么默认级别是info，打印的也是info顺序后面的日志级别，包括info、warn、error、fatal、off等。

5.2 配置日志级别

application.properties中配置：

logging.level.root = debug

这样配置代表以后debug及以后级别的日志都可以打印。

5.3 指定某个包下的类使用某个级别

logging.level.com.atguigu.controller=debug

代表只有com.atguigu.controller包使用debug级别，其余都使用默认info级别。

5.4 占位符打印

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@Slf4j
@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(String a, String b){
        log.info("info日志：参数a:{} 参数b:{}", a, b);
        return "Hello,Spring Boot 3!";
    }
}

六、日志分组

有这么一种场景，比如我的包很多，这些包都想设置debug级别，那么配置如下：

logging.level.com.atguigujs.controller=debug

logging.level.com.atguigu.service=debug

logging.level.com.atguigu.dao=debug

logging.level.com.atguigu.entity=debug

logging.level.com.atguigu.common=debug

...

这样当包有很多的时候，写起来很麻烦！！！那么有什么办法呢？没错，就是分组。

比如我把这些包分成一个组，组名叫abc，配置如下：

logging.group.abc=com.atguigu.controller,com.atguigu.service,com.atguigu.dao,com.atguigu.entity,com.atguigu.common

logging.level.abc=debug

这样不就简便很多了吗？

七、文件输出

SpringBoot 默认只把日志写在控制台，如果想额外记录到文件，可以在application.properties中添加logging.file.name or logging.file.path配置项。

logging.file.name	logging.file.path	示例	效果
未指定	未指定		仅控制台输出
指定	未指定	my.log	写入指定文件。可以加路径
未指定	指定	/var/log	写入指定目录，文件名为spring.log
指定	指定		以logging.file.name为准

例：将日志打印在D盘的/logs/my.log中

logging.file.name=D:/logs/my.log

八、文件归档与滚动切割

比如我们将项目的日志打印到D:\\my.log中，那么时间短还行，如果持续一年，我们的日志文件将会非常大，打开都会崩的状态。

归档：每天的日志单独存到一个文档中。

切割：每个文件10MB，超过大小切割成另外一个文件。

• 每天的日志应该独立分割出来存档。如果使用logback（SpringBoot 默认整合），可以通过application.properties/yaml文件指定日志滚动规则。
• 如果是其他日志系统，需要自行配置编程客栈（添加log4j2.XML或log4j2-spring.xml）
• 支持的滚动规则设置如下

配置项	描述
logging.logback.rollingpolicy.file-name-pattern	日志存档的文件名格式（默认值：${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz）
logging.logback.rollingpolicy.clean-history-on-start	应用启动时是否清除以前存档（默认值：false）
logging.logback.rollingpolicy.max-file-size	存档前，每个日志文件的最大大小（默认值：10MB）
logging.logback.rollingpolicy.total-size-cap	日志文件被删除之前，可以容纳的最大大小（默认值：0B）。设置1GB则磁盘存储超过 1GB 日志后就会删除旧日志文件
logging.logback.rollingpolicy.max-history	日志文件保存的最大天数(默认值：7).

例：

logging.file.name=D:\logs\my.log
# LOG_FILE：代表我们配置的日志文件名，如my.log
# yyyy-MM-dd：年月日
# %i：代表当天第几个文件
logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz
# 只要my.log日志文件大于10MB就会触发日志归档，将当前日志文件压缩为my.log.2019-01-01.1.gz
logging.logback.rollingpolicy.max-file-size=10MB

九、自定义配置

通常我们配置 application.properties 就够了。当然也可以自定义。比如：

日志系统	自定义
Logback	logback-spring.xml, logback-spring.groovy, logback.xml, or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Jav编程a Util Logging)	logging.properties

如果可能，我们建议您在日志配置中使用-spring 变量（例如，logback-spring.xml 而不是 logback.xml）。如果您使用标准配置文件，spring 无法完全控制日志初始化。

最佳实战：自己要写配置，配置文件名加上 xx-spring.xml

十、切换日志组合

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

哪怕你切换log4j2，你也不用改任何代码和配置，这就是日志门面的好处。

到此这篇关于SpringBoot整合日志功能（slf4j+logback）详解的文章就介绍到这了,更多相关SpringBoot整合slf4j+logback内容请搜索编程客栈(www.devze.com)以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程客栈(www.devze.com)！