日志框架介绍

在我们的项目开发中，日志是必不可少的一个记录事件的组件。它主要应用场景在记录运行情况、追踪线上问题等等。

市面上常见的日志框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我们该如何选择呢？

通常情况下，日志是由一个抽象层+实现层的组合来搭建的。详情如下：

Spring框架选择使用了JCL作为默认日志输出，而SpringBoot默认选择了SLF4J结合LogBack。

SLF4J的使用

我们在开发过程中不应该直接使用日志实现类，而是应该使用日志抽象层。这样，我们就可以动态的切换我们的日志实现框架而不用频繁的修改源码。SLF4J就是一个流行的日志抽象层框架，使用示例参考官网。

下图是 SLF4J 结合各种日志框架的官方示例，从图中可以清晰的看出 SLF4J API 永远作为日志的门面，直接应用与应用程序中。

注意：由于每一个日志的实现框架都有自己的配置文件，所以在使用 SLF4j 之后，配置文件还是要使用实现日志框架的配置文件。

统一日志框架的使用

一般情况下，在项目中存在着各种不同的第三方 jar ，且它们的日志选择也可能不尽相同，显然这样是不利于我们使用的，那么如果我们想为项目设置统一的日志框架该怎么办呢？

在 SLF4J 官方，也给了我们参考的例子：

从图中我们得到一种统一日志框架使用的方式：使用一种和要替换的日志框架类完全一样的 jar 进行替换，这样不至于原来的第三方 jar 报错，而这个替换的 jar 其实使用了 SLF4J API。这样项目中的日志就都可以通过 SLF4J API 结合自己选择的框架进行日志输出。

统一日志框架使用步骤归纳如下：

1. 排除系统中的其他日志框架
2. 使用中间包替换要替换的日志框架
3. 导入我们选择的SLF4J的实现

下面我们实际演示一下日志框架的替换与统一。

第一步，我们先要排除其他的日志框架。如图所示：

第二步，统一框架引入替换包。

Spring Boot 是使用了 SLF4J+logback 的日志框架组合，查看 Spring Boot 项目的 Maven 依赖关系可以看到 Spring Boot 的核心启动器 spring-boot-starter 引入了 spring-boot-starter-logging。

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

而 spring-boot-starter-logging 的 Maven 依赖主要引入了 logback-classic (包含了日志框架 Logback的实现)，log4j-to-slf4j (在 log4j 日志框架作者开发此框架的时候还没有想到使用日志抽象层进行开发，因此出现了 log4j 向 slf4j 转换的工具)，jul-to-slf4j ( Java 自带的日志框架转换为 slf4j)。

<dependencies>
  <dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-classic</artifactId>
   <version>1.2.3</version>
   <scope>compile</scope>
  </dependency>
  <dependency>
   <groupId>org.apache.logging.log4j</groupId>
   <artifactId>log4j-to-slf4j</artifactId>
   <version>2.13.3</version>
   <scope>compile</scope>
  </dependency>
    <dependency>
   <groupId>org.slf4j</groupId>
   <artifactId>jul-to-slf4j</artifactId>
   <version>1.7.30</version>
   <scope>compile</scope>
  </dependency>
</dependencies>

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

由此可见，Spring Boot 可以自动的适配日志框架，而且底层使用 SLF4j + LogBack 记录日志，如果我们自行引入其他框架，需要排除其日志框架。也就是说，如果框架中使用的log4j日志框架，需要手动排除 log4j日志框架 依赖，而替换为log4j-to-slf4j的依赖即可。

自定义日志输出

我们可以在配置文件里面直接配置日志的输出格式。示例如下：

# 日志配置
# 指定具体包的日志级别
logging.level.root=debug
# 控制台和日志文件输出格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level
%logger{50} - %msg%n
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}
- %msg%n
# 日志输出路径，默认文件spring.log
logging.file.path=spring.log
#logging.file.name=log.log

关于日志的输出路径，可以使用 logging.file 或者 logging.path 进行定义，两者存在关系如下表。