SpringBoot_日志(2.2.5 version)

爱被打了一巴掌 2023-07-14 05:29 9阅读 0赞

### 文章目录 ###

*   *  1. 日志框架
     *  2. SLF4j使用
     *   *  1. 如何在系统中使用SLF4j https://www.slf4j.org
         *  2. 遗留问题
     *  3. SpringBoot日志关系
     *  4、日志使用；
     *   *  1、默认配置
         *  2、指定配置
     *  5、切换日志框架

## 1. 日志框架 ##

**市面上的日志框架；**

JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j…

<table> 
 <thead> 
  <tr> 
   <th>日志门面 （日志的抽象层）</th> 
   <th>日志实现</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging</td> 
   <td>Log4j JUL（java.util.logging） Log4j2 <strong>Logback</strong></td> 
  </tr> 
 </tbody> 
</table>

左边选一个门面（抽象层）、右边来选一个实现；

日志门面： SLF4J；

日志实现：Logback；

Spring5.X选用SLF4j和Log4j2

**SpringBoot选用 SLF4j和logback；**

## 2. SLF4j使用 ##

### 1. 如何在系统中使用SLF4j https://www.slf4j.org ###

以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；

给系统里面导入slf4j的jar和 logback的实现jar

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");
      }
    }

图示；

![click to enlarge][]

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

### 2. 遗留问题 ###

统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出？

![click to enlarge][click to enlarge 1]

**如何让系统中所有的日志都统一到slf4j？**

1.  将系统中其他日志框架先排除出去；
2.  用中间包来替换原有的日志框架；
3.  导入slf4j其他的实现

## 3. SpringBoot日志关系 ##

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

SpringBoot使用它来做日志功能；

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

底层依赖关系

*  logback-classic是SpringBoot使用的日志框架
 *  其他两个是将其他日志转为slf4j

\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Zh5kQRZF-1583839873759)(C:\\Users\\83998\\AppData\\Roaming\\Typora\\typora-user-images\\image-20200309123156953.png)\]

*  这三者同时都依赖于slf4j-api  
    ![在这里插入图片描述][20200314151542374.png]

总结：

1）SpringBoot底层也是使用slf4j+logback的方式进行日志记录

2）SpringBoot也把其他的日志都替换成了slf4j；

3）中间替换包

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NoaWxsX0x5bg_size_16_color_FFFFFF_t_70]

4）如果要引入其他框架？一定要把这个框架的默认日志依赖移除掉？

<dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-dbcp2</artifactId>
        <version>2.7.0</version>
        <scope>compile</scope>
        <exclusions>
            <exclusion>
                <artifactId>commons-logging</artifactId>
                <groupId>commons-logging</groupId>
            </exclusion>
        </exclusions>
        <optional>true</optional>
    </dependency>

**SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；**

## 4、日志使用； ##

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

SpringBoot默认帮我们配置好了日志；

//记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
        
        //System.out.println();
        //日志的级别；
        //由低到高   trace<debug<info<warn<error
        //可以调整输出的日志级别；日志就只会在这个级别以以后的高级别生效
        logger.trace("这是trace日志...");
        logger.debug("这是debug日志...");
        //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别；root级别
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }

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

SpringBoot修改日志的默认配置

#日志级别
      level: 
        com.atguigu: trace 
      # 不指定路径在当前项目下生成springboot.log日志
      # 可以指定完整的路径；
      #file: springboot.log
      # 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
      path: /spring/log
      pattern:
        # 在控制台输出的日志的格式
        console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n"
        # 指定文件中日志输出的格式
        file: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%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>, <code>logback-spring.groovy</code>, <code>logback.xml</code> or <code>logback.groovy</code></td> 
  </tr> 
  <tr> 
   <td>Log4j2</td> 
   <td><code>log4j2-spring.xml</code> or <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>

如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

`no applicable action for [springProfile]`

## 5、切换日志框架 ##

可以按照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>

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

[click to enlarge]: /images/20230529/f84d617862fb4e529b2086561639fd92.png
[click to enlarge 1]: /images/20230529/e219e40b45704b4ca440780f53bc6ffe.png
[20200314151542374.png]: /images/20230529/72af041569924b049809493a866e191d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0NoaWxsX0x5bg_size_16_color_FFFFFF_t_70]: /images/20230529/f3b5d945c1e04759b82984faa7c44144.png