springboot日志框架学习整理笔记（一）

灰太狼 2022-12-20 11:11 137阅读 0赞

# 背景 #

1、由原先的System.out.println()来打印日志；

2、把日志通过IO流存储到日志文件夹中；

3、封装一个日志框架来完善日志功能；

4、通过封装API来调用日志框架的接口；

5、最终形式==日志框架和使用方式和JDBC驱动差不多；

写了一个统一的接口层；日志门面（日志的一个抽象层）；logging-abstract.jar；  
给项目中导入具体的日志实现就行了；我们之前的日志框架都是实现的抽象层；

# 市面上的日志框架 #

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

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>日志门面 （日志的抽象层）</td> 
   <td>日志实现</td> 
  </tr> 
  <tr> 
   <td> <p>JCL（Jakarta Commons Logging） SLF4j（Simple Logging</p> <p>Facade for Java） jboss-logging</p> </td> 
   <td> <p>Log4j JUL（java.util.logging）</p> <p>Log4j2 Logback</p> </td> 
  </tr> 
 </tbody> 
</table>

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

实际上，SLF4J和log4J以及logback都是一个人写的；

log4j2是apache公司写的，底层写的很好，但是上层适配不起来，所以存在一些适配性的问题。

SpringBoot：底层是Spring框架，Spring框架默认是用JCL；  
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");
      } 
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70][]

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

淡蓝色是抽象层的SFL4J的包；

绿色是日志适配器的包，连接SLF4J的抽象层与下层所选的实现层；

深蓝色是实现层；

## 2、遗留问题 ##

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

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 1][]

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

# 3、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>

底层依赖关系

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 2][]

总结：

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_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 3][]

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的方式记录日志，引入其他框架的时候，只需要  
把这个框架依赖的日志框架排除掉即可；

# 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

SpringBoot修改日志的默认配置

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 style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>logging.file</td> 
   <td>logging.path</td> 
   <td>Example</td> 
   <td>Description</td> 
  </tr> 
  <tr> 
   <td>(none)</td> 
   <td>(none)</td> 
   <td>&nbsp;</td> 
   <td>只在控制台输出<br> &nbsp;</td> 
  </tr> 
  <tr> 
   <td>指定文件</td> 
   <td>(none</td> 
   <td>my.lo</td> 
   <td>输出日志到my.log</td> 
  </tr> 
  <tr> 
   <td>(none</td> 
   <td>指定目录</td> 
   <td>/var/lo</td> 
   <td>输出到指定目录的 spring.log 文</td> 
  </tr> 
 </tbody> 
</table>

## 2、指定配置 ##

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

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>Logging Syste</td> 
   <td>Customizati</td> 
  </tr> 
  <tr> 
   <td>Logba</td> 
   <td>logback-spring.xml , logback-spring.groovy , logback.xml or<br> logback.groovy</td> 
  </tr> 
  <tr> 
   <td>Log4j</td> 
   <td>log4j2-spring.xml or log4j2.xml</td> 
  </tr> 
  <tr> 
   <td> <p>JDK (Java Ut</p> <p>Loggin</p> </td> 
   <td>logging.properties</td> 
  </tr> 
 </tbody> 
</table>

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

<springProfile name="staging">
    <!‐‐ configuration to be enabled when the "staging" profile is active ‐‐>
    可以指定某段配置只在某个环境下生效
    </springProfile>

如：

<appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
    <!‐‐
        日志输出格式：
        %d表示日期时间，
        %thread表示线程名，
        %‐5level：级别从左显示5个字符宽度
        %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
        %msg：日志消息，
        %n是换行符
    ‐‐>
    <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>

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70]: /images/20221120/eddd382bc7a84a76884556e785fd5e59.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201111211513931.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201111211729508.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201111211922664.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BzaGRoeA==,size_16,color_FFFFFF,t_70