SpringBoot源码学习之路（四、日志框架配置和使用）

日志

---

一、日志框架

市面上的日志框架：

日志的抽象层	日志实现
JCL（Jakarta Commons Logging）、SLF4j（Simple Logging Facade for Java）、jboss-logging	Log4j、 JUL（java.util.logging）、Logback

一般的日志实现就是从表格中选择一个 【日志抽象层+日志实现】

SpringBoot日志处理：底层是Spring框架，而Spring框架默认是用JCL(common-logging不导入都会出错)；
但是SpringBoot对此进行升级，SpringBoot选用 SLF4j和logback。

二、SLF4j使用

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

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

---

二、遗留问题

1.一个系统中可能出现：

SpringBoot（slf4j+logback）+ Spring（commons-logging）+ Hibernate（jboss-logging）+ MyBatis(xxx)等多种日志框架。

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

1、将系统中其他日志框架先排除出去；

2、用中间包来替换原有的日志框架（偷梁换柱）；

3、我们导入slf4j其他的实现。

---

三、SpringBoot日志关系

SpringBoot使用spring-boot-starter-logging来做日志功能，通过项目有引入spring-boot-starter，spring-boot-starter会自动带入spring-boot-starter-logging的依赖。

        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starterartifactId>
        dependency>

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

底层依赖关系：

查看依赖关系可以得到下面结论：

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

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

​ 3）、中间替换包过程如下代码，将其他的日志工厂接口在实例化的时候都替换成了SLF4JLogFactory(此处使用自己的依赖包（ xxx-to/over-slf4j.jar这种类型的依赖包 ）源码查看)

@SuppressWarnings("rawtypes")
public abstract class LogFactory {
    //将所有的日志工厂都实例化为SLF4J的日志工厂
    static LogFactory logFactory = new SLF4JLogFactory();

4）、如果我们要引入其他框架依赖，一定要把其他框架的默认日志依赖移除掉
SpringBoot能自动适配所有的日志，而且底层使用slf4j+logback的方式记录日志，引入其他框架依赖的时候，只需要把这个框架依赖的日志框架排除掉即可；

​ 比如Spring框架，Spring框架用的是commons-logging；

        <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-coreartifactId>
            <exclusions>
                <exclusion>
                    <groupId>commons-logginggroupId>
                    <artifactId>commons-loggingartifactId>
                exclusion>
            exclusions>
        dependency>

---

四、日志使用

1、默认配置：

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

    //记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public 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日志...");
    }

日志输出格式：
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

修改SpringBoot日志的默认配置：

logging.level.com.atguigu=trace

#（1）不指定路径，仅指定日志文件名会在当前项目下生成springboot.log日志
#logging.file=springboot.log

#（2） 也可以指定完整的路径；
#logging.file=G:/springboot.log

#（3）在当前磁盘的根路径下创建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

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

2、指定配置

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

Logging System	Customization
Logback	logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

配置路径下直接放“logback.xml”配置文件即可被日志框架识别；
logback.xml模板：

<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%npattern>
        layout>
    appender>

      
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        
        <file>${LOG_HOME}/${appName}.logfile>
        
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.logfileNamePattern>
            
            <MaxHistory>365MaxHistory>
            
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MBmaxFileSize>
            timeBasedFileNamingAndTriggeringPolicy>
        rollingPolicy>
             
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%npattern>
        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> 

但是SpringBoot更推荐将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%npattern>
            springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%npattern>
            springProfile>
        layout>
    appender>

如果使用logback.xml（而不是logback-spring.xml）作为日志配置文件，还要使用profile功能，会有以下错误：

no applicable action for [springProfile]

五、切换日志框架（一般不推荐）

可以按照slf4j的日志适配图，进行相关的切换（其实就是将上面说过的那些替换型的xxx-to/over-slf4j.jar依赖去除，然后新增我们要使用的日志框架）；

slf4j+log4j的方式；

<dependency>
  <groupId>org.springframework.bootgroupId>
  <artifactId>spring-boot-starter-webartifactId>
  <exclusions>
    <exclusion>
      <artifactId>logback-classicartifactId>
      <groupId>ch.qos.logbackgroupId>
    exclusion>
    <exclusion>
      <artifactId>log4j-over-slf4jartifactId>
      <groupId>org.slf4jgroupId>
    exclusion>
  exclusions>
dependency>

<dependency>
  <groupId>org.slf4jgroupId>
  <artifactId>slf4j-log4j12artifactId>
dependency>

切换为log4j2

   <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-webartifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-loggingartifactId>
                    <groupId>org.springframework.bootgroupId>
                exclusion>
            exclusions>
        dependency>

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