Springboot日志篇

心已赠人 2024-04-17 13:42 30阅读 0赞

## 一、概述 ##

### 1.1简介 ###

> 市场上存在非常多的日志框架。
> 
> JUL(java.util.logging),JCL(ApacheCommons Logging),Log4j,Log4j2,Logback、SLF4j、jboss-logging等。
> 
>   
> Spring Booti在框架内容部使用JCL,spring-boot-starter--logging采用了slf4j+logback的形式，Spring Boot也能自动适配(jul、log4j2、logback)并简化配置

![931c009d9a6843c68804012c90be5b0f.png][] 虽然日志框架很多，但是我们不用担心，使用SpringBoot的默认配置就能工作的很好。

### 1.2SLF4j使用 ###

![4c1595b899184392be3133f214768e2e.png][]

每一个日志的实现框架都有自己的配置文件。使用slf4j以后，**配置文件还是做成日志实现框架自己本身的配置文件；**

**问题**

> a（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx
> 
> 统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出？

> **如何让系统中所有的日志都统一到slf4j；**
> 
> 1、将系统中其他日志框架先排除出去；
> 
> 2、用中间包来替换原有的日志框架；
> 
> 3、我们导入slf4j其他的实现

### 1.3SpringBoot日志关系 ###

<dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter</artifactId>
          <version>2.7.4</version>
          <scope>compile</scope>
        </dependency>
    SpringBoot使用它来做日志功能；

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

> Spring Boot,怎么把日志默认配置好的  
> 1、每个starter场景，都会导入一个核心场景spring-boot-starter  
> 2、核心场景引入了日志的所用功能spring-boot-starter-logging  
> 3、默认使用了logback+s1f4j组合作为默认底层日志  
> 4、日志是系统一启动就要用，xxxAutoConfiguration是系统启动好了以后放好的组件，后来用的。  
> 5、日志是利用监听器机制配置好的。ApplicationListener。  
> 6、日志所有的配置都可以通过修改配置文件实现

![c77540c99de846369c46d65dc836a3df.png][]

> 总结：
> 
> 1）、SpringBoot底层也是使用slf4j+logback的方式进行日志记录
> 
> 2）、SpringBoot也把其他的日志都替换成了slf4j；
> 
> 3）、中间替换包
> 
> 4）、如果我们要引入其他框架？一定要把这个框架的默认日志依赖移除掉
> 
> Spring框架用的是commons-logging；![48880f30e18c429fa66492026b81a50f.png][]
> 
> **SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；**

### 1.4日志的使用 ###

#### 1、默认配置 ####

package com.yanyu.config;
    
    import org.junit.jupiter.api.Test;
    import org.springframework.boot.test.context.SpringBootTest;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    @SpringBootTest
    class SpringbootDataJdbcApplicationTests {    // DI注入数据源
        // 日志记录器
        Logger logger = LoggerFactory.getLogger(getClass());
    
        @Test
        void contextLoads() {
            // System.out.println();
    
            // 日志的级别 由低到高
            // 可以调整日志级别，日志就会在该级别以及之后的高级别生效，在application.properties中进行调整
            logger.trace("这是trace日志。。。");
            logger.debug("这是debug日志。。。");
            // Spring Boot 默认使用info级别的日志
            logger.info("这是info日志。。。");
            logger.warn("这是warn日志。。。");
            logger.error("这是error日志。。。");
        }
    }

修改默认配置![b4bf98f6f75948eb9c26f15c4c2da897.png][]

日志输出格式：
    	%d表示日期时间，
    	%thread表示线程名，
    	%-5level：级别从左显示5个字符宽度
    	%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
    	%msg：日志消息，
    	%n是换行符
    -->
    %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

logging.level.com.atguigu=trace
    
    
    #logging.path=
    # 不指定路径在当前项目下生成springboot.log日志
    # 可以指定完整的路径；
    #logging.file=G:/springboot.log
    
    # 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
    logging.path=/spring/log
    
    #  在控制台输出的日志的格式
    logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
    # 指定文件中日志输出的格式
    logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

<table> 
 <thead> 
  <tr> 
   <th>logging.file</th> 
   <th>logging.path</th> 
   <th>Example</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>(none)</td> 
   <td>(none)</td> 
   <td></td> 
   <td>只在控制台输出</td> 
  </tr> 
  <tr> 
   <td>指定文件名</td> 
   <td>(none)</td> 
   <td>my.log</td> 
   <td>输出日志到my.log文件</td> 
  </tr> 
  <tr> 
   <td>(none)</td> 
   <td>指定目录</td> 
   <td>/var/log</td> 
   <td>输出到指定目录的 spring.log 文件中</td> 
  </tr> 
 </tbody> 
</table>

#### 2.指定配置 ####

给类路径下放上每个日志框架自己的配置文件即可；SpringBoot就不使用他默认配置的了

<table> 
 <thead> 
  <tr> 
   <th>Logging System</th> 
   <th>Customization</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Logback</td> 
   <td><code>logback-spring.xml</code>,&nbsp;<code>logback-spring.groovy</code>,&nbsp;<code>logback.xml</code>&nbsp;or&nbsp;<code>logback.groovy</code></td> 
  </tr> 
  <tr> 
   <td>Log4j2</td> 
   <td><code>log4j2-spring.xml</code>&nbsp;or&nbsp;<code>log4j2.xml</code></td> 
  </tr> 
  <tr> 
   <td>JDK (Java Util Logging)</td> 
   <td><code>logging.properties</code></td> 
  </tr> 
 </tbody> 
</table>

logback.xml：直接就被日志框架识别了；

**logback-spring.xml**：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

<springProfile name="staging">
        
      	可以指定某段配置只在某个环境下生效
    </springProfile>

如：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                <springProfile name="dev">
                    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
                </springProfile>
                <springProfile name="!dev">
                    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
                </springProfile>
            </layout>
        </appender>

#### 3.切换日志框架 ####

可以按照slf4j的日志适配图，进行相关的切换；

slf4j+log4j的方式；

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      
      <exclusions>
        <exclusion>
          <artifactId>logback-classic</artifactId>
          <groupId>ch.qos.logback</groupId>
        </exclusion>
        <exclusion>
          <artifactId>log4j-over-slf4j</artifactId>
          <groupId>org.slf4j</groupId>
        </exclusion>
      </exclusions>
    </dependency>
    
    
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
    </dependency>

切换为log4j2

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

## 二、日志进阶 ##

### 2.1日志格式 ###

![905ee439dccb49d199a2d2ba57737c21.png][]

> 默认输出格式：
> 
>  *  时间和日期：毫秒级精度
>  *  日志级别：ERROR,WARN,INFO,DEBUG,or TRACE
>  *  进程ID
>  *  \---:消息分割符
>  *  线程名：使用\[\]包含
>  *  Logger名：通常是产生日志的类名
>  *  消息：日志记录的内容
> 
> 注意：logback没有FATAL级别，对应的是ERROR

![7b7875738a604df89f44bd8d86a4d460.png][]

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @slf4j  
    public class HelloController {
        private static final Logger log = LoggerFactory.getLogger(getClass());
    
        @GetMapping("/h")
        public String hello() {
            log.info("哈哈哈，方法进来了");
            return "hello";
        }
    }

### 2.2日志级别 ###

![3b2409f2421649679a471f18fa2a7708.png][]

相关配置![9422375d7e6c4b99a4fbf252d117ff0b.png][]

### 2.3日志分组 ###

#精确调整某个包下的日志级别  
    #logging.level.com.atguigu.logging.controller=debug  
    #logging.level.com.atguigu.logging.service=debug  
    #logging.level.com.aaa=debug  
    #logging.level.com.bbb=debug  
    
    
    logging.group.abc=com.atguigu.logging.controller, com.atguigu.logging.service,com.aaa, com. bbb  
    
    logging.level.abc=debug

![a1f0199277ed44afa53d02c333b18c36.png][]

### 2.4文件输出 ###

![2b51fd54347d4e8c960a9099fe3325eb.png][]

### 2.5归档与切割 ###

>  *  归档：每天的日志单独存到一个文档中。
>  *  切割：每个文件10MB,超过大小切割成另外一个文件。

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

### ![9e25991c8d6c4f479fb50445e9424680.png][] 2.6自定义配置 ###

![a32ecdb6c94f4c81855dc91e475cb3b6.png][]

![a996f249999048afa345e0f09870a482.png][]

[931c009d9a6843c68804012c90be5b0f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/4e1965fd2f5240feb4cf6700f5e64137.png
[4c1595b899184392be3133f214768e2e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/e917656981f2477ea7892a17dcabbe5d.png
[c77540c99de846369c46d65dc836a3df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/ef99443ee1814af89c72795c545474a5.png
[48880f30e18c429fa66492026b81a50f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/84ce10e8025141d6a6a99b4f9fbc475d.png
[b4bf98f6f75948eb9c26f15c4c2da897.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/f084e21f9c0f441dbe449c038b3edd62.png
[905ee439dccb49d199a2d2ba57737c21.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/aea1e03adf7849e79610d710b1ea53c2.png
[7b7875738a604df89f44bd8d86a4d460.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/37e84f1fea8e4f3cb8c6a053bacbccec.png
[3b2409f2421649679a471f18fa2a7708.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/cf2525a828954642a41ea5325b63883a.png
[9422375d7e6c4b99a4fbf252d117ff0b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/5294377f80a74f37afd7126c0bc10fed.png
[a1f0199277ed44afa53d02c333b18c36.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/79ec8c8e81a6479a81cd06632bc9e8ea.png
[2b51fd54347d4e8c960a9099fe3325eb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/61cc9a5b7b47438b94f75d2c0831403c.png
[9e25991c8d6c4f479fb50445e9424680.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/36329f2493e3461988cf0a7211a5938c.png
[a32ecdb6c94f4c81855dc91e475cb3b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/021d049d1ec4440f9b4775f9744b85d4.png
[a996f249999048afa345e0f09870a482.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/12/b260af0bb1c147439e657a2fb29be3f3.png