SpringBoot自动配置原理

最新推荐文章于 2022-12-25 15:55:18 发布

长安代号007

最新推荐文章于 2022-12-25 15:55:18 发布

阅读量247

点赞数 5

本文链接：https://blog.csdn.net/m0_67656219/article/details/127164742

版权

一、寻找核心文件(点击--- pom.xml)的一个父依赖

点击 [spring-boot-starter-parent] 进入

<parent>
 <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>2.7.3</version>

        <relativePath/>
</parent>

二、点击进入后发现里面除了一些插件和配置文件的格式之外，还存在一个依赖。

依赖：[<artifactId>spring-boot-dependencies</artifactId>]

核心依赖在【父工程】中，在写或者引入一些SpringBoot依赖的时候，不需要指定版本，因为已经有了版本仓库。另外我们还可以看到，在父依赖中也帮我们写好了资源库，不用我们自己再去配置了。

<modelVersion>4.0.0</modelVersion>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-dependencies</artifactId>
  <version>2.7.3</version>
  <packaging>pom</packaging>
  <name>spring-boot-dependencies</name>
  <description>Spring Boot Dependencies</description>

继续点击进入，里面放了很多的依赖和依赖的版本号。由于这个文件实在太多了，所以这里只展示一部分。

<artifactId>spring-boot-starter-web</artifactId>

自动导入web环境所有的依赖。

SpringBoot会将所有的功能场景都变成一个个的启动器，需要使用什么功能，只需要找到相对应的启动器就可以。

我们来看看启动器中存放了一些什么内容：

以 <artifactId>spring-boot-starter</artifactId> 为例

其中存放了自动配置相关的依赖、日志相关依赖、还有注解等依赖，这些依赖我们只需要导入一个spring-boor-starter就可以直接将其全部引入，而不需要再像以前那样逐个导入了。

SpringBoot会将所有的功能场景都封装成一个一个的启动器，供开发人员使用。

SpringApplication.run()方法会将Springboot应用启动

走进【SpringBootApplication】核心注解

点击[@SpringBootApplication] ---> 找到两大核心注解

[@SpringBootConfiguration](Springboot配置) && [@EnableAutoConfiguration](自动配置)

-----------------进行@SpringBootConfiguration源代码分析---------------

点击[@SpringBootConfiguration]进入，我们会看到有3个元注解和一个Configuration配置注解。实际上：SpringBootConfiguration其实就携带了一个@Configuration注解，也就是一个Spring的配置类。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

---------------进行@EnableAutoCongifuration源代码分析-----------

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};

    String[] excludeName() default {};
}

同样点击进入，在 EnableAutoConfiguration这个接口上，我们会看到有4个元注解、一个自动配置包类、还有一个Import({AutoConfigurationImportSelector.class}),这是自动导入包的核心。

点击[AutoConfigurationImportSelector]自动导入选择器。↓↓↓↓↓↓

-------------------- 第1层关系分析-------------------------

protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata)

【获得自动配置的实体】

和它同级的还有

List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);

获取候选的配置/// 点击进入

 protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
        List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
        Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
        return configurations;
    }

实际上它返回了一个List，这个List是由loadFactoryNames()方法返回的,其中传入了一个getSpringFactoriesLoaderFactoryClass()，我们可以看看这个方法的内容。↓↓↓↓↓↓

protected Class<?> getSpringFactoriesLoaderFactoryClass() { return EnableAutoConfiguration.class; }

这个方法标注了 EnableAutoConfiguration注解的类。

在方法里面有EnableAutoConfiguration，它实际上返回的就是标注了这个类的所有包。标注了这个类的包就是@SpringBootApplication

所以我们可以得出结论：它走了这么多，就是为了将启动类所需的所有资源导入。

-------------------- 第2层关系分析-------------------------

点击 [List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());] 获取所有的加载配置 进入

 public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
        String factoryTypeName = factoryType.getName();
        return (List)loadSpringFactories(classLoader).getOrDefault(factoryTypeName, Collections.emptyList());
    }

-------------------- 第3层关系分析-------------------------

点击 protected List<AutoConfigurationImportFilter> getAutoConfigurationImportFilters() { return SpringFactoriesLoader.loadFactories(AutoConfigurationImportFilter.class, this.beanClassLoader); } 获取所有的资源 进入

private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
        MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);
        if (result != null) {
            return result;
        } else {
            try {
                Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
                LinkedMultiValueMap result = new LinkedMultiValueMap();

                while(urls.hasMoreElements()) {
                    URL url = (URL)urls.nextElement();
                    UrlResource resource = new UrlResource(url);
                    Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                    Iterator var6 = properties.entrySet().iterator();

                    while(var6.hasNext()) {
                        Entry<?, ?> entry = (Entry)var6.next();
                        String factoryTypeName = ((String)entry.getKey()).trim();
                        String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                        int var10 = var9.length;

                        for(int var11 = 0; var11 < var10; ++var11) {
                            String factoryImplementationName = var9[var11];
                            result.add(factoryTypeName, factoryImplementationName.trim());
                        }
                    }
                }

                cache.put(classLoader, result);
                return result;
            } catch (IOException var13) {
                throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
            }
        }
    }

注意，这里是获取资源的两种路径方式

classLoader.getResources("META-INF/spring.factories") ---获取项目资源

ClassLoader.getSystemResources("META-INF/spring.factories");---获取系统资源

"META-INF/spring.factories"，从这里获取配置