SpringBoot自动配置原理解析

news2024/11/20 8:39:00

​ SpringBoot的主旨是约定大于配置,开发项目初期阶段,我们不需要做过多的配置,SpringBoot已经帮我们自动配置好了大部分的内容,比如仲裁依赖机制,自动引入需要的依赖,自动配置等内容。让我们能够将更多的精力放在业务逻辑上,那么,它是如何实现自动配置的呢?

​ 首先我们可以看到,在SpringBoot的启动类上,有一个@SpringBootApplication的注解。

​ 接下来,我们分析这个注解。点进去,发现它主要是由以下的几个注解组合而成的。

@SpringBootConfiguration // 表示这是一个配置类
@EnableAutoConfiguration
@ComponentScan // 包扫描规则

我们挨个分析。

@SpringBootConfiguration

点进去我们发现,它就是一个Configuration

@Configuration
@Indexed
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

Spring中我们已经学过这个注解了,他代表当前是一个配置类,所以,在 SpringBootApplicaton中标注的@SpringBootConfiguration注解的作用就是标注此启动类是一个配置类。

@ComponentScan

从之前的Spring中我们也知道,这个注解表示IoC容器在进行注册的时候,从此注解中指定的方式进行包扫描,也不用过多纠结。

@EnableAutoConfiguration

@AutoConfigurationPackage // 通过主程序的所在的包名进行批量注册
@Import(AutoConfigurationImportSelector.class) //
public @interface EnableAutoConfiguration {

	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

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

	String[] excludeName() default {};

}

这个注解主要由两个注解组成。我们一一分析

  • @AutoConfigurationPackage :自动配置包

    @Import(AutoConfigurationPackages.Registrar.class) //通过主程序的所在的包名进行批量注册
    public @interface AutoConfigurationPackage {
    	String[] basePackages() default {};
    	Class<?>[] basePackageClasses() default {};
    
    }
    

    我们发现,这个注解通过@Import(AutoConfigurationPackages.Registrar.class)给IoC容器中导入了一个组件AutoConfigurationPackages.Registrar

    我们点进去发现,这是由连个方法组成的类,如下所示

    static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
    
    		@Override
    		public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
    			register(registry, new PackageImports(metadata).getPackageNames().toArray(new String[0]));
    		}
    
    		@Override
    		public Set<Object> determineImports(AnnotationMetadata metadata) {
    			return Collections.singleton(new PackageImports(metadata));
    		}
    
    	}
    

    我们将断点打到此处,然后进行Debug进行分析。

    我们发现,这个方法给容器中导入了一系列的组件

    通过Debug发现,metadata参数代表的是最原始的那个SpringBootApplication启动类

    image-20210725205925975

    通过代码我们看到,它new了一个PackageImports对象,将启动类传进去,然后调用了getPackageNames()方法得到了一个包名,debug发现,返回的包名就是我们自己项目中的包名cn.shaoxiongdu,然后我们发现它将这个包名封装到了String数组中作为参数,调用了register方法。

    所以register这个方法就是通过包名,进行组件的批量注册,也就是主程序类所在的包。所以这就是为什么默认的包扫描规则是主程序类所在的包。

    所以注解EnableAutoConfiguration的第一部分,AutoConfigurationPackage的作用就是通过主程序的所在的包名进行批量注册,我们接下来看第二个注解。

  • @Import(AutoConfigurationImportSelector.class)

    我们发现,这是一个类,点进去,发现了主要的方法如下

    @Override
    	public String[] selectImports(AnnotationMetadata annotationMetadata) {
    		if (!isEnabled(annotationMetadata)) {
    			return NO_IMPORTS;
    		}
    		AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
    		return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
    	}
    

    通过方法名称发现这个方法返回了我们需要给容器中注册的bean名称的数组。那么我们的重点就在这里。

    AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata); //我们需要给容器中注册的bean名称的数组
    

    点进去这个方法,我们继续分析这个方法。

    protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    		if (!isEnabled(annotationMetadata)) {
    			return EMPTY_ENTRY;
    		}
    		AnnotationAttributes attributes = getAttributes(annotationMetadata);
    		List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes); // 获取所有的需要注册的候选组件
    		configurations = removeDuplicates(configurations); // 移除重复的组件
    		Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    		checkExcludedClasses(configurations, exclusions);
    		configurations.removeAll(exclusions);
    		configurations = getConfigurationClassFilter().filter(configurations);
    		fireAutoConfigurationImportEvents(configurations, exclusions);
    		return new AutoConfigurationEntry(configurations, exclusions);
    	}
    

    通过Debug我们发现,执行到了第7行的时候configurations这个List中已经有了一百多个bean的名称,之后的操作就是对List集合进行一些常规处理并返回。

    image-20210725212042406

    所以我们只需要分析第6行这个方法getCandidateConfigurations(annotationMetadata, attributes);

    是它返回了我们需要给容器中默认注册的bean的名称的字符数组。

    我们重新Debug,进入方法

    protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    		List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
    				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;
    	}
    

    通过分析,我们发现主要的流程在2行,通过工厂模式加载需要注册的容器集合。

    继续Debug进去此方法

    public static List<String> loadFactoryNames(Class<?> factoryType, @Nullable ClassLoader classLoader) {
            ClassLoader classLoaderToUse = classLoader;
            if (classLoader == null) {
                classLoaderToUse = SpringFactoriesLoader.class.getClassLoader();
            }
    
            String factoryTypeName = factoryType.getName();
            return (List)loadSpringFactories(classLoaderToUse).getOrDefault(factoryTypeName, Collections.emptyList()); //返回需要注册的组件集合
        }
    

    重点在最后一行,通过loadSpringFactories方法返回了对应的集合。

    继续Debug进去此方法

    private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
            Map<String, List<String>> result = (Map)cache.get(classLoader); 
            if (result != null) {
                return result;
            } else {
                HashMap result = new HashMap(); 
    
                try {
                    Enumeration urls = classLoader.getResources("META-INF/spring.factories");
    
                    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[] factoryImplementationNames = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                            String[] var10 = factoryImplementationNames;
                            int var11 = factoryImplementationNames.length;
    
                            for(int var12 = 0; var12 < var11; ++var12) {
                                String factoryImplementationName = var10[var12];
                                ((List)result.computeIfAbsent(factoryTypeName, (key) -> {
                                    return new ArrayList();
                                })).add(factoryImplementationName.trim());
                            }
                        }
                    }
    
                    result.replaceAll((factoryType, implementations) -> {
                        return (List)implementations.stream().distinct().collect(Collectors.collectingAndThen(Collectors.toList(), Collections::unmodifiableList));
                    });
                    cache.put(classLoader, result);
                    return result;
                } catch (IOException var14) {
                    throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var14);
                }
            }
        }
    

    这个方法,就是返回了需要注册的组件集合。我们分析此方法即可。

    首先,debug发现,代码来到了第6行,创建了一个HashMap。然后在try里边,我们发现它加载了一个资源文件META-INF/spring.factories,并且是循环的扫描所有依赖中的此文件。通过查看,我们发现,大部分的依赖都有这个文件,少部分的没有。

    image-20210725222133111

    我们打开spring-boot-autoconfiguration依赖,打开他的spring.factories文件

    有一个key为org.springframework.boot.autoconfigure.EnableAutoConfiguration的项

    image-20210725222546632

    值都叫XXXConfiguration。一个XXXConfiguration对应一个依赖的自动配置类

    也就是说,在spring-boot-autoconfiguration依赖spring.factories文件里面写死了spring-boot一启动就要给容器中加载的所有配置类,而我们运行下面的主方法

    public static void main(String[] args) {
    
            //返回IoC容器
            ConfigurableApplicationContext run = SpringApplication.run(Springboot01HelloApplication.class, args);
            
            int beanDefinitionCount = run.getBeanDefinitionCount();
            System.out.println("beanDefinitionCount = " + beanDefinitionCount);
    
        }
    

    发现结果只有143个。

    image-20210725223820792

    也就是说,不是所有的组件都会被注册到容器中,通过查看此依赖中的部分配置类,我们发现,

    image-20210725224121170

    大部分的类都会有@Conditional注解,也就是说注册在容器中有条件的,并不是一定会被加载。只有条件满足才会被加载。

结论

  • 对于我们自定义的组件:

    • 通过@AutoConfigurationPackage注解
    • 最终调用register(registry, new PackageImports(metadata).getPackageNames();方法,得到启动类的包下的组件进行循环注册。
  • 对于其他的组件:

    • SpringBoot先加载所有的自动配置类 xxxxxAutoConfiguration
    • 每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值。xxxxProperties里面拿。xxxProperties和配置文件进行了绑定
    • 条件满足则注册到容器中
    • 定制化配置
      • 用户直接自己@Bean替换底层的组件
      • 用户去看这个组件是获取的配置文件什么值就去修改。

xxxxxAutoConfiguration —> 组件 —> xxxxProperties里面拿值 ----> application.properties

以上就是SpringBoot的自动配置功能的底层原理了,抛砖引玉,欢迎大家指出不足。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/502293.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

2023年6款程序员常用IDE工具推荐

IDE是“集成开发环境”的缩写&#xff0c;是一种软件应用程序&#xff0c;旨在为程序员提供一个集成的工作环境&#xff0c;使他们可以编写、测试和调试代码&#xff0c;同时提供各种辅助工具&#xff0c;以提高开发效率和质量。 通常包含了一个代码编辑器&#xff0c;能够在代…

AI ChatGpt使用工具

1、OpenAi 这个使用注册和使用成本比较高&#xff0c;新手不建议&#xff1b;有钱滤过&#xff0c;想使用最新的模型的滤过&#xff1b; 1.1、准备工作 能访问外网&#xff1b;&#xff08;本链接不提供&#xff09;准备一个国外手机号&#xff0c;用于接受注册验证码&#xf…

数据结构——结构体 内存对齐

在C语言中&#xff0c;可以使用结构体&#xff08;Struct&#xff09;来存放一组不同类型的数据。结构体是一种集合&#xff0c;它里面包含了多个变量或数组&#xff0c;它们的类型可以相同&#xff0c;也可以不同&#xff0c;每个这样的变量或数组都称为结构体的成员&#xff…

试用「ChatGPT」几周之后

冷静下来&#xff0c;不吹不黑。 01 最近半年&#xff0c;互联网一款现象级的应用诞生&#xff1a;「ChatGPT」&#xff1b; 其火爆的程度&#xff0c;不输前面的羊了个羊&#xff1b; 最初了解到ChatGPT还是春节的时候&#xff0c;但那时网上的测评还没引起足够的好奇心&…

美女诱惑来袭,你抖的过嘛~python下载

前言 嗨喽&#xff0c;大家好呀~这里是爱看美女的茜茜呐 我又又又来采集美女小姐姐了 兜兜转转还是小姐姐得我心吖~ 哈哈哈哈哈哈哈哈哈哈 目录&#xff08;想看哪里点哪里 &#x1f61d;&#xff09; 前言开发环境:思路流程: <固定公式>代码展示尾语 开发环境: 首先我…

kudu可视化工具:kudu-plus

目录 kudu kudu-plus是什么 kudu基础 分支说明 kudu-plus版本功能实现 kudu Kudu是为Apache Hadoop平台开发的列式数据库。Kudu拥有Hadoop生态系统应用程序的常见技术属性&#xff1a;它可以商用硬件上运行&#xff0c;可横向扩展&#xff0c;并支持高可用性操作。 kudu-p…

并发编程之循环屏障CyclicBarrier

文章目录 前言什么是CyclicBarrierCyclicBarrier原理CyclicBarrier VS CountDownLatchCountDownLatch图示&#xff1a;CyclicBarrier图示&#xff1a;两者的异同&#xff1a; CyclicBarrier核心源码实战演示1、创建测试demo2、创建测试用例3、查看测试结果 写在最后 前言 前面…

Ubuntu 20.04安装mysql8并配置远程访问

文章目录 一、使用apt-get安装mysql服务二、初始化mysql数据库管理员用户密码三、配置远程访问 一、使用apt-get安装mysql服务 # 更新软件源 apt-get install update# 安装mysql服务 apt-get install mysql-server# 使用mysqladmin工具查看mysql版本 mysqladmin --version# 启…

powershell定义文本,用户交互,正则表达式

定义文本 PS C:\Users\Administrator> $site"yuan" PS C:\Users\Administrator> $text"$site $(get-date) $env:windir" PS C:\Users\Administrator> $text yuan 09/16/2022 14:12:26 C:\Windows#使用单引号闭合字符串输出双引号 The site of my…

【Jeston Orin】Orin nano 8G模块使用官方系统包生成标准烧写系统测试

大家好&#xff0c;我是虎哥&#xff0c;GTC 2023上&#xff0c;NVIDIA正式推出了面向边缘AI的新一代入门款开发套件&#xff0c;Jetson Orin Nano Developer Kit。虽说只是入门套件&#xff0c;但据说相比上一代Jetson Nano有最高达80倍的性能提升&#xff01;于是我在收到包裹…

苹果ipad触控笔哪个好?平价电容笔排行榜

因为ipad本身的性能足够强大&#xff0c;所以现在已经有不少人开始使用它了。大屏幕上的教学效果很好&#xff0c;但如果只是为了用来看电视剧&#xff0c;那就没什么用了。如果你不想买一支价格昂贵的苹果电容笔&#xff0c;或只想用来做个学习笔记&#xff0c;这时&#xff0…

SpringBoot整合Nacos配置中心和注册中心

一、背景 公司项目中使用的Nacos作为服务的注册中心和配置中心&#xff0c;但是呢公司的这一套Nacos是经过封装了的&#xff0c;而且封装的不是很友好&#xff0c;想着自己搭建一套标注的Nacos配置中心和服务中心 二、Nacos配置中心和注册中心搭建 2.1 依赖引入 <!--注册…

端点中心配置

什么是桌面管理 桌面管理是管理组织内所有计算机系统的综合方法。尽管名称如此&#xff0c;桌面管理还包括监督组织内使用的笔记本电脑和其他计算设备。对于IT经理来说&#xff0c;使用户的计算机保持最新状态可能是一个挑战&#xff0c;特别是考虑到升级软件以防止安全漏洞的…

【Ubuntu18.04】Docker配置镜像源

作者主页&#xff1a;爱笑的男孩。的博客_CSDN博客-深度学习,活动,YOLO领域博主爱笑的男孩。擅长深度学习,活动,YOLO,等方面的知识,爱笑的男孩。关注算法,python,计算机视觉,图像处理,深度学习,pytorch,神经网络,opencv领域.https://blog.csdn.net/Code_and516?typeblog个人简…

【二维矩阵如何存储在一维数组中(行优先和列优先)】

列优先和行优先的性能取决于具体的硬件架构和代码访问模式。在现代计算机中,内存访问的局部性(locality of reference)对性能至关重要。局部性分为两类:时间局部性(temporal locality)和空间局部性(spatial locality)。时间局部性表示最近访问过的数据项很可能在不久的…

加拿大留学思路自理

首先先看加拿大地图 留学加拿大的思路就应该是这样的&#xff1a; 1、清楚自己的需求 比如自己是移民向&#xff0c;所以首先就应该去加拿大官方网站Immigration and citizenship - Canada.ca 因为自己是理工科&#xff0c;之前在网络上看到别人总结的信息是说BC省理工类硕士…

【C++学习】类模板

类模板语法 #include<iostream> #include<string> using namespace std; //模板并不是万能的&#xff0c;有些特定数据类型&#xff0c;需要具体化方式做特殊实现 template<class NameType,class AgeType> class person { public:person(NameType name, Age…

k-means、决策树、svm算法总结

一、k-means算法 聚类算法&#xff1a; 一种典型的 无监督 学习算法&#xff0c;主要用于将相似的样本自动归到一个类别中。 在聚类算法中根据样本之间的相似性&#xff0c;将样本划分到不同的类别中&#xff0c;对于不同的相似度计算方法&#xff0c;会得到不同的聚类结果&…

【亲测有效】GnuTLS recv error (-110): The TLS connection was non-properly terminated.

【亲测有效】GnuTLS recv error [-110]: The TLS connection was non-properly terminated. 问题描述解决方法一&#xff1a;【取消代理】方法二【如果取消代理无用】方法三【这种方法对我有效】 问题描述 fatal: unable to access ‘https://github.com/openai/CLIP.git/’: …

JMeter压力测试案例(商品超卖并发问题)

什么要对接口压测呢? 压力测试可以用来验证软件系统的稳定性和可靠性&#xff0c;在压力下测试系统的性能和稳定性&#xff0c;发现并解决潜在的问题&#xff0c;确保系统在高负载情况下不会崩溃。压力测试可以用来评估软件系统的容量和性能&#xff0c;通过模拟高负载情况下…