Spring 依赖查找

灰太狼 2024-02-18 13:37 10阅读 0赞

#### 目录 ####

*   *  单一类型依赖查找
     *  集合类型依赖查找
     *  层次性依赖查找
     *  延迟依赖查找
     *  安全依赖查找
     *  内建可查找的依赖
     *  依赖查找中的经典异常
     *  参考资料

**依赖查找是主动或手动的依赖查找方式，通常需要依赖容器或标准 API 实现**。

IoC 依赖查找大致可以分为以下几类：

*  根据 Bean 名称查找
 *  根据 Bean 类型查找
 *  根据 Bean 名称 + 类型查找
 *  根据 Java 注解查找

此外，根据查找的 Bean 对象是单一或集合对象，是否需要延迟查找等特定常见，有相应不同的 API。

### 单一类型依赖查找 ###

单一类型依赖查找接口- `BeanFactory`

*  根据 Bean 名称查找
    
     *  `getBean(String)`
     *  Spring 2.5 覆盖默认参数：`getBean(String,Object...)`
 *  根据 Bean 类型查找
    
     *  Bean 实时查找
        
         *  Spring 3.0 `getBean(Class)`
         *  Spring 4.1 覆盖默认参数：`getBean(Class,Object...)`
     *  Spring 5.1 Bean 延迟查找
        
         *  `getBeanProvider(Class)`
         *  `getBeanProvider(ResolvableType)`
 *  根据 Bean 名称 + 类型查找：`getBean(String,Class)`

### 集合类型依赖查找 ###

集合类型依赖查找接口- `ListableBeanFactory`

*  根据 Bean 类型查找
    
     *  获取同类型 Bean 名称列表
        
         *  `getBeanNamesForType(Class)`
         *  Spring 4.2 `getBeanNamesForType(ResolvableType)`
     *  获取同类型 Bean 实例列表
        
         *  `getBeansOfType(Class)` 以及重载方法
 *  通过注解类型查找
    
     *  Spring 3.0 获取标注类型 Bean 名称列表
        
         *  `getBeanNamesForAnnotation(Class<? extends Annotation>)`
     *  Spring 3.0 获取标注类型 Bean 实例列表
        
         *  `getBeansWithAnnotation(Class<? extends Annotation>)`
     *  Spring 3.0 获取指定名称+ 标注类型 Bean 实例
        
         *  `findAnnotationOnBean(String,Class<? extends Annotation>)`

### 层次性依赖查找 ###

层次性依赖查找接口- `HierarchicalBeanFactory`

*  双亲 `BeanFactory`：`getParentBeanFactory()`
 *  层次性查找
    
     *  根据 Bean 名称查找
        
         *  基于 `containsLocalBean` 方法实现
     *  根据 Bean 类型查找实例列表
        
         *  单一类型：`BeanFactoryUtils#beanOfType`
         *  集合类型：`BeanFactoryUtils#beansOfTypeIncludingAncestors`
     *  根据 Java 注解查找名称列表
        
         *  `BeanFactoryUtils#beanNamesForTypeIncludingAncestors`

### 延迟依赖查找 ###

Bean 延迟依赖查找接口

*  `org.springframework.beans.factory.ObjectFactory`
 *  `org.springframework.beans.factory.ObjectProvider`（Spring 5 对 Java 8 特性扩展）
 *  函数式接口
    
     *  `getIfAvailable(Supplier)`
     *  `ifAvailable(Consumer)`
 *  Stream 扩展- stream()

### 安全依赖查找 ###

<table> 
 <thead> 
  <tr> 
   <th>依赖查找类型</th> 
   <th>代表实现</th> 
   <th>是否安全</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>单一类型查找</td> 
   <td><code>BeanFactory#getBean</code></td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>ObjectFactory#getObject</code></td> 
   <td>否</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>ObjectProvider#getIfAvailable</code></td> 
   <td>是</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>集合类型查找</td> 
   <td><code>ListableBeanFactory#getBeansOfType</code></td> 
   <td>是</td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>ObjectProvider#stream</code></td> 
   <td>是</td> 
  </tr> 
 </tbody> 
</table>

注意：层次性依赖查找的安全性取决于其扩展的单一或集合类型的 `BeanFactory` 接口

### 内建可查找的依赖 ###

`AbstractApplicationContext` 内建可查找的依赖

<table> 
 <thead> 
  <tr> 
   <th>Bean</th> 
   <th>名称 Bean</th> 
   <th>实例使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>environment</td> 
   <td>Environment 对象</td> 
   <td>外部化配置以及 Profiles</td> 
  </tr> 
  <tr> 
   <td>systemProperties</td> 
   <td>java.util.Properties 对象</td> 
   <td>Java 系统属性</td> 
  </tr> 
  <tr> 
   <td>systemEnvironment</td> 
   <td>java.util.Map 对象</td> 
   <td>操作系统环境变量</td> 
  </tr> 
  <tr> 
   <td>messageSource</td> 
   <td>MessageSource 对象</td> 
   <td>国际化文案</td> 
  </tr> 
  <tr> 
   <td>lifecycleProcessor</td> 
   <td>LifecycleProcessor 对象</td> 
   <td>Lifecycle Bean 处理器</td> 
  </tr> 
  <tr> 
   <td>applicationEventMulticaster</td> 
   <td>ApplicationEventMulticaster 对象</td> 
   <td>Spring 事件广播器</td> 
  </tr> 
 </tbody> 
</table>

注解驱动 Spring 应用上下文内建可查找的依赖（部分）

<table> 
 <thead> 
  <tr> 
   <th>Bean 名称</th> 
   <th>Bean 实例</th> 
   <th>使用场景</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>org.springframework.context.annotation.internalConfigurationAnnotationProcessor</td> 
   <td>ConfigurationClassPostProcessor 对象</td> 
   <td>处理 Spring 配置类</td> 
  </tr> 
  <tr> 
   <td>org.springframework.context.annotation.internalAutowiredAnnotationProcessor</td> 
   <td>AutowiredAnnotationBeanPostProcessor 对象</td> 
   <td>处理<a rel="nofollow">@Autowired </a></td> 
  </tr> 
  <tr> 
   <td>以及<a rel="nofollow">@Value </a></td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>注解</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>org.springframework.context.annotation.internalCommonAnnotationProcessor</td> 
   <td>CommonAnnotationBeanPostProcessor 对象</td> 
   <td>（条件激活）处理 JSR-250 注解，如<a rel="nofollow">@PostConstruct </a></td> 
  </tr> 
  <tr> 
   <td>等</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>org.springframework.context.event.internalEventListenerProcessor</td> 
   <td>EventListenerMethodProcessor 对象</td> 
   <td>处理标注<a rel="nofollow">@EventListener </a></td> 
  </tr> 
  <tr> 
   <td>的 Spring 事件监听方法</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>org.springframework.context.event.internalEventListenerFactory</td> 
   <td>DefaultEventListenerFactory 对象</td> 
   <td><a rel="nofollow">@EventListener </a></td> 
  </tr> 
  <tr> 
   <td>事件监听方法适配为 ApplicationListener</td> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>org.springframework.context.annotation.internalPersistenceAnnotationProcessor</td> 
   <td>PersistenceAnnotationBeanPostProcessor 对象</td> 
   <td>（条件激活）处理 JPA 注解场景</td> 
  </tr> 
 </tbody> 
</table>

### 依赖查找中的经典异常 ###

`BeansException` 子类型

<table> 
 <thead> 
  <tr> 
   <th>异常类型</th> 
   <th>触发条件（举例）</th> 
   <th>场景举例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>NoSuchBeanDefinitionException</code></td> 
   <td>当查找 Bean 不存在于 IoC 容器时</td> 
   <td><code>BeanFactory#getBeanObjectFactory#getObject</code></td> 
  </tr> 
  <tr> 
   <td><code>NoUniqueBeanDefinitionException</code></td> 
   <td>类型依赖查找时，IoC 容器存在多个 Bean 实例</td> 
   <td><code>BeanFactory#getBean(Class)</code></td> 
  </tr> 
  <tr> 
   <td><code>BeanInstantiationException</code></td> 
   <td>当 Bean 所对应的类型非具体类时</td> 
   <td><code>BeanFactory#getBean</code></td> 
  </tr> 
  <tr> 
   <td><code>BeanCreationException</code></td> 
   <td>当 Bean 初始化过程中</td> 
   <td>Bean 初始化方法执行异常时</td> 
  </tr> 
  <tr> 
   <td><code>BeanDefinitionStoreException</code></td> 
   <td>当 <code>BeanDefinition</code></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>配置元信息非法时</td> 
   <td>XML 配置资源无法打开时</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

### 参考资料 ###

*  [Spring 官方文档之 Core Technologies][Spring _ Core Technologies]
 *  [《小马哥讲 Spring 核心编程思想》][Spring]

[Spring _ Core Technologies]: https://docs.spring.io/spring-framework/docs/current/spring-framework-reference/core.html#beans
[Spring]: https://time.geekbang.org/course/intro/265