Spring Boot 源码分析系列02 logging模块日志组件装配

01.日志使用背景

1.1日志使用

spring boot 的日志使用很简单,直接在工程目录的resource目录下创建一个logback-spring.xml就能配置日志格式了。我们大胆猜测一下，spring默认使用的是logback日志组件，并且帮我们自动装配了它。

1.2 spring boot 依赖管理

再来看一个小知识点，spring-boot-starter-parent和spring-boot-dependencies。在创建spring boot 应用的时候，一般的做法是在应用的maven配置文件中，添加对spring-boot-starter-parent的依赖。

        org.springframework.boot
        spring-boot-starter-parent
        2.1.0.RELEASE
        
    

这是因为spring帮我们统一管理了企业级应用常用的依赖。
仔细观察spring-boot-starter-parent的依赖，他的父级项目又是spring-boot-dependencies。

        org.springframework.boot
        spring-boot-dependencies
        2.1.0.RELEASE
        ../../spring-boot-dependencies
    
    spring-boot-starter-parent

在spring-boot-dependencies里面才真正定义了相关的依赖和版本。应用显示指定一下即可。
看到这里，其实应用直接依赖spring-boot-starter-parent作为父项目依赖的使用姿势是不对的，由于maven不支持多继承特性。所以正确的使用姿势是自定义一个maven pom工程，暂且命名为cli-dependencies，让这个工程依赖spring-boot-dependencies，所有的应用在依赖这个父项目。这么做的原因是方便统一管理其他spring-boot不包含的依赖版本。

cli-dependencies
    http://www.example.com
    通用的依赖管理
    
    
    
        org.springframework.boot
        spring-boot-dependencies
        2.1.5.RELEASE
        
    

    
        UTF-8
        UTF-8
        1.8
        Greenwich.SR5
    

    
        
            
                org.springframework.cloud
                spring-cloud-dependencies
                ${spring-cloud.version}
                pom
                import
            
        


    

02.日志组件装配

2.1 分析依赖

spring-boot处理日志的模块命名为：spring-boot-starter-logging，依赖关系如下：

image.png

具体分析下logging模块：

// 依赖logback
    
      ch.qos.logback
      logback-classic
      1.2.3
      compile
    
// log4j在设计之初未考虑到使用sl4j作为门面
    
      org.apache.logging.log4j
      log4j-to-slf4j
      2.11.2
      compile
    
    
      org.slf4j
      jul-to-slf4j
      1.7.26
      compile
    
  

说明spring boot默认使用的日志组件就是logback，你想用其他组件，就得排除这个。另外也说明，如果要用log4j，可以直接使用，因为logging模块已经处理了sl4j门面兼容的问题。

2.2 组件初始化

springboot自动装配机制会读取spring-boot-2.1.5.RELEASE.jar!\META-INF\spring.factories文件内容，该文件配置了SpringBoot启动中要加载的组件。其中listeners中配置了org.springframework.boot.context.logging.LoggingApplicationListener。该类即为日志组件初始化的入口：

image.png

// LoggingApplicationListener.class
@Override
public void onApplicationEvent(ApplicationEvent event) {
    // SpringApplication的run方法执行的时候触发该事件
    if (event instanceof ApplicationStartedEvent) {
        // onApplicationStartedEvent方法内部会先得到LoggingSystem，然后调用beforeInitialize方法
        onApplicationStartedEvent((ApplicationStartedEvent) event);
    }
    // 环境信息准备好，ApplicationContext创建之前触发该事件
    else if (event instanceof ApplicationEnvironmentPreparedEvent) {
        // onApplicationEnvironmentPreparedEvent方法内部会做一下几个事情
        // 1. 读取配置文件中"logging."开头的配置，比如logging.pattern.level, logging.pattern.console等设置到系统属性中
        // 2. 构造一个LogFile(LogFile是对日志对外输出文件的封装)，使用LogFile的静态方法get构造，会使用配置文件中logging.file和logging.path配置构造
        // 3. 判断配置中是否配置了debug并为true，如果是，设置level的DEBUG，然后继续查看是否配置了trace并为true，如果是，设置level的TRACE
        // 4. 构造LoggingInitializationContext，查看是否配置了logging.config，如有配置，调用LoggingSystem的initialize方法并带上该参数，否则调用initialize方法并且configLocation为null
        // 5. 设置一些比如org.springframework.boot、org.springframework、org.apache.tomcat、org.apache.catalina、org.eclipse.jetty、org.hibernate.tool.hbm2ddl、org.hibernate.SQL这些包的log level，跟第3步的level一样
        // 6. 查看是否配置了logging.register-shutdown-hook，如配置并设置为true，使用addShutdownHook的addShutdownHook方法加入LoggingSystem的getShutdownHandler
        onApplicationEnvironmentPreparedEvent(
                (ApplicationEnvironmentPreparedEvent) event);
    }
    // Spring容器创建好，并进行了部分操作之后触发该事件
    else if (event instanceof ApplicationPreparedEvent) {
        // onApplicationPreparedEvent方法内部会把LoggingSystem注册到BeanFactory中(前期是BeanFactory中不存在name为springBootLoggingSystem的实例)
        onApplicationPreparedEvent((ApplicationPreparedEvent) event);
    }
    // Spring容器关闭的时候触发该事件
    else if (event instanceof ContextClosedEvent && ((ContextClosedEvent) event)
            .getApplicationContext().getParent() == null) {
        // onContextClosedEvent方法内部调用LoggingSystem的cleanUp方法进行清除工作
        onContextClosedEvent();
    }
}

LoggingApplicationListener#onApplicationStartingEvent
LoggingSystem类很重要。它相当于一个工厂类，通过get方法去生成不同日志组件的实例。
LoggingSystem#get:

public static LoggingSystem get(ClassLoader classLoader) {
//  取系统参数org.springframework.boot.logging.LoggingSystem
        String loggingSystem = System.getProperty(SYSTEM_PROPERTY);
        if (StringUtils.hasLength(loggingSystem)) {
            if (NONE.equals(loggingSystem)) {
                return new NoOpLoggingSystem();
            }
            return get(classLoader, loggingSystem);
        }
// 从SYSTEMS变量取出,并且判断类路径下是否有相关类【非常重要】
        return SYSTEMS.entrySet().stream()
                .filter((entry) -> ClassUtils.isPresent(entry.getKey(), classLoader))
                .map((entry) -> get(classLoader, entry.getValue())).findFirst()
                .orElseThrow(() -> new IllegalStateException(
                        "No suitable logging system located"));
    }

所以，如果在程序启动时，不指定参数-Dorg.springframework.boot.logging.LoggingSystem的，会默认从集合SYSTEMS取第一个。因为LogbackLoggingSystem是第一个实现组件，所以会被默认使用。

private static final Map SYSTEMS;

    static {
                // 有序的map集合
        Map systems = new LinkedHashMap<>();
        systems.put("ch.qos.logback.core.Appender",
                "org.springframework.boot.logging.logback.LogbackLoggingSystem");
        systems.put("org.apache.logging.log4j.core.impl.Log4jContextFactory",
                "org.springframework.boot.logging.log4j2.Log4J2LoggingSystem");
        systems.put("java.util.logging.LogManager",
                "org.springframework.boot.logging.java.JavaLoggingSystem");
        SYSTEMS = Collections.unmodifiableMap(systems);
    }

到这里基本就很清楚spring是如何加载bean组件了。

• LoggingApplicationListener被springboot自动装配，监听容器启动事件onApplicationStartingEvent；
• 通过LoggingSystem判断日志应该加载哪一个日志组件，优先从org.springframework.boot.logging.LoggingSystem系统参数中获取；
• step2取不到再从静态变量SYSTEMS-有序的内建map。key是每种日志组件关键的实现类,value是spring-boot-logging-starter提供的实现。
• 循环遍历map，过滤类路径下是否存在。如果同时存在多个，则返回第一个。所以如果想用log4j，必须先要排除logback模块的依赖。否则永远取的是logback，因为这个map有序（logback排在前面）。
• 返回抽象的loggingSystem具体子类

2.3日志的初始化

调用run方法的时候，会从类路径或者系统参数找到需要装配的日志组件，在spring容器运行之前，开始调用Loggingsystem的初始化。LoggingApplicationListener#onApplicationEnvironmentPreparedEvent，这里就会调用具体LoggingSystem子类的初始化方法。

image.png

LoggingSystem是个抽象类，内部有这几个方法：

• beforeInitialize方法：日志系统初始化之前需要处理的事情。抽象方法，不同的日志架构进行不同的处理
• initialize方法：初始化日志系统。默认不进行任何处理，需子类进行初始化工作
• cleanUp方法：日志系统的清除工作。默认不进行任何处理，需子类进行清除工作
• getShutdownHandler方法：返回一个Runnable用于当jvm退出的时候处理日志系统关闭后需要进行的操作，默认返回null，也就是什么都不做
• setLogLevel方法：抽象方法，用于设置对应logger的级别
  以LogbackLoggingSystem为例，看下具体的初始化方法

// 标准的配置文件的名称
@Override
    protected String[] getStandardConfigLocations() {
        return new String[] { "logback-test.groovy", "logback-test.xml", "logback.groovy",
                "logback.xml" };
    }

// 初始化
@Override
    public void initialize(LoggingInitializationContext initializationContext,
            String configLocation, LogFile logFile) {
        LoggerContext loggerContext = getLoggerContext();
        if (isAlreadyInitialized(loggerContext)) {
            return;
        }
// 先调用AbstractLoggingSystem#initialize
        super.initialize(initializationContext, configLocation, logFile);
        loggerContext.getTurboFilterList().remove(FILTER);
        markAsInitialized(loggerContext);
        if (StringUtils.hasText(System.getProperty(CONFIGURATION_FILE_PROPERTY))) {
            getLogger(LogbackLoggingSystem.class.getName()).warn(
                    "Ignoring '" + CONFIGURATION_FILE_PROPERTY + "' system property. "
                            + "Please use 'logging.config' instead.");
        }
    }

AbstractLoggingSystem

@Override
    public void initialize(LoggingInitializationContext initializationContext,
            String configLocation, LogFile logFile) {
// 如果有配置具体的文件，从指定文件加载  logging.config=classpath:**.xml
        if (StringUtils.hasLength(configLocation)) {
            initializeWithSpecificConfig(initializationContext, configLocation, logFile);
            return;
        }
// 没有就去resource目录下找，下面看下找的策略
        initializeWithConventions(initializationContext, logFile);
    }
......
// 具体查找配置文件的策略
private void initializeWithConventions(
            LoggingInitializationContext initializationContext, LogFile logFile) {
// 获取日志组件默认的配置
// 01 getStandardConfigLocations获取内建的4个配置文件名称
//02 判断任意一个存在即返回
        String config = getSelfInitializationConfig();
        if (config != null && logFile == null) {
            // self initialization has occurred, reinitialize in case of property changes
            reinitialize(initializationContext);
            return;
        }
// 如果上面4个文件都找不到，查找spring扩展的4个文件，扩展策略类似于 logback.xml->logback-spring.xml，判断classpath路径是否存在。
        if (config == null) {
            config = getSpringInitializationConfig();
        }
// 配置不为空 直接初始化
        if (config != null) {
            loadConfiguration(initializationContext, config, logFile);
            return;
        }
// 配置文件为空，加载默认配置
        loadDefaults(initializationContext, logFile);
    }

小结：
1.日志配置文件叫logback.xml或者logback-spring.xml都可以。
2.日志组件装配的思想和spring boot大致相同。利用条件装配，判断类路径下是否有具体的类存在。ClassUtils.isPresent(entry.getKey(), classLoader)
3.日志配置文件的获取策略也是判断resource目录下的指定名称的配置文件是否存在。``
参考：ClassPathResource resource = new ClassPathResource(location, this.classLoader);

• springboot日志组件加载机制
• SpringBoot源码分析之日志系统的构造