Springboot的自动装配解读

news2024/10/7 19:27:10

目录

1.Springboot的自动装配

1.1 组件装配

1.1.1 组件

1.2 Spring Framework 的模块装配

1.2.1 @Import注解

1.2.2 BeanDefinition 

1.3 Spring Framework 的条件装配

1.3.1 @Profile

1.3.2 @Conditional 

1.3.3 MetaData元数据接口(补充)

AnnotatedTypeMetadata

AnnotationMetadata

MethodMetadata

 1.4 SPI机制

1.5 Springboot 的装配机制


1.Springboot的自动装配

1.1 组件装配

Spring Framework本身有一个IOC容器,该容器会统一管理其中的Bean对象,Bean对象可以理解为组件,要理解组件装配,首先要理解组件的概念。

1.1.1 组件

基于Spring Framework 的应用在整合第三方技术时,要把第三方框架中的核心API配置到Spring Framework的配置文件或注解配置类中,以供Spring Framework统一管理。此处的配置是关键,通过编写XML配置文件或注解配置类,将第三方框架中的核心API以对象的形式注册到IOC容器中。这些核心API对象会在适当的位置发挥其作用,以支撑项目的正常运行。IOC容器中的核心API对象本身就是一个个的bean对象,即组件;将核心API配置到XML配置文件或注解配置类的行为称为组件装配。

Spring Framework本身只有-一种组件装配方式,即手动装配,而Spring Boot基于原生的手动装配,通过模块装配+条件装配+SPI机制,可以完美实现组件的自动装配。手动装配指的是开发者在项目中通过编写XML配置文件、注解配置类、配合特定等方式将所需的组件注册到IOC容器中, 即ApplicationContext中。Springboot中的核心特性是组件的自动装配,自动装配的核心是,本应该由开发者编写的配置,转为框架自动根据项目中整合的场景依赖,合理地做出判断并装配合适的Bean到IOC容器中。

1.2 Spring Framework 的模块装配

1.2.1 @Import注解

可以参考 Springboot 核心注解和基本配置解读_山河亦问安的博客-CSDN博客

1.2.2 BeanDefinition 

BeanDefinition 是定义 Bean 的配置元信息接口,这里举例通过BeanDefinition来进行Bean对象的创建。代码如下:

   DefaultListableBeanFactory defaultListableBeanFactory = new DefaultListableBeanFactory();
        BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class).addPropertyValue("username", "admin");
        defaultListableBeanFactory.registerBeanDefinition("user01",beanDefinitionBuilder.getBeanDefinition());
        User user01 = defaultListableBeanFactory.getBean("user01", User.class);
        System.out.println(user01);

        RootBeanDefinition beanDefinition = new RootBeanDefinition(User.class);
        //构造参数
        ConstructorArgumentValues constructorArgumentValues = new ConstructorArgumentValues();
        constructorArgumentValues.addIndexedArgumentValue(0, "root");
        beanDefinition.setConstructorArgumentValues(constructorArgumentValues);
        defaultListableBeanFactory.registerBeanDefinition("user02", beanDefinition);
        User user2 = defaultListableBeanFactory.getBean("user02", User.class);
        System.out.println(user2);

1.3 Spring Framework 的条件装配

1.3.1 @Profile

@Profile 注解可以标注在组件上,当一个配置属性激活的时候,它才会起作用。Profile提供了一种基于环境的配置,根据当前项目的不同运行的环境,可以动态的注册与当前运行环境匹配的组件。

使用@Profile:

@Profile("test")
public class User {
    private String username;
}

为ApplicationContext 设置Profile

 AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
        annotationConfigApplicationContext.getEnvironment().setActiveProfiles("test");
        annotationConfigApplicationContext.register(User.class);
        annotationConfigApplicationContext.refresh();
        User bean = annotationConfigApplicationContext.getBean(User.class);
        System.out.println(bean);

AnnotationConfigApplicationContext 在创建对象的时候,如果直接传入了配置类,则会立即初始化IOC容器,在不传入配置类的情况下,内部不会执行初始化逻辑,而是要等到手动调用其refresh方法后才会初始化IOC容器,在初始化的过程中会顺便将环境配置一并处理。

1.3.2 @Conditional 

 可以参考 Springboot 核心注解和基本配置解读_山河亦问安的博客-CSDN博客

 判断是否存在的条件判断类:

public class MyConditional implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return context.getBeanFactory().containsBeanDefinition(Admin.class.getName());
    }
}

上面的matches方法中使用BeanDefinition而不是Bean做判断,这是因为考虑的是当条件匹配时Admin对象可能尚未创建,导致条件匹配出现偏差。

1.3.3 MetaData元数据接口(补充)

元数据是关于数据的数据,元数据是数据的描述和上下文,它有助于组织,查找,理解和使用数据。

AnnotatedTypeMetadata

这个接口表示的是注解元素(AnnotatedElement)的元数据,只要能在上面标注注解的元素都属于注解元素。

public interface AnnotatedTypeMetadata {

    // 此元素是否标注有此注解,annotationName:注解全类名
    boolean isAnnotated(String annotationName);

    //取得指定类型注解的所有的属性 - 值(k-v)
    // annotationName:注解全类名
    // classValuesAsString:若是true表示 Class用它的字符串的全类名来表示。这样可以避免Class被提前加载
    @Nullable
    Map<String, Object> getAnnotationAttributes(String annotationName);
    @Nullable
    Map<String, Object> getAnnotationAttributes(String annotationName, boolean classValuesAsString);

}
AnnotationMetadata

它是ClassMetadataAnnotatedTypeMetadata的子接口,具有两者共同能力,并且新增了访问注解的相关方法。可以简单理解为它是对注解的抽象。

public interface AnnotationMetadata extends ClassMetadata, AnnotatedTypeMetadata {
 
	//拿到当前类上所有的注解的全类名(注意是全类名)
	Set<String> getAnnotationTypes();
	// 拿到指定的注解类型
	//annotationName:注解类型的全类名
	Set<String> getMetaAnnotationTypes(String annotationName);
	
	// 是否包含指定注解 (annotationName:全类名)
	boolean hasAnnotation(String annotationName);
	//这个厉害了,用于判断注解类型自己是否被某个元注解类型所标注
	//依赖于AnnotatedElementUtils#hasMetaAnnotationTypes
	boolean hasMetaAnnotation(String metaAnnotationName);
	
	// 类里面只有有一个方法标注有指定注解,就返回true
	//getDeclaredMethods获得所有方法, AnnotatedElementUtils.isAnnotated是否标注有指定注解
	boolean hasAnnotatedMethods(String annotationName);
	// 返回所有的标注有指定注解的方法元信息。注意返回的是MethodMetadata 原理基本同上
	Set<MethodMetadata> getAnnotatedMethods(String annotationName);
}
MethodMetadata
public interface MethodMetadata extends AnnotatedTypeMetadata {
    //方法名
	String getMethodName();
    //定义方法的类全限定名
	String getDeclaringClassName();
    //返回的值全限定名
	String getReturnTypeName();
}

MetadataReader  

public interface MetadataReader {

    /**
     * 返回class文件的IO资源引用
     */
    Resource getResource();

    /**
     * 为基础class读取基本类元数据,返回基础类的元数据。
     */
    ClassMetadata getClassMetadata();

    /**
     *为基础类读取完整的注释元数据,包括注释方法的元数据。返回基础类的完整注释元数据
     */
    AnnotationMetadata getAnnotationMetadata();
}

 MetadataReaderFactory

MetadataReaderFactory接口 ,MetadataReader的工厂接口。允许缓存每个MetadataReader的元数据集。

public interface MetadataReaderFactory {
    /**
     * 根据class名称创建MetadataReader
     */
    MetadataReader getMetadataReader(String className) throws IOException;

    /**
     * 根据class的Resource创建MetadataReader
     */
    MetadataReader getMetadataReader(Resource resource) throws IOException;

}

 1.4 SPI机制

Spring中的SPI相较于JDK原生的SPI更加的高级实用,因为它不仅限于接口或者抽象类,可以是任何一个类,接口和注解。在Springboot中大量用到SPI机制加载自动配置类和特殊组件。

声明SPI文件

将SPI文件放在项目的META-INF目录下,且文件名必须为spring.factories。代码如下:

com.example.demo.entity.User=\
com.example.demo.entity.User

spring.factories中被检索的类,接口和注解的全限定名作为key,具体要检索的类的全限定名作为value,多个类之间用逗号进行分割。

测试获取

  List<User> users = SpringFactoriesLoader.loadFactories(User.class, Demo2Application.class.getClassLoader());
        for (User user : users) {
            System.out.println(user);
        }

1.5 Springboot 的装配机制

Springboot中的自动装配其实就是模块装配+条件装配+SPI机制的组合使用

@SpringbootApplication的组成可以参考  Springboot 核心注解和基本配置解读_山河亦问安的博客-CSDN博客

这里主要讲解@EnableAutoConfiguration,点开@EnableAutoConfiguration注解

@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 {};
}

@AutoConfigurationPackage注解本身组合了一个@Import注解

@Import({AutoConfigurationPackages.Registrar.class})

@AutoConfiguration注解所做的是将主启动类所在的包记录下来,注册到AutoConfigurationPackages中。在Springboot 2.3.0版本后,注解中多了两个属性,可以手动指定应用的根包路径,如下:

 String[] basePackages() default {};

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


简单介绍了@AutoConfigurationPackage 注解本身,下面把目标转移到导人的内部类
AutoConfigurationPackages.Registrar.class上。 Registrar本身是一ImportBeanDefinitionRegistrar,它的作用是以编程式向IOC 容器中注册 bean对象,而Registrar 要注册的对象实际上是默认主启动类所在的包路径(也就是@AutoConfiqurationPackage注解要记录的根包)。Registrar代码如下:

 static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {
        Registrar() {
        }
        public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
            AutoConfigurationPackages.register(registry, (String[])(new PackageImports(metadata)).getPackageNames().toArray(new String[0]));
        }
    }

 debug如下:


 
注意register方法的第二个参数,它利用PackageImports导出了一组包名.而包名的来源是一个AnnotationMetadata,这个AnnotationMetadata本质上可以理解为AutoConfiaurationPackage 注解本身。换句话说,这个 PackageImports类提取出@AutoConfigurationPackage 注解中定义的两个属性( baserackages与basePackageClasses)。实际上源码也是如此,它做了一个约定大于配置的设计,PackageImports的构造方法中会先提取注解中的这两个属性,如果两个属性都没有定义会提取主启动类所在的包名。

@Import({AutoConfigurationImportSelector.class}):

将AutoConfigurationImportSelector这个类导入到spring容器中,AutoConfigurationImportSelector可以帮助springboot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IOC容器(ApplicationContext)中。主干逻辑只有三步:加载自动配置类,移除被去掉的自动配置类,封装Entry返回。这里加载自动配置类的动作就是利用 Spring Framework 的 SPI机制.从spring.factories中提取出所有@EnableAutoConfiguration对应的配置值。可以通过三种途径移除被去掉的自动配置类:@springBootApplication或@EnableAutoConfiguration 注解的exclude、excludeName属性,以及全局配置文件的spring.autoconfigure.exclude 属性配置。底层源码会提取出这三个位置配置的自动配置类并移除。代码如下:

 protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
        if (!this.isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        } else {
            //加载注解属性配置
            AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
            //加载自动配置类
            List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
           //获取显式配置了要移除的自动配置类
            configurations = this.removeDuplicates(configurations);
            Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
            this.checkExcludedClasses(configurations, exclusions); 
            //移除要删除的自动配置类
            configurations.removeAll(exclusions);
            configurations = this.getConfigurationClassFilter().filter(configurations);
            this.fireAutoConfigurationImportEvents(configurations, exclusions);
            return new AutoConfigurationEntry(configurations, exclusions);
        }
    }

springboot底层实现自动配置的步骤是:
1.@SpringBootApplication起作用;
2.@EnableAutoConfiguration;
3.@AutoConfigurationPackage:这个组合注解主要是@Import(AutoConfigurationPackages.Registrar.class),它通过将Registrar类导入到容器中,而Registrar类作用是扫描主配置类同级目录以及子包,并将相应的组件导入到springboot创建管理的容器中;
4.@Import(AutoConfigurationImportSelector.class):它通过将AutoConfigurationImportSelector类导入到容器中,AutoConfigurationImportSelector类作用是通过selectImports方法实现将配置类信息交给SpringFactory加载器进行一系列的容器创建过程。

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

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

相关文章

4、离线数仓数据同步策略(全量表数据同步、增量表数据同步、首日同步、采集通道脚本)

1、离线数仓同步数据 1.1 用户行为数据同步 1.1.1 数据通道 用户行为数据由Flume从Kafka直接同步到HDFS&#xff0c;由于离线数仓采用Hive的分区表按天统计&#xff0c;所以目标路径要包含一层日期。具体数据流向如下图所示。 1.1.2 日志消费Flume配置概述 按照规划&…

【选择排序】手撕八大排序之直接选择排序和堆排序

目录 一.选择排序 1.直接选择排序 2.堆排序 一.选择排序 1.直接选择排序 选择排序&#xff08;Selection Sort&#xff09;是一种简单直观的排序算法。它的基本思想是每次遍历找到最小&#xff08;或最大&#xff09;的元素&#xff0c;然后将其放置在已排序序列的末尾。在…

实操接口自动化测试项目之项分层设计

本文以笔者当前使用的自动化测试项目为例&#xff0c;浅谈分层设计的思路&#xff0c;不涉及到具体的代码细节和某个框架的实现原理&#xff0c;重点关注在分层前后的使用对比&#xff0c;可能会以一些伪代码为例来说明举例。 接口测试三要素&#xff1a; 参数构造发起请求&a…

JS 1.如何实现继承 2.原型和原型链

1_使用class实现继承 /** 继承 */ class Person { constructor(name) { this.name name;}drink() { console.log(喝水)} }class Student extends Person{ constructor(name, score) { // new Personsuper(name);this.score score;}introduce() { console.log(我是${this.nam…

EasyCVR播放设备录像出现部分视频不能播放的原因排查与解决

EasyCVR视频融合平台基于云边端协同架构&#xff0c;具有强大的数据接入、处理及分发能力。平台支持多协议接入&#xff0c;包括&#xff1a;国标GB28181、RTMP、RTSP/Onvif、海康Ehome、海康SDK、大华SDK、宇视SDK等&#xff0c;对外可分发多格式视频流&#xff0c;包括RTSP、…

栈和队列(二) 队列的实现,用栈实现队列,用队列实现栈,设计循环队列

文章目录 队列的实现用队列实现栈用栈实现队列设计循环队列 队列的实现 这里的队列我们使用链式队列&#xff0c;好处就是可以很方便的取出队头的元素。 使用顺序队列取出队头元素所花费的时间复杂度为O&#xff08;N&#xff09;&#xff0c;把后面的元素向前移动一个下标所花…

CentOS Linux的最佳替代方案(二)_AlmaLinux OS 8.6基础安装教程

文章目录 CentOS Linux的最佳替代方案&#xff08;二&#xff09;_AlmaLinux OS 8.6基础安装教程一 AlmaLinux介绍和发展历史二 AlmaLinux基础安装2.1 下载地址2.2 安装过程 三 AlmaLinux使用3.1 关闭selinux/firewalld3.2 替换默认源3.3 安装一些必要工具 CentOS Linux的最佳替…

瓶盖扫码回收APP系统 废旧物品创造价值收益

资源回收再利用是近些年国家大力倡导的&#xff0c;人们也在积极践行&#xff0c;从垃圾回收、废旧衣物回收、烟盒回收等等.....今天小白要带大家了解的是瓶盖回收APP软件开发的相关事项。瓶盖回收APP是本着资源回收的初衷&#xff0c;可以时间废旧瓶盖的多次利用&#xff0c;减…

使用Xshell服务器跑程序,用pycharm连接服务器远程开发

目标&#xff1a; 1.使用Xshell在服务器上创建自己项目需要的虚拟环境 2.用pycharm实现远程服务器的连接&#xff08;这样就可以在本地debug或者写代码&#xff0c;然后再用xshell在服务器上跑&#xff09; 一、使用Xshell在服务器上创建自己项目需要的虚拟环境 1.打开Xshe…

工具系列之wireshark使用说明

简介 工具下载&#xff1a; https://www.wireshark.org/官方FAQ: https://www.wireshark.org/faq.html 过滤器设置 通常情况下&#xff0c;将.pcap 数据拖拽至 wireshark中即可打开。通过&#xff1a; 导航栏–》分析 --> 显示过滤器 即可找到对应的筛选器&#xff0c;筛…

美格智能发布高性价比5G RedCap CPE解决方案SRT835,加速5G FWA商业落地

6月30日&#xff0c;在MWC 2023上海5G未来峰会上&#xff0c;美格智能重磅发布高性价比轻量化5G RedCap&#xff08;也称作NR-Light&#xff09;CPE解决方案SRT835。该方案搭载骁龙X35调制解调器及射频系统和WCN6856高速Wi-Fi 6解决方案&#xff0c;通过精简系统架构&#xff0…

【技术教程】H.265网页流媒体播放器EasyPlayer无感知播放体验优化

EasyPlayer是我们流媒体组件系列中关注度较高的产品&#xff0c;经过多年的发展和迭代&#xff0c;目前已经有多个应用版本&#xff0c;包括RTSP版、RTMP版、Pro版&#xff0c;以及js版&#xff0c;其中js版本作为网页播放器&#xff0c;受到了用户的广泛使用。 目前我们所有的…

【每天40分钟,我们一起用50天刷完 (剑指Offer)】第十天 10/50

专注 效率 记忆 预习 笔记 复习 做题 欢迎观看我的博客&#xff0c;如有问题交流&#xff0c;欢迎评论区留言&#xff0c;一定尽快回复&#xff01;&#xff08;大家可以去看我的专栏&#xff0c;是所有文章的目录&#xff09;   文章字体风格&#xff1a; 红色文字表示&#…

初探 C++ 标准库

有趣的重载 重载左移操作符&#xff0c;将变量或常量左移到一个对象中&#xff01; C 标准库 C 标准库并不是 C 语言的一部分 C 标准库是由类库和函数库组成的集合 C 标准库中定义的类和对象都位于 std 命名空间中 C 标准库的头文件都不带 .h 后缀 C 标准库涵盖了 C 库的功…

优思学院|什么是六西格玛黑带?

六西格玛黑带&#xff0c;这是一个有趣的称谓。这个称号意味着拥有它的人在六西格玛方法和统计工具应用方面有很高的造诣。在企业中&#xff0c;只有中层以上的人才能获得这个称号。 黑带这个词源自跆拳道&#xff0c;因为跆拳道最高段位的人所戴的腰带是黑色的。后来&#xf…

『赠书活动 | 第十三期』《算力经济:从超级计算到云计算》

&#x1f497;wei_shuo的个人主页 &#x1f4ab;wei_shuo的学习社区 &#x1f310;Hello World &#xff01; 『赠书活动 &#xff5c; 第十三期』 本期书籍&#xff1a;《算力经济&#xff1a;从超级计算到云计算》 赠书规则&#xff1a;评论区&#xff1a;点赞&#xff5c;收…

多个el-checkbox-group复选框组 选项互斥

需求 多个el-checkbox-group复选框组 , 组与组之间的选项是互斥的效果效果 代码实现 template <template><div class"page"><el-checkbox-groupv-for"(item, index) in list"v-model"item.checked":key"index"chan…

网络投票链接的制作方法投票制作方法微网络投票

用户在使用微信投票的时候&#xff0c;需要功能齐全&#xff0c;又快捷方便的投票小程序。 而“活动星投票”这款软件使用非常的方便&#xff0c;用户可以随时使用手机微信小程序获得线上投票服务&#xff0c;很多用户都很喜欢“活动星投票”这款软件。 “活动星投票”小程序在…

docker-compose部署Minio

一、镜像选择 Minio有很多镜像会有一些bug&#xff0c;而且不好解决&#xff0c;这里使用的是镜像 RELEASE.2021-04-18T19-26-29Z 直接: docker pull minio/minio:RELEASE.2021-04-18T19-26-29Z 即可&#xff1a; 拉取之后可以打个tag&#xff0c;这里是new2 RELEASE.2021…

在chrome-console中进行xpath/css/js定位(六)

目录 1.xpath 1.1 绝对定位与相对定位 1.2 通配符与不包含筛选 1.3 Xpath函数运算的简单实用 1.4 各种亲戚标签的定位 1.5xpath实例 1.5.1xpath:属性定位 1.5.2xpath:其它属性 1.5.3xpath:标签 1.5.4xpath:层级 1.5.5xpath:索引 1.5.6xpath:逻辑运算 1.5.7xpath:模…