SpringBoot教程之日志框架

标签：教程 logging SpringBoot 框架日志 logback 我们

先通俗来理解日志

假设现在我们没有日志框架，那么这个时候我们有一个需求，开发一个大型的系统，那么在我们开发的过程中，我们需要检查一些代码的正确与否、是否正常运行、监控代码运行的状况，这时候我们怎么做？当然，我们在需要检查的地方使用System.out.print("")进行输出相关信息，当然，我们也可以控制流输出到一个文件中，不过这个方式有个问题就是，如果我们需要改动一些输出的格式或者信息，那么我们又要到项目代码的各个地方去修改，非常的麻烦，那么这个时候我们会想到进行改进。

如果改进呢，就是专门写一些输出信息的方法，然后把这些方法打包成一个jar进行引用，这样做是的我们可以对使用的方法进行统一的修改，而且还使得我们可以在其他的项目中接着使用，我们可以说已经有一个日志框架的雏形了。不过这个时候我们又有一些想法，既然已经可以输出一些日志信息了，那么我们想要增加几个高大上的功能，比如异步模式、自动扫描等等功能。这个时候我们对jar进行修改升级，加入了这些功能，这样我们的日志框架有有点样子了，可以说是一个正儿八经的日志框架了。

不过不要高兴的太早，正儿八经的日志框架并不代表成熟，我们还有一个问题需要解决，就是如果我们想要对正在使用的jar包API进行修改升级，这个时候难道我们需要对项目中使用到的地方全部进行修改么？这样当然不行，所以这个时候日志框架就需要分层，即抽象成和实现层，我们可以像JDBC那样拥有统一的接口层，底层无论使用什么数据库都没关系，我们都可以使用。完成了抽象层和接口层的分离，这个时候的日志框架算是一个成熟的日志框架了。

SpringBoot日志框架选择

开发中存在非常多的日志框架，JUL（java.util.logging），JCL（Apche Commons Logging），Log4j， Log4j2，Logback，SLF4j，jboss-logging等。SpringBoot在框架内容部分使用JCL，spring-boot-starter-logging采用了slf4j+logback的形式，SpringBoot也能自动适配（jul，log4j2，logback）并简化配置，可以进行如下分类

SpringBoot教程之日志框架_配置文件

我们要使用SpringBoot的日志框架，也就是说我们需要一个抽象层和一个实现层，我们这里选择SLF4j作为抽象层，logback作为实现层。这里要说一下的是，SpringBoot底层是Spring框架，Spring框架默认的是JCL作为抽象层。

SLF4j使用

（我们创建新项目中已经帮我们导入了slf4j和logback）如何在系统中使用SLF4j？在开发的时候不应该直接使用日志实现类，应该使用日志的抽象层。具体参考 SLF4J 官方。下图是 SLF4J 结合各种日志框架的官方示例，从图中可以清晰的看出 SLF4J API 永远作为日志的门面，直接应用与应用程序中。

SpringBoot教程之日志框架_配置文件_02

同时 SLF4 官方给出了简单示例。

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

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World");
  }
}

需要注意的是，要为系统导入 SLF4J 的 jar 和日志框架的实现 jar。由于每一个日志的实现框架都有自己的配置文件，所以在使用 SLF4 之后，配置文件还是要使用实现日志框架的配置文件。

思考一个问题

是什么问题呢？这么描述，我们想要写一个SpringBoot项目，日志框架组合我们打算使用Slf4j+logback，然后项目中集成了Spring，Hibernate，MyBatis等等组件依赖，这个时候会有一个问题，就是我们集成的组件框架中存在自己的日志框架，比如Spring自带commons-logging、Hibernate（jboss-logging）等等，那么这个时候，我们的项目里面就像一个日志框架的大杂烩一样，非常的乱，那么我们就需要给我们项目中日志框架做统一，也就是说，不管我依赖的组件自带了什么日志框架，我只要配置我的Slf4j+logback就可以了。

问题当然也有解决办法，这里我们来看看官方文档

SpringBoot教程之日志框架_日志框架_03

也就是说，我们需要分别引入我们组件日志的覆盖层，因为我们想要去除组件中的日志，不可能跑去删除组件的日志框架包，这样会导致组件崩溃，底层源码都被该了还不崩溃，所以我们在删除其他组件的日志框架jar包的时候，需要导入一层覆盖层jar包，这个jar中依旧有原来组件的日志框架的API，组件运行就不会报错，就相当于多做了一层适配，我们调用Slf4j+logback，然后通过这层适配层调用各组件的日志框架。

步骤总结：

排除系统中的其他日志框架。

使用中间包替换要替换的日志框架。

导入我们选择的 SLF4J 实现。

SpringBoot日志关系

我们从我们新创建的项目出发要阐述和研究，这样更方便我们理解和说明，首先我们来看我们新项目中的pom.xml文件中的内容，我们是一个新项目，什么都没引入，这些都是自动引入的内容。

SpringBoot教程之日志框架_配置文件_04

发现pom.xml中引入了starter启动器，其实每个启动器都会引入大量的依赖，那么我们怎么查看呢，有两种方法，第一种如下

SpringBoot教程之日志框架_spring_05

从上面的分析，Spring Boot 对日志框架的使用已经是清晰明了了，我们也可以使用 IDEA 工具查看 Maven 依赖关系，可以清晰的看到日志框架的引用。

SpringBoot教程之日志框架_配置文件_06

SpringBoot教程之日志框架_配置文件_07

可是话的依赖关系是不是眼前一亮，现在，我们可以来看spring-boot-starter这里，找到spring-boot-starter-logging（每个节点都可以双击点击，点击将进入对应的自动配置类）

SpringBoot教程之日志框架_spring_08

进入到spring-boot-starter-logging中，可以看到如下

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-logging</artifactId>
  <version>2.2.4.RELEASE</version>
  <scope>compile</scope>
</dependency>

这就是SpringBoot的日志使用，我们前面博文说过，每一个starter都是一个场景启动器，而这个就是我们SpringBoot用于日志场景的启动器，里面有非常多的依赖

SpringBoot教程之日志框架_日志框架_09