《SpringBoot启动流程一》:万字debug梳理SpringBoot如何加载并处理META-INF/spring.factories文件中的信息

本文涉及的产品
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 1、SpringBoot如何加载并处理spring.factories中的文件?2、加载出的spring.factories文件中的内容如何排序?3、多个spring.factories文件内容重复怎么处理?

一、前言

看Spring Boot源码的时候,发现在SpringApplication初始化阶段会加载Spring应用上下文初始化器(ApplicationContextInitializer)、加载Spring应用事件监听器(ApplicationListener);而ApplicationContextInitializer 和 ApplicationListener内建的实现类预置在spring-boot jar包的META-INF/spring.factories文件中;
在这里插入图片描述
此外,在spring-boot-autoconfigure jar包的META-INF/spring.factories文件中也有一部分:
在这里插入图片描述
所以,在Spring Boot中一共内建了11个ApplicationListener、7个ApplicationContextInitializer。

那么SpringBoot是怎么将其加载到Spring容器中的呢?怎么加载到SpringApplication中的呢?我们就此展开研究。

二、正文

入口

无论是在SpringApplication初始化阶段时加载Spring事件监听器ApplicationListener、Spring应用上下文初始化器ApplicationContextInitializer,还是在SpringApplication准备阶段时加载Spring运行时监听器SpringApplicationRunListener、异常报告器SpringBootExceptionReporter,都要从SpringApplication#getSpringFactoriesInstances()重载方法开始,并且进入到getSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes, Object... args)
在这里插入图片描述
以Spring应用上下文初始化器为例,此处的typeApplicationContextInitializer

整体的处理流程为:
在这里插入图片描述

下面我们分开来看;

1、找到type的所有实现类

使用Spring工厂加载机制方法SpringFactoriesLoader.loadFactoryName(Class,ClassLoader)来做这个操作;
在这里插入图片描述
SpringFactoriesLoader.loadFactoryName(Class,ClassLoader)中首先会根据类加载器加载出所有spring.factories中的所有内容。

1)loadSpringFactories(ClassLoader)

loadSpringFactories(ClassLoader)会解析所有加载的jar包中 META-INF/spring.factories配置文件的配置内容,并组装为Map<String, List>数据结构,方法返回。具体流程如下:

  1. 首先,去缓冲中查询是否有入参classLoader对应的配置信息(仅第一次加载spring.factories文件时不走缓存),如果存在,则表明服务之前解析过配置文件 并 方法返回。如果不存在,则进行解析操作。
  2. 其次,获得所有依赖jar包中,具有META-INF/spring.factories配置文件的jar文件URI,并依次进行遍历。
  3. 接着,将spring.factories配置的内容转化成properties实例;遍历properties实例,将key和value维护到Map<String, List<String>> result数据结构中,如果多个spring.factories中的key相同,则value取合集。
  4. 最后,将result维护到缓冲cache中——key=ClassLoader value=result;并将result作为返回值返回。

<1> 缓存cache数据结构:

static final Map<ClassLoader, Map<String, List<String>>> cache = new ConcurrentReferenceHashMap<>();

<2> 方法主体:

private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    // 1、去缓存中,查询是否有入参classLoader对应的配置信息,
    // 如果存在,则表明服务之前解析过配置文件。如果不存在,则进行解析操作
    MultiValueMap<String, String> result = cache.get(classLoader);
    // 缓存中存在则直接返回
    if (result != null) {
        return result;
    }

    try {
        // 2、获得所有依赖jar包中,具有META-INF/spring.factories配置文件的jar文件URI
        // todo 问自己一个问题,它是怎么找到的?
        Enumeration<URL> urls = (classLoader != null ?
                classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
                ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
        result = new LinkedMultiValueMap<>();
        // 遍历所有的URI
        while (urls.hasMoreElements()) {
            URL url = urls.nextElement();
            // 通过url获得资源resource
            UrlResource resource = new UrlResource(url);
            // 3、将spring.factories配置的内容转化成properties实例
            Properties properties = PropertiesLoaderUtils.loadProperties(resource);
            // 4、遍历properties实例,将key和value维护到Map<String, List<String>> result数据结构中
            for (Map.Entry<?, ?> entry : properties.entrySet()) {
                String factoryTypeName = ((String) entry.getKey()).trim();
                // StringUtils.commaDelimitedListToStringArray只是单纯的将字符串转为String[]数组
                for (String factoryImplementationName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
                    result.add(factoryTypeName, factoryImplementationName.trim());
                }
            }
        }
        // 4、将result维护到缓冲cache中——key=ClassLoader value=result
        cache.put(classLoader, result);
        return result;
    }
    catch (IOException ex) {
        throw new IllegalArgumentException("Unable to load factories from location [" +
                FACTORIES_RESOURCE_LOCATION + "]", ex);
    }
}

在遍历properties实例,将key和value维护到Map<String, List> result数据结构的过程中,可以发现一个问题:如果多个spring.factories文件中针对同一个key有相同的value值,那岂不就是重复添加了。

假设,我依赖的某一个jar包的META-INF/factories中和 spring-boot jar包的META-INF/factories中都有 `org.springframework.context.ApplicationContextInitializer=\
org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer,\`。则 ConfigurationWarningsApplicationContextInitializer会被添加两次到 ApplicationContextInitializer对应的 List<String>中。

spring不会有这种bug吧?显然是不可能的,往上追,追到SpringApplication类中,在获取到type类所有实现类的类名时会用Set集合做一个去重。
在这里插入图片描述
思考一下为什么不能在最底层就做去重呢?而需要每个调用方都自己去重!

2)classLoader.getResources(FACTORIES_RESOURCE_LOCATION)

我很好奇,classLoader.getResources(FACTORIES_RESOURCE_LOCATION)它是如何找到所有META-INF/spring.factories文件的?所以这里特意写一小节。

此处的classLoader为AppClassLoader;比较有意思的是getResources(FACTORIES_RESOURCE_LOCATION)方法使用F7进不去,要进去到AppClassLoader里打断点。
在这里插入图片描述

AppClassLoaderLauncher的静态内部类,其类图如下:
在这里插入图片描述
即,AppClassLoader间接继承自ClassLoader,而getResources(String name)方法在其类结构中只出现在ClassLoader中,所以要去ClassLoader中打断点;
在这里插入图片描述
加载Resource资源时也会用到父类加载器。递归由AppClassLoader 的父加载器 ExtClassLoader 负责加载Resource资源;最终体现为:Enumeration<URL>[]数组的0下标所表示其父类、祖父类加载器加载到的Resources资源,而1下标处表示自己加载到Resources资源,这也和双亲委派机制的不一样的点。

AppClassLoader 的父类、祖父类加载器并没有加载到任何资源(因为META-INF/Spring.factories文件也只存在于AppClassLoader的扫描的目录下)。
在这里插入图片描述
最后看一下AppClassLoader是怎么找到所有的META-INF/spring.factories文件的?

1> 因为ClassLoader#findResources(String)是一个抽象方法,具体逻辑由子类实现,结合AppClassLoader的类图,定位到URLClassLoader#findResources(String)

在这里插入图片描述
在URLClassLoader内部会调用其组合的URLClassPath类的findResources(String, boolean)方法去做一个真正的资源扫描操作。
在这里插入图片描述
最终效果如下,但是不建议追(太深了,并且很不好debug)。
在这里插入图片描述
但是有一点我们可以记住:hasMoreElements() 和 nextElement()方法均出自sun.misc包下的CompoundEnumeration类。

有兴趣的建议参考博主打断点的思路继续深追如下代码段:
在这里插入图片描述

3)loadSpringFactories(ClassLoader)返回结果

在这里插入图片描述
接着通过Map的getOrDefault()方法获取到result中key为ApplicationContextInitializer的value。
在这里插入图片描述
最后回到SpringApplication#getSpringFactoriesInstances()方法中,使用Set集合来接返回值,以达到一个去重的效果。
在这里插入图片描述

2、实例化type的所有实现类

紧接着上面进入到createSpringFactoriesInstances()方法根据类的全路径名做实例化操作。

List<T> instances = createSpringFactoriesInstances(type, parameterTypes, classLoader, args, names);

遍历所有的全路径类名,使用AppClassLoader将相应Class文件从磁盘装载到内存中,然后利用反射获取Class类的无参构造函数、实例化对象。

注意:要实例化的类必须要有无参构造函数。

private <T> List<T> createSpringFactoriesInstances(Class<T> type, Class<?>[] parameterTypes,
        ClassLoader classLoader, Object[] args, Set<String> names) {
    List<T> instances = new ArrayList<>(names.size());
    for (String name : names) {
        try {
            // 装载class文件到内存
            Class<?> instanceClass = ClassUtils.forName(name, classLoader);
            Assert.isAssignable(type, instanceClass);
            Constructor<?> constructor = instanceClass.getDeclaredConstructor(parameterTypes);
            // 利用反射实例化对象
            T instance = (T) BeanUtils.instantiateClass(constructor, args);
            instances.add(instance);
        }
        catch (Throwable ex) {
            throw new IllegalArgumentException("Cannot instantiate " + type + " : " + name, ex);
        }
    }
    return instances;
}

3、做Order排序

将type类对应的所有实现类实例化完毕之后,要对他们做一个根据Order的排序。

AnnotationAwareOrderComparator.sort(instances);

sort()方法中直接使用List集合的sort()方法,但需要自定义Comparator为当前类实例AnnotationAwareOrderComparator
在这里插入图片描述
再看AnnotationAwareOrderComparator的类结构:
在这里插入图片描述
AnnotationAwareOrderComparator继承自OrderComparator,自定义Comparator需要实现Comparator的抽象方法compare(T o1, T o2)。AnnotationAwareOrderComparator自身没有compare()方法,所以看其父类OrderComparator中的compare方法;

在这里插入图片描述
因为OrderComparator#doCompare(Object o1, Object o2, OrderSourceProvider sourceProvider)方法中的入参sourceProvider为null,所以进入到getOrder()方法时,后续直接调用子类的findOrder(Object obj)方法去查找相应类的顺序值。
在这里插入图片描述
AnnotationAwareOrderComparator#findOrder()方法中先调用父类OrderComparator#findOrder()方法,如果找到顺序值直接返回,否者从类的@Order注解中取到顺序值。

1> 先看OrderComparator#findOrder()方法:

  • 该方法判断obj有没有实现Ordered接口,实现Ordered接口之后,有没有重写其getOrder()方法,如果重写了,则直接从getOrder()中获取到序列值。
@Nullable
protected Integer findOrder(Object obj) {
    return (obj instanceof Ordered ? ((Ordered) obj).getOrder() : null);
}

以ContextIdApplicationContextInitializer为例,其getOrder()方法返回的序列值为2147483637
在这里插入图片描述

2> 再看AnnotationAwareOrderComparator#findOrder()方法:

  • 如果通过OrderComparator#findOrder()获取不到序列值,则通过findOrderFromAnnotation()方法从@Order注解中获取序列值。
@Override
@Nullable
protected Integer findOrder(Object obj) {
    Integer order = super.findOrder(obj);
    if (order != null) {
        return order;
    }
    return findOrderFromAnnotation(obj);
}

以ConfigurationWarningsApplicationContextInitializer为例:
在这里插入图片描述

findOrderFromAnnotation()方法中通过OrderUtils.getOrderFromAnnotations(element, annotations);获取@Order注解中的值:
在这里插入图片描述
OrderUtils.getOrderFromAnnotations(element, annotations);方法返回之后,如果order为null,则直接返回null。
在这里插入图片描述
最后返回到OrderComparator#getOrder()方法,如果order为null,则将Order设置为Integer.MAX_VALUE
在这里插入图片描述
如果两个对象的Order序列值一样,则按原本在集合中的顺序先后排列。

1)总述

利用List集合自身的排序,通过传入自定义的Comparator 实现排序规则。规则具体如下:

  • AnnotationAwareOrderComparator类继承自OrderComparator,排序规则体现在OrderComparator类中的compare()方法;
  • 每个排序对象都会通过OrderComparator#getOrder()方法获取排列的序列值。
  • getOrder()方法中首先通过findOrder()方法查找序列值,而AnnotationAwareOrderComparator重写了findOrder()方法。所以调用findOrder()方法会先进入到AnnotationAwareOrderComparator#findOrder()方法。
  • 在AnnotationAwareOrderComparator#findOrder()方法中,会先调用其父类OrderComparator#findOrder()方法判断对象是否实现Ordered接口 并 重写了getOrder()方法,有则返回getOrder()的值。

    • 否则通过findOrderFromAnnotation()方法从对象的@Order注解中获取具体的值,如果对象没有被@Order注解标注,则返回null。
  • 最后到OrderComparator#getOrder()层面,如果findOrder()返回了具体的Integer值,则返回,否者返回Integer.MAX_VALUE。

下篇接着聊SpringBoot启动流程之SpringApplication准备阶段。

相关文章
|
3月前
|
开发框架 前端开发 网络协议
Spring Boot结合Netty和WebSocket,实现后台向前端实时推送信息
【10月更文挑战第18天】 在现代互联网应用中,实时通信变得越来越重要。WebSocket作为一种在单个TCP连接上进行全双工通信的协议,为客户端和服务器之间的实时数据传输提供了一种高效的解决方案。Netty作为一个高性能、事件驱动的NIO框架,它基于Java NIO实现了异步和事件驱动的网络应用程序。Spring Boot是一个基于Spring框架的微服务开发框架,它提供了许多开箱即用的功能和简化配置的机制。本文将详细介绍如何使用Spring Boot集成Netty和WebSocket,实现后台向前端推送信息的功能。
779 1
|
6天前
|
存储 安全 Java
Spring Boot 3 集成Spring AOP实现系统日志记录
本文介绍了如何在Spring Boot 3中集成Spring AOP实现系统日志记录功能。通过定义`SysLog`注解和配置相应的AOP切面,可以在方法执行前后自动记录日志信息,包括操作的开始时间、结束时间、请求参数、返回结果、异常信息等,并将这些信息保存到数据库中。此外,还使用了`ThreadLocal`变量来存储每个线程独立的日志数据,确保线程安全。文中还展示了项目实战中的部分代码片段,以及基于Spring Boot 3 + Vue 3构建的快速开发框架的简介与内置功能列表。此框架结合了当前主流技术栈,提供了用户管理、权限控制、接口文档自动生成等多项实用特性。
36 8
|
19天前
|
缓存 前端开发 Java
【Spring】——SpringBoot项目创建
SpringBoot项目创建,SpringBootApplication启动类,target文件,web服务器,tomcat,访问服务器
|
2月前
|
监控 Java 数据库连接
详解Spring Batch:在Spring Boot中实现高效批处理
详解Spring Batch:在Spring Boot中实现高效批处理
278 12
|
2月前
|
安全 Java 测试技术
详解Spring Profiles:在Spring Boot中实现环境配置管理
详解Spring Profiles:在Spring Boot中实现环境配置管理
111 10
|
1月前
|
负载均衡 Java 开发者
深入探索Spring Cloud与Spring Boot:构建微服务架构的实践经验
深入探索Spring Cloud与Spring Boot:构建微服务架构的实践经验
153 5
|
2月前
|
监控 IDE Java
如何在无需重新启动服务器的情况下在 Spring Boot 上重新加载我的更改?
如何在无需重新启动服务器的情况下在 Spring Boot 上重新加载我的更改?
100 8
|
2月前
|
Java 应用服务中间件
SpringBoot获取项目文件的绝对路径和相对路径
SpringBoot获取项目文件的绝对路径和相对路径
138 1
SpringBoot获取项目文件的绝对路径和相对路径
|
3月前
|
XML Java Kotlin
springboot + minio + kkfile实现文件预览
本文介绍了如何在容器中安装和启动kkfileviewer,并通过Spring Boot集成MinIO实现文件上传与预览功能。首先,通过下载kkfileviewer源码并构建Docker镜像来部署文件预览服务。接着,在Spring Boot项目中添加MinIO依赖,配置MinIO客户端,并实现文件上传与获取预览链接的接口。最后,通过测试验证文件上传和预览功能的正确性。
185 4
springboot + minio + kkfile实现文件预览
|
2月前
|
网络协议 Java
springboot配置hosts文件
springboot配置hosts文件
56 11