五、SpringBoot与日志

在项目的开发中，日志是必不可少的一个记录事件的组件，所以也会相应的在项目中实现和构建我们所需要的日志框架。

而市面上常见的日志框架有很多，比如：JCL、SLF4J、Jboss-logging、jUL、log4j、log4j2、logback等等，我们该如何选择呢？

通常情况下，日志是由一个抽象层+实现层的组合来搭建的。

SpringBoot选用SLF4j和logback;

1、SLF4j使用

1、如何在系统中使用SLF4j

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

给系统里面导入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");
  }
}

图示：

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

2、如何统一框架

我们知道每种框架都有自己的日志系统，如果一个系统里面包含了SLF4J+logback,Spring（commons-logging）,Hibernate(jboss-logging),Mybatis·····等等。如何统一日志记录，让所有的日志都统一使用slf4j进行输出？

我们来看看这张图，一个应用面向了很多日志框架，如果我们直接去掉这些依赖包的话，系统肯定会报错的，因为Spring本来底层会调用这些框架的API等。那怎么解决？从图中可以看出采取了偷梁换柱的做法；用另一个jar包代替了本来的jar包。比如：logging；代替后和slf4j完美契合，就可以使用。

让系统中所有的日志都统一到slf4j：

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

3、SpringBoot的日志关系

SpringBoot使用它来做日志功能：

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

依赖关系图：

总结：

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

2. 其他日志会转换成slf4j

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

运行结果：

SpringBoot修改日志的默认配置：
在application.properties文件中进行配置

#指定com.example包下的类使用trace级别，其他没有指定的默认使用SpringBoot的默认级别
logging.level.com.example = trace

#默认在当前项目下生成springboot.log
logging.file.name=springboot.log

#可以指定完整的路径,运行会在D盘生成一个springboot.log
logging.file.name=D:/springboot.log

#在当前磁盘的根路径下面创建spring文件夹和里面的log文件，使用spring.log作为默认文件
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

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

2、指定配置

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

logback.xml :直接放在项目的resources目录下，会被直接识别

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

no applicable action for [springProfile]

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

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

默认启动是非开发环境，如果要设置为开发环境需要去application.properties文件中配置

spring.profiles.active = dev