【Java从0到架构师】交错的日志系统、SpringBoot 集成日志框架

Bertha 。 2022-09-04 14:45 170阅读 0赞

### 交错的日志系统、SpringBoot 集成日志框架 ###

*  交错复杂的日志系统① - 多个项目实现 SLF4J 门面
 *  交错复杂的日志系统② - 统一底层实现为 Logback
 *  交错复杂的日志系统③ - 统一底层实现为 Log4j 2.x
 *   *  解决方案1
     *  解决方案2
 *  日志依赖总结
 *  SpringBoot 集成日志框架
 *   *  SpringBoot 集成 Logback
     *  SpringBoot 集成 Log4j 2.x
     *  SpringBoot 的 logging 配置 (application)

> Java 从 0 到架构师目录：[【Java从0到架构师】学习记录][Java_0]

Gitee 代码：[https://gitee.com/szluyu99/mj\_java\_frame/tree/master/04\_SpringBoot][https_gitee.com_szluyu99_mj_java_frame_tree_master_04_SpringBoot]

--------------------

在实际开发过程中，不同的库（项目）内部使用的日志系统不一定相同

*  当多个带有日志系统的项目混合在一起时，日志系统可能就会变得有点复杂，甚至产生冲突

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]  
在上图中，3 个项目的日志系统可以互不影响、独立运行

# 交错复杂的日志系统① - 多个项目实现 SLF4J 门面 #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]  
上图中，SLF4J 发现有 3 种实现，会发生冲突，最终会选择其中一 种覆盖其他实现

可以根据自己的需要排除掉 2 种实现，剩下 1 种想要的实现：

*  剩下 Logback 实现：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]  
    \*剩下 Log4j 2.x 实现  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 3]

# 交错复杂的日志系统② - 统一底层实现为 Logback #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 4]  
如果希望将所有的日志系统进行统一，比如底层都使用 Logback，解决方案：

*  排除 Log4j 1.x、Log4j 2.x
 *  增加 Log4j 1.x 转为调用 SLF4J 的包：**log4j-over-slf4j**
 *  增加 Log4j 2.x 转为调用 SLF4J 的包：**log4j-to-slf4j**

<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>log4j-over-slf4j</artifactId>
        <version>1.7.30</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-to-slf4j</artifactId>
        <version>2.13.3</version>
    </dependency>

最终实现的结构：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 5]

# 交错复杂的日志系统③ - 统一底层实现为 Log4j 2.x #

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 6]  
如果希望将所有的日志系统进行统一，比如底层都使用 Log4j 2.x

## 解决方案1 ##

*  排除 Log4j 1.x、Logback
 *  增加 Log4j 1.x 转为调用 SLF4J 的包：**log4j-over-slf4j**
 *  增加 Log4j 2.x 与 SLF4J 的适配包：**log4j-slf4j-impl**

<dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>log4j-over-slf4j</artifactId>
        <version>1.7.30</version>
    </dependency>
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.13.3</version>
    </dependency>

最终实现的结构：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 7]

## 解决方案2 ##

*  排除 Log4j 1.x、Logback
 *  增加 Log4j 1.x 转为调用 Log4j 2.x 的包：**log4j-1.2-api**
 *  增加 Log4j 2.x 与 SLF4J 的适配包：**log4j-slf4j-impl**

<dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-1.2-api</artifactId>
        <version>2.14.0</version>
    </dependency>
    
    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-slf4j-impl</artifactId>
        <version>2.13.3</version>
    </dependency>

最终实现结构：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 8]

# 日志依赖总结 #

门面接口：

*  log4j-api：门面接口（log4j 2.x）
 *  slf4j-api：门面接口

日志实现：

*  logback-classic：实现了 slf4j-api 门面接口的日志实现框架
 *  log4j-core：实现了 log4j-api 门面接口的日志实现框架（**log4j 2.x**）
 *  log4j：**log4j 1.x** 的日志实现框架

与 SLF4J 的适配包：

*  slf4j-log4j12：实现了 slf4j-api 门面接口，它的内部会调用 log4j
 *  log4j-slf4j-impl：实现了 slf4j-api 门面接口，它的内部会调用 log4j-core

> logback 默认就是实现了 slf4j-api 门面接口

--------------------

*  log4j-over-slf4j：log4j 的盗版实现，它的内部会调用 slf4j-api
 *  log4j-1.2-api：log4j 的盗版实现，它的内部会调用 log4j-core
 *  log4j-to-slf4j：log4j-core 的盗版实现，它的内部会调用 slf4j-api

# SpringBoot 集成日志框架 #

在 SpringBoot 中，日志框架的建议：

*  SLF4J + Logback
 *  SLF4J + Log4j 2.x

参考：[官方文档][Link 1]

## SpringBoot 集成 Logback ##

SpringBoot 默认已经继承了 Logback，不用再添加 Logback 的依赖，配置文件位置是：

*  classpath:logback.xml
 *  classpath:logback-spring.xml（SpringBoot 推荐）

SpringBoot 内置的 [Logback 配置][Logback]

*  spring-boot.jar
 *  org/springframework/boot/logging/logback/defaults.xml

## SpringBoot 集成 Log4j 2.x ##

方法1：通过 <exclusion> 标签排除包

<dependencies>
       <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</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>
    </dependencies>

方法2：使用一个版本号不存在的依赖覆盖原来的依赖：

<dependencies>
    	
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
            <version>0</version>
        </dependency>
    	
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
    </dependencies>

配置文件的位置应该是：

*  classpath:log4j2.xml
 *  **classpath:log4j2-spring.xml**（SpringBoot 推荐）

SpringBoot 内置的 [Log4j 2.x 默认配置][Log4j 2.x]

*  spring-boot.jar
 *  org/springframework/boot/logging/log4j2/log4j2.xml

## SpringBoot 的 logging 配置 (application) ##

设置日志级别：

logging:
      level:
        root: info
        com.mj.dao: debug
        com.mj.controller: debug

自定义配置文件的路径：

logging:
      config: classpath:log4j2-spring.xml

定义[日志组][Link 2]：

logging:
      level:
        root: info
        project: debug
      group:
      	project:
      	  - com.mj.dao
      	  - com.mj.controller

[Java_0]: https://blog.csdn.net/weixin_43734095/article/details/119067034
[https_gitee.com_szluyu99_mj_java_frame_tree_master_04_SpringBoot]: https://gitee.com/szluyu99/mj_java_frame/tree/master/04_SpringBoot
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70]: /images/20220829/16c5c6c8f4634bb4b6e127617ce6dde7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 1]: /images/20220829/aa47b3a805a246a2bb571abb1602f7c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 2]: /images/20220829/9d38477dfde54c97b78455c0fbfab6c7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 3]: /images/20220829/b54d1b7ab1cd46c6ad1abba5c9c54aea.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 4]: /images/20220829/6cb049af3345428987a0a9c372846ab3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 5]: /images/20220829/b66aca20c05e4c6882dc2ce03bfaf521.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 6]: /images/20220829/c5b0ab6cf02c43d49bb67b83cddb02d0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 7]: /images/20220829/8b25ce18f77f4c95b211cd48a3c6ea5c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzczNDA5NQ_size_16_color_FFFFFF_t_70 8]: /images/20220829/ed69b2f979434ffa99217a3481d77743.png
[Link 1]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-logging
[Logback]: https://github.com/spring-projects/spring-boot/blob/v2.3.5.RELEASE/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging/logback/defaults.xml
[Log4j 2.x]: https://github.com/spring-projects/spring-boot/blob/v2.3.5.RELEASE/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging/log4j2/log4j2.xml
[Link 2]: https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-custom-log-groups