spring boot Slf4j日志框架的体系结构详解

时间：2022-11-21 08:26:21|栏目：JAVA代码|点击：次

前言

刚刚接触到java log日志的同学可能会被各种日志框架吓到，包括各种日志框架之间的jar总是发生冲突，另很多小伙伴头疼不已。那我们本篇的内容就是将各种java 日志框架发展过程，以及他们之间的关系，以及如何选型来介绍给大家。

一、五花八门的日志工具包

1.1. 日志框架

JDK java.util.logging 包:java.util.logging 是 jdk1.4 发布的 java 日志包, 可以说是应用比较久远的日志工具包
log4j： apache 的一个开源项目，提供了强有力的 java 日志支持，甚至他也提供了其他语言包括 C、C++、.Net、PL/SQL 的接口，从而实现多语言并存的分布式环境日志打印。目前已经停止更新，所以不推荐使用。
Logback：由log4j创始人设计的另一个开源日志组件，作为Spring Boot默认的日志框架，应用比较广泛。
log4j2 ：Apache Log4j2是对Log4j的升级，它比其前身Log4j1.x提供了重大改进，并提供了Logback中可用的许多改进，同时修复了Logback架构中的一些问题。它基于LMAX公司开发Disruptor（一个开源的无锁并发框架），改善了Log4j和Logback在架构设计方面的缺陷，具有超高的吞吐量和低延迟，性能比Log4j1.x和Logback更好。

1.2.日志门面

commons-logging： Apache commons类库中的一员，他作为一个日志门面，能够自动选择使用 log4j 还是 JDK logging，但是他不依赖Log4j，JDK Logging的API。如果项目的classpath中包含了log4j的类库，就会使用log4j，否则就使用JDK Logging。
SLF4J：可以说是目前应用最为广泛的日志门面了，它提供了一个日志抽象层，允许你在后台使用任意一个日志类库。如：log4j、log4j2、logback

1.3日志门面存在的意义

为什么不直接使用日志框架，而是搞出一个日志门面？

日志门面（SLF4J）主要是为了给Java日志访问提供一套标准、规范的API框架，其主要意义在于提供接口，具体的实现可以交由其他日志框架来实现，例如log4j和logback等。对于一般的Java项目而言，日志框架会选择slf4j-api作为门面，配上具体的实现框架（log4j、log4j2、logback等），中间使用桥接器完成桥接。

前面介绍的几种日志框架，每一种日志框架都有自己单独的API，要使用对应的框架就要使用其对应的API，这就大大的增加应用程序代码对于日志框架的耦合性要求。有了SLF4J这个门面之后，程序员永远都是面向SLF4J编程，可以实现简单快速地替换底层的日志框架而不会导致业务代码需要做相应的修改。

在使用 SLF4J 进行日志记录时，通常都需要在每个需要记录日志的类中定义 Logger 变量，如下所示：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@RestController
public class LogTestController {
    private static final Logger logger = LoggerFactory.getLogger(LogTestController.class);

    @GetMapping("/test")
    public void test(){
        logger.trace("Trace 日志...");
        logger.debug("Debug 日志...");
        logger.info("Info 日志...");
        logger.warn("Warn 日志...");
        logger.error("Error 日志...");
    }
}

这显然属于重复性劳动，降低了开发效率，如果你在项目中引入了 Lombok，那么可以使用它提供的 @Slf4j 注解来自动生成上面那个变量，默认的变量名是 log，如果我们想采用惯用的 LOGGER作为变量名，那么可以在工程的根目录中增加 lombok.config 文件，并在文件中增加lombok.log.fieldName=LOGGER的配置项即可。

二、日志框架选型

Spring Boot 默认的日志记录框架使用的是 Logback
其中 Log4j 可以认为是一个过时的函数库，已经停止更新，不推荐使用，相比之下，性能和功能也是最差的。
logback 虽然是 Spring Boot 默认的，但性能上还是不及 Log4j2，因此，在现阶段，日志记录首选 Log4j2（log4j系列经历了安全风波，请选用漏洞修复后的新版本）。

SLF4J + Log4j2 是我们推荐的日志记录选型。

性能测试结果

参考:log4j2官网

三、日志级别

细说各日志框架整合配置前，我们先来大致了解下，最常见的日志的几个级别：ERROR, WARN, INFO, DEBUG和TRACE。像其他的，比如ALL、OFF和FATAL之类的开发过程中应该基本上是不会涉及的。所以以下从低到高一次介绍下常见的日志级别。

TRACE：追踪。一般上对核心系统进行性能调试或者跟踪问题时有用，此级别很低，一般上是不开启的，开启后日志会很快就打满磁盘的。
DEBUG:调试。这个大家应该不陌生了。开发过程中主要是打印记录一些运行信息之类的。
INFO:信息。这个是最常见的了，大部分默认就是这个级别的日志。一般上记录了一些交互信息，一些请求参数等等。可方便定位问题，或者还原现场环境的时候使用。此日志相对来说是比较重要的。
WARN:警告。这个一般上是记录潜在的可能会引发错误的信息。比如启动时，某某配置文件不存在或者某个参数未设置之类的。
ERROR:错误。这个也是比较常见的，一般上是在捕获异常时输出，虽然发生了错误，但不影响系统的正常运行。但可能会导致系统出错或是宕机等。

日志级别从小到大为trace<debug<info<warn<error<fatal，由于通常日志框架默认日志级别设置为INFO，因此1.3.小节中样例trace和debug级别的日志都看不到。

2020-08-17 13:59:16.566  INFO c.z.b.l.controller.LogTestController     : Info 日志...
2020-08-17 13:59:16.566  WARN  c.z.b.l.controller.LogTestController     : Warn 日志...
rn 日志...
2020-08-17 13:59:16.566 ERROR  c.z.b.l.controller.LogTestController     : Error 日志...

四、常见术语概念解析

appender：主要控制日志输出到哪里，比如：文件、数据库、控制台打印等
logger: 用来设置某一个包或者具体某一个类的日志打印级别、以及指定appender
root：也是一个logger，是一个特殊的父logger。所有的子logger最终都会将输出流交给root，除非在子logger中配置了additivity=“false”。
rollingPolicy：所有日志都放在一个文件是不好的，所以可以指定滚动策略，按照一定周期或文件大小切割存放日志文件。
RolloverStrategy：日志清理策略。通常是指日志保留的时间。
异步日志：单独开一个线程做日志的写操作，达到不阻塞主线程的目的。