三万字盘点Spring/Boot的那些常用扩展点

深藏阁楼爱情的钟 2023-09-28 18:24 14阅读 0赞

Spring对于每个Java后端程序员来说肯定不陌生，日常开发和面试必备的。本文就来盘点Spring/SpringBoot常见的扩展点，同时也来看看常见的开源框架是如何基于这些扩展点跟Spring/SpringBoot整合的。

话不多说，直接进入正题。

### FactoryBean ###

提起FactoryBean，就有一道“著名”的面试题“说一说FactoryBean和BeanFactory的区别”。其实这两者除了名字有点像，没有半毛钱关系。。

![ddd6aa286f1d6b00377031b0f81b547e.jpeg][]

BeanFactory是Bean的工厂，可以帮我们生成想要的Bean，而FactoryBean就是一种Bean的类型。当往容器中注入class类型为FactoryBean的类型的时候，最终生成的Bean是用过FactoryBean的getObject获取的。

![4b0cef03523792f8a5e3debfeb1e65c1.png][]

#### 来个FactoryBean的Demo ####

定义一个UserFactoryBean，实现FactoryBean接口，getObject方法返回一个User对象

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserFactoryBean&nbsp;</code><code>implements</code>&nbsp;<code>FactoryBean&lt;User&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>User getObject()&nbsp;</code><code>throws</code>&nbsp;<code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>User user =&nbsp;</code><code>new</code>&nbsp;<code>User();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"调用 UserFactoryBean 的 getObject 方法生成 Bean:"</code>&nbsp;<code>+ user);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>user;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>Class&lt;?&gt; getObjectType() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 这个 FactoryBean 返回的Bean的类型</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>User.</code><code>class</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

测试类：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>Application { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>AnnotationConfigApplicationContext applicationContext =&nbsp;</code><code>new</code>&nbsp;<code>AnnotationConfigApplicationContext();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//将 UserFactoryBean 注册到容器中</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>applicationContext.register(UserFactoryBean.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>applicationContext.refresh();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"获取到的Bean为"</code>&nbsp;<code>+ applicationContext.getBean(User.</code><code>class</code><code>));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

结果：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>调用 UserFactoryBean 的 getObject 方法生成 Bean:com.sanyou.spring.extension.User</code><code>@396e2f39</code> <code>获取到的Bean为com.sanyou.spring.extension.User</code><code>@396e2f39</code> </td> 
 </tr> 
 </tbody> 
</table>

从结果可以看出，明明注册到Spring容器的是UserFactoryBean，但是却能从容器中获取到User类型的Bean，User这个Bean就是通过UserFactoryBean的getObject方法返回的。

#### FactoryBean在开源框架中的使用 ####

#### 1、 在Mybatis中的使用 ####

Mybatis在整合Spring的时候，就是通过FactoryBean来实现的，这也就是为什么在Spring的Bean中可以注入Mybatis的Mapper接口的动态代理对象的原因。

代码如下，省略了不重要的代码。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>MapperFactoryBean&lt;T&gt;&nbsp;</code><code>extends</code>&nbsp;<code>SqlSessionDaoSupport&nbsp;</code><code>implements</code>&nbsp;<code>FactoryBean&lt;T&gt; { </code> <code>&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>// mapper的接口类型</code> <code>&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Class&lt;T&gt; mapperInterface;</code> <code>&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>T getObject()&nbsp;</code><code>throws</code>&nbsp;<code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 通过SqlSession获取接口的动态搭理对象</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>getSqlSession().getMapper(</code><code>this</code><code>.mapperInterface);</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>Class&lt;T&gt; getObjectType() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>this</code><code>.mapperInterface;</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;</code>&nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

getObject方法的实现就是返回通过SqlSession获取到的Mapper接口的动态代理对象。

而@MapperScan注解的作用就是将每个接口对应的MapperFactoryBean注册到Spring容器的。

#### 2、在OpenFeign中的使用 ####

FeignClient接口的动态代理也是通过FactoryBean注入到Spring中的。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>class</code>&nbsp;<code>FeignClientFactoryBean&nbsp;</code><code>implements</code>&nbsp;<code>FactoryBean&lt;Object&gt;, InitializingBean, ApplicationContextAware { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// FeignClient接口类型</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>Class&lt;?&gt; type;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>Object getObject()&nbsp;</code><code>throws</code>&nbsp;<code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>getTarget();</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>Class&lt;?&gt; getObjectType() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>type;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

getObject方法是调用getTarget方法来返回的动态代理。

@EnableFeignClients注解的作用就是将每个接口对应的FeignClientFactoryBean注入到Spring容器的。

> 一般来说，FactoryBean 比较适合那种复杂Bean的构建，在其他框架整合Spring的时候用的比较多。

### @Import注解 ###

@Import注解在项目中可能不常见，但是下面这两个注解肯定常见。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Import</code><code>({SchedulingConfiguration.</code><code>class</code><code>})</code> <code>public</code>&nbsp;<code>@interface</code>&nbsp;<code>EnableScheduling { </code> <code>}</code> <code>@Import</code><code>({AsyncConfigurationSelector.</code><code>class</code><code>})</code> <code>public</code>&nbsp;<code>@interface</code>&nbsp;<code>EnableAsync { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//忽略</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

@EnableScheduling和@EnableAsync两个注解，一个是开启定时任务，一个是开启异步执行。通过这两个注解可以看出，他们都使用了@Import注解，所以真正起作用的是@Import注解。并且在很多情况下，@EnbaleXXX这种格式的注解，都是通过@Import注解起作用的，代表开启了某个功能。

#### @Import注解导入的配置类的分类 ####

@Import注解导入的配置类可以分为三种情况：

#### 第一种：配置类实现了 ImportSelector 接口 ####

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>public</code>&nbsp;<code>interface</code>&nbsp;<code>ImportSelector { </code> <code>&nbsp;&nbsp;&nbsp;</code><code>String[] selectImports(AnnotationMetadata importingClassMetadata);</code> <code>&nbsp;&nbsp;&nbsp;</code><code>@Nullable</code> <code>&nbsp;&nbsp;&nbsp;</code><code>default</code>&nbsp;<code>Predicate&lt;String&gt; getExclusionFilter() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>null</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

当配置类实现了 ImportSelector 接口的时候，就会调用 selectImports 方法的实现，获取一批类的全限定名，最终这些类就会被注册到Spring容器中。

UserImportSelector实现了ImportSelector，selectImports方法返回User的全限定名，代表吧User这个类注册容器中

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserImportSelector&nbsp;</code><code>implements</code>&nbsp;<code>ImportSelector { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String[] selectImports(AnnotationMetadata importingClassMetadata) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"调用 UserImportSelector 的 selectImports 方法获取一批类限定名"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>new</code>&nbsp;<code>String[]{ </code><code>"com.sanyou.spring.extension.User"</code><code>};</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

测试：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>// @Import 注解导入 UserImportSelector</code> <code>@Import</code><code>(UserImportSelector.</code><code>class</code><code>)</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>Application { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>AnnotationConfigApplicationContext applicationContext =&nbsp;</code><code>new</code>&nbsp;<code>AnnotationConfigApplicationContext();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//将 Application 注册到容器中</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>applicationContext.register(Application.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>applicationContext.refresh();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"获取到的Bean为"</code>&nbsp;<code>+ applicationContext.getBean(User.</code><code>class</code><code>));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

结果：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>调用 UserImportSelector 的 selectImports 方法获取一批类限定名</code> <code>获取到的Bean为com.sanyou.spring.extension.User</code><code>@282003e1</code> </td> 
 </tr> 
 </tbody> 
</table>

所以可以看出，的确成功往容器中注入了User这个Bean

#### 第二种：配置类实现了 ImportBeanDefinitionRegistrar 接口 ####

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>public</code>&nbsp;<code>interface</code>&nbsp;<code>ImportBeanDefinitionRegistrar { </code> <code>&nbsp;&nbsp;&nbsp;</code><code>default</code>&nbsp;<code>void</code>&nbsp;<code>registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry,BeanNameGenerator importBeanNameGenerator) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registerBeanDefinitions(importingClassMetadata, registry);</code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;</code><code>default</code>&nbsp;<code>void</code>&nbsp;<code>registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { </code> <code>&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

当配置类实现了 ImportBeanDefinitionRegistrar 接口，你就可以自定义往容器中注册想注入的Bean。这个接口相比与 ImportSelector 接口的主要区别就是，ImportSelector接口是返回一个类，你不能对这个类进行任何操作，但是 ImportBeanDefinitionRegistrar 是可以自己注入 BeanDefinition，可以添加属性之类的。

来个demo：

实现ImportBeanDefinitionRegistrar接口

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>UserImportBeanDefinitionRegistrar&nbsp;</code><code>implements</code>&nbsp;<code>ImportBeanDefinitionRegistrar { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, BeanNameGenerator importBeanNameGenerator) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//构建一个 BeanDefinition , Bean的类型为 User</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>AbstractBeanDefinition beanDefinition = BeanDefinitionBuilder.rootBeanDefinition(User.</code><code>class</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 设置 User 这个Bean的属性username的值为三友的java日记</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>.addPropertyValue(</code><code>"username"</code><code>,&nbsp;</code><code>"三友的java日记"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>.getBeanDefinition();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"往Spring容器中注入User"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//把 User 这个Bean的定义注册到容器中</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>registry.registerBeanDefinition(</code><code>"user"</code><code>, beanDefinition);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

测试：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 </td> 
 <td> <code>// 导入 UserImportBeanDefinitionRegistrar</code> <code>@Import</code><code>(UserImportBeanDefinitionRegistrar.</code><code>class</code><code>)</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>Application { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>AnnotationConfigApplicationContext applicationContext =&nbsp;</code><code>new</code>&nbsp;<code>Annotation</code></td> 
 </tr> 
 </tbody> 
</table>

[ddd6aa286f1d6b00377031b0f81b547e.jpeg]: https://img-blog.csdnimg.cn/img_convert/ddd6aa286f1d6b00377031b0f81b547e.jpeg
[4b0cef03523792f8a5e3debfeb1e65c1.png]: https://img-blog.csdnimg.cn/img_convert/4b0cef03523792f8a5e3debfeb1e65c1.png