【微服务十三】源码深度剖析SpringBoot启动流程中开启OpenFeign的入口(ImportBeanDefinitionRegistrar详解)

本文涉及的产品
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
云原生网关 MSE Higress,422元/月
注册配置 MSE Nacos/ZooKeeper,118元/月
简介: 【微服务十三】源码深度剖析SpringBoot启动流程中开启OpenFeign的入口(ImportBeanDefinitionRegistrar详解)

一、前言

最近在研究OpenFeign源码时,@EnableFeignClients注解中会通过@Import注解导入一个ImportBeanDefinitionRegistrar接口的实现类FeignClientsRegistrar,出于好奇又回头研究了一下SpringBoot启动流程中处理@Import的逻辑,在此记录一下。

我们在SpringBoot启动流程系列聊了以下内容:

1> 《SpringBoot启动流程一》:万字debug梳理SpringBoot如何加载并处理META-INF/spring.factories文件中的信息
2> 《SpringBoot启动流程二》:七千字源码分析SpringApplication构造阶段
3> 《SpringBoot启动流程三》:两万+字图文带你debug源码分析SpringApplication准备阶段(含配置文件加载时机、日志系统初始化时机)
4> 《SpringBoot启动流程四》:图文带你debug源码分析SpringApplication运行阶段和运行后阶段
5> 《SpringBoot启动流程五》:你真的知道SpringBoot自动装配原理吗(两万字图文源码分析)
6> SpringBoot自动装配时做条件装配的原理
7> 源码分析SpringBoot如何内嵌并启动Tomcat服务器的

《SpringBoot启动流程五》:你真的知道SpringBoot自动装配原理吗(两万字图文源码分析);一文中我们聊了在哪里会解析@Import注解,并处理其中自动装配相关的内容(即DeferredImportSelector接口的实现类),本文我们接着讨论如何处理@Import注解导入的ImportBeanDefinitionRegistrar接口实现类。

二、ImportBeanDefinitionRegistrar介绍

ImportBeanDefinitionRegistrar是spring对外提供的动态注册beanDefinition的接口,并且spring内部大多也用该接口动态注册beanDefinition。

  1. ImportBeanDefinitionRegistrar接口的Bean不会直接注册到IOC容器,它的执行时机比较早,发生在SpringBoot启动流程的注册BeanDefinition时;
  2. ImportBeanDefinitionRegistrar接口提供了registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry)供子类重写;

    • 开发者可以直接调用BeanDefinitionRegistry#registerBeanDefinition()方法传入BeanDefinitionName和对应的BeanDefinition对象,直接往Spring临时容器(beanDefinitionMap)中注册。
    • 所谓的Spring临时容器是指:在Spring解析类时会将所有符合注册要求的类放到一个临时容器中,后续执行完BeanPostProcessor、initMessageSource、initApplicationEventMulticaster、onRefresh等操作之后,才会从临时容器中取出所有类,真正注入到Spring容器(singletonObjects)中。

在这里插入图片描述

此外,ImportBeanDefinitionRegistrar 通常和@Import注解配合使用,@Import注解将ImportBeanDefinitionRegistrar的实现类注入到@Import所属根类的ConfigurationClass属性中,在注册跟类的BeanDefinition时,会遍历调用其@Import的所有ImportBeanDefinitionRegistrar接口的 registerBeanDefinitions()方法。

三、ImportBeanDefinitionRegistrar在SpringBoot启动流程中的体现?

建议大家先把SpringBoot启动流程系列看完,然后再看这里,不然有可能会存在一些困惑。

1、处理ImportBeanDefinitionRegistrar的入口

在SpringBoot启动流程中,通过ConfigurationClassParser#doProcessConfigurationClass()解析启动类的注解时,会做@Import注解的process操作,即进入到ConfigurationClassParser#processImports()方法;

具体代码执行流程参考博文:《SpringBoot启动流程五》:你真的知道SpringBoot自动装配原理吗(两万字图文源码分析)

另外debug的项目是我们在OpenFeign系列中的案例(SpringCloud之Feign实现声明式客户端负载均衡详细案例)。

2、将ImportBeanDefinitionRegistrar添加到所属ConfigClass的一个属性上

进入到ConfigurationClassParser#processImports()方法中,就启动类FeignConsumerApplication而言,它直接或间接一共@Import了三个类,分别如下:

在这里插入图片描述

其中FeignClientsRegistrar实现了ImportBeanDefinitionRegistrar接口,FeignClientsRegistrar类图如下:
在这里插入图片描述

下面接着看processImports()方法针对ImportBeanDefinitionRegistrar接口的具体处理逻辑;
在这里插入图片描述

processImports()方法中会判断如果一个类A实现了ImportBeanDefinitionRegistrar接口,会对类A做实例化,并将其存储到当前ConfigClass的一个属性(Map类型的变量importBeanDefinitionRegistrars)中,以在注册ConfigurationClass到Spring容器时,拿出importBeanDefinitionRegistrars中的所有内容,执行每个ImportBeanDefinitionRegistrar的registerBeanDefinitions()方法。

FeignClientsRegistrar而言,会将其添加到启动类FeignConsumerApplication属性中,具体添加过程如下:

在这里插入图片描述

到这里,@Import的内容解析也就结束了,后面会根据@Import解析出的内容再做处理(即:执行ImportBeanDefinitionRegistrar接口方法)。

3、执行ImportBeanDefinitionRegistrar接口方法的时机

解析完所有的candidates候选类之后,会进入到ConfigurationClassBeanDefinitionReader#loadBeanDefinitions(Set<ConfigurationClass>)方法对所有的ConfigurationClass做条件装配、属性处理,然后将相应BeanDefinition注册到Spring中。
在这里插入图片描述

代码执行流程如下:

在这里插入图片描述

代码逻辑解释:

在加载并注册启动类的BeanDefinition时,会将启动类ConfigurationClass下的一些属性进行解析处理,其中就包括对@Import的所有 ImportBeanDefinitionRegistrar接口方法进行执行。

FeignClientsRegistrar而言,其实现的ImportBeanDefinitionRegistrar接口方法执行流程如下:

在这里插入图片描述
这里逻辑就很简单,ImportBeanDefinitionRegistrar接口提供了一个“模板方法”供子类实现。

最后走到FeignClientsRegistrar中,也就进入到了开启OpenFeign的入口

四、后续文章

本篇文章我们讨论了在SpringBoot启动流程中开启OpenFeign的入口,下一篇文章,我们接着讨论OpenFeign如何扫描所有的FeignClient?如何生成FeignClient的代理类?

相关文章
|
18天前
|
前端开发 Java
表白墙/留言墙 —— 初级SpringBoot项目,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
文章通过一个表白墙/留言墙的初级SpringBoot项目实例,详细讲解了如何进行前后端开发,包括定义前后端交互接口、创建SpringBoot项目、编写前端页面、后端代码逻辑及实体类封装的全过程。
45 3
表白墙/留言墙 —— 初级SpringBoot项目,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
|
18天前
|
前端开发 Java 数据安全/隐私保护
用户登录前后端开发(一个简单完整的小项目)——SpringBoot与session验证(带前后端源码)全方位全流程超详细教程
文章通过一个简单的SpringBoot项目,详细介绍了前后端如何实现用户登录功能,包括前端登录页面的创建、后端登录逻辑的处理、使用session验证用户身份以及获取已登录用户信息的方法。
71 2
用户登录前后端开发(一个简单完整的小项目)——SpringBoot与session验证(带前后端源码)全方位全流程超详细教程
|
4天前
|
JavaScript Java 关系型数据库
自主版权的Java诊所管理系统源码,采用Vue 2、Spring Boot等技术栈,支持二次开发
这是一个自主版权的Java诊所管理系统源码,支持二次开发。采用Vue 2、Spring Boot等技术栈,涵盖患者管理、医生管理、门诊管理、药店管理、药品管理、收费管理、医保管理、报表统计及病历电子化等功能模块。
|
14天前
|
Java Docker 微服务
SpringBoot微服务打包Docker镜像
SpringBoot微服务打包Docker镜像
45 11
|
10天前
|
NoSQL Java Redis
shiro学习四:使用springboot整合shiro,正常的企业级后端开发shiro认证鉴权流程。使用redis做token的过滤。md5做密码的加密。
这篇文章介绍了如何使用Spring Boot整合Apache Shiro框架进行后端开发,包括认证和授权流程,并使用Redis存储Token以及MD5加密用户密码。
16 0
shiro学习四:使用springboot整合shiro,正常的企业级后端开发shiro认证鉴权流程。使用redis做token的过滤。md5做密码的加密。
|
16天前
|
XML Java 应用服务中间件
【Spring】运行Spring Boot项目,请求响应流程分析以及404和500报错
【Spring】运行Spring Boot项目,请求响应流程分析以及404和500报错
101 2
|
18天前
|
前端开发 Java 数据库连接
表白墙/留言墙 —— 中级SpringBoot项目,MyBatis技术栈MySQL数据库开发,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
本文是一份全面的表白墙/留言墙项目教程,使用SpringBoot + MyBatis技术栈和MySQL数据库开发,涵盖了项目前后端开发、数据库配置、代码实现和运行的详细步骤。
24 0
表白墙/留言墙 —— 中级SpringBoot项目,MyBatis技术栈MySQL数据库开发,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学
|
11天前
|
JSON 前端开发 JavaScript
优雅!Spring Boot 3.3 实现职责链模式,轻松应对电商订单流程
本文介绍如何使用 Spring Boot 3.3 实现职责链模式,优化电商订单处理流程。通过将订单处理的各个环节(如库存校验、优惠券核验、支付处理等)封装为独立的处理器,并通过职责链将这些处理器串联起来,实现了代码的解耦和灵活扩展。具体实现包括订单请求类 `OrderRequest`、抽象处理器类 `OrderHandler`、具体处理器实现(如 `OrderValidationHandler`、`VerifyCouponHandler` 等)、以及初始化职责链的配置类 `OrderChainConfig`。
|
11天前
|
机器学习/深度学习 移动开发 自然语言处理
基于人工智能技术的智能导诊系统源码,SpringBoot作为后端服务的框架,提供快速开发,自动配置和生产级特性
当身体不适却不知该挂哪个科室时,智能导诊系统应运而生。患者只需选择不适部位和症状,系统即可迅速推荐正确科室,避免排错队浪费时间。该系统基于SpringBoot、Redis、MyBatis Plus等技术架构,支持多渠道接入,具备自然语言理解和多输入方式,确保高效精准的导诊体验。无论是线上医疗平台还是大型医院,智能导诊系统均能有效优化就诊流程。
|
1月前
|
安全 应用服务中间件 API
微服务分布式系统架构之zookeeper与dubbo-2
微服务分布式系统架构之zookeeper与dubbo-2