SpringBoot的日志【日志框架、日志配置】（超详细）

绝地灬酷狼 2022-11-03 11:09 214阅读 0赞

### SpringBoot的日志【日志框架、日志配置】 ###

*  日志框架
 *   *  市面上的日志框架
 *  SLF4j使用
 *   *  在系统中使用SLF4j
     *  遗留问题
 *  SpringBoot日志关系
 *  日志使用
 *   *  默认配置
     *  指定配置
 *  切换日志框架

# 日志框架 #

**小张开发了一个大型系统：  
 1、System.out.println("")；将关键数据打印在控制台；去掉？写在一个文件？  
 2、框架来记录系统的一些运行时信息；日志框架 ； zhanglogging.jar；  
 3、高大上的几个功能？异步模式？自动归档？xxxx？ zhanglogging-good.jar？  
 4、将以前框架卸下来？换上新的框架，重新修改之前相关的API；zhanglogging-prefect.jar；  
 5、JDBC—数据库驱动；  
 写了一个统一的接口层；日志门面（日志的一个抽象层）；logging-abstract.jar；  
 给项目中导入具体的日志实现就行了；我们之前的日志框架都是实现的抽象层。**

## 市面上的日志框架 ##

**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） <strong>jboss-logging</strong></td> 
   <td>Log4j JUL（java.util.logging） Log4j2 <strong>Logback</strong></td> 
  </tr> 
 </tbody> 
</table>

> **左边选一个门面（抽象层）、右边来选一个实现：  
> 日志门面： SLF4J  
> 日志实现：Logback**

**SpringBoot：底层是Spring框架，Spring框架默认是用JCL  
SpringBoot选用 SLF4j和logback**

# SLF4j使用 #

## 在系统中使用SLF4j ##

**官方文档：[链接][Link 1]**

**以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法。**  
**给系统里面导入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");
      }
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70]  
**每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件。**

## 遗留问题 ##

**a系统使用：（slf4j+logback）: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx**

**统一日志记录，即使是别的框架和我一起统一使用slf4j进行输出。**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 1]

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

# SpringBoot日志关系 #

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

**SpringBoot使用这个来做日志功能。**

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

**1、SpringBoot底层也是使用slf4j+logback的方式进行日志记录。  
2、SpringBoot也把其他的日志都替换成了slf4j  
3、中间替换包**

@SuppressWarnings("rawtypes")
    public abstract class LogFactory { 
    
        static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";
    
        static LogFactory logFactory = new SLF4JLogFactory();

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 2]  
**4、如果我们要引入其他框架，一定要把这个框架的默认日志依赖移除掉。**

**Spring框架用的是commons-logging**

<dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-core</artifactId>
    	<exclusions>
    		<exclusion>
    			<groupId>commons-logging</groupId>
    			<artifactId>commons-logging</artifactId>
    		</exclusion>
    	</exclusions>
    </dependency>

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

# 日志使用 #

## 默认配置 ##

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

package com.keafmd.springboot;
    
    import org.junit.jupiter.api.Test;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.boot.test.context.SpringBootTest;
    
    @SpringBootTest
    class SpringBoot03LoggingApplicationTests { 
    
        //记录器
        Logger logger = LoggerFactory.getLogger(getClass());
    
        @Test
        void contextLoads() { 
    
            //日志的级别
            //由低到高 trace<debug<info<warn<error
            //可以调整需要输出的日志级别，日志就只会在这个级别以后的高级别生效
            logger.trace("这是trace日志");
            logger.debug("这是debug日志");
            //SpringBoot默认给我们使用的是info级别的，没有指定级别的就用springboot默认规定的级别：root级别
            logger.info("这是info日志");
            logger.warn("这是warn信息");
            logger.error("这是error日志");
        }
    
    }

![在这里插入图片描述][20210302163715423.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

**SpringBoot修改日志的默认配置：**

logging.level.com.keafmd=trace
    spring.profiles.active=dev
    
    #当前项目下生成springboot.log日志
    #logging.file.name=springboot.log
    
    #指定springboot.log日志文件的路径位置 时生成spring.log日志文件
    #logging.file.path=E:/springboot
    
    logging.file.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

**运行结果：**

logging.level.com.keafmd=trace

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

#当前项目下生成springboot.log日志
    logging.file.name=springboot.log

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

logging.file.path=/spring/log

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

#指定文件中日志输出的格式
    logging.pattern.file=%d{ yyyy-MM-dd} === [%thread] === %-5level === %logger{ 50} === %msg%n

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

## 指定配置 ##

**给类路径下放上每个日志框架自己的配置文件即可；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：直接就被日志框架识别了。**

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration scan="false" scanPeriod="60 seconds" debug="false">
        
        <property name="LOG_HOME" value="/app/log" />
        
        <property name="appName" value="atguigu-springboot"></property>
        
        <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
            
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            </layout>
        </appender>
    
          
        <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${LOG_HOME}/${appName}.log</file>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
                
                <MaxHistory>365</MaxHistory>
                
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
                 
            <layout class="ch.qos.logback.classic.PatternLayout">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
            </layout>
        </appender>
    
        
        
        <logger name="com.atguigu" level="debug" />
        
        <logger name="org.springframework" level="debug" additivity="false"></logger>
    
    
    
        
        <root level="info">
            <appender-ref ref="stdout" />
            <appender-ref ref="appLogAppender" />
        </root>
    </configuration>

**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>

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

> **如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误：  
> `no applicable action for [springProfile]`**

# 切换日志框架 #

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

> **注意：以下是基于SpringBoot1.5.10的，如果是2+不太一样。**

**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>

> **SpringBoot的日志【日志框架、日志配置】（超详细）的全部内容。**

**看完如果对你有帮助，感谢点赞支持！  
如果你是电脑端的话，看到右下角的 “一键三连” 了吗，没错点它\[哈哈\]**  
![在这里插入图片描述][20210115230629703.gif_pic_center]

**加油！**

**共同努力！**

**Keafmd**

[Link 1]: http://www.slf4j.org/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70]: /images/20221024/a2f97ed1409a4cd5838181d104d2c0ce.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 1]: /images/20221024/6df0ed6b9f6043b6ac74e42d5f420d01.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 2]: /images/20221024/69b377454ac34c3c818cc63fa06bbf63.png
[20210302163715423.png]: /images/20221024/e2f58c3f0d3e484c971d39feab6f7a49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 3]: /images/20221024/20e8c5af722247c696f332362e91d179.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 4]: /images/20221024/76d2a049dfa34777aa482ee4169f3e3d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 5]: /images/20221024/e9b3c3be655240bdad2855af31982339.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 6]: /images/20221024/a791087382784d6fb7a1a01179f2222e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80Mzg4MzkxNw_size_16_color_FFFFFF_t_70 7]: /images/20221024/f2d1eccfa75a4138911c6dbe9cd376f5.png
[20210115230629703.gif_pic_center]: /images/20221024/e00342a538f14d548dd21a9cf8088d1a.png