Spring源码笔记之SpringIOC--（5）BeanFactory的扩展之ListableBeanFactory

BeanFactory的扩展之ListableBeanFactory

先引用BeanFactory的类继承关系图来看一下ListableBeanFactory的位置

在spring中我们可能会有获取所有bean的需求，但是BeanFactory设计只提供了获取单个Bean的能力，为了额外提供获取所有bean(List Beans)的能力，定义了ListableBeanFactory，即是一个可列举的BeanFactory。这样设计的目的在于不是所有的BeanFactory都需要提供遍历bean的能力，但是这是一个比较常用的能力。

``ListableBeanFactory`源码如下：

public interface ListableBeanFactory extends BeanFactory {
    // 是否包含指定名称的BeanDefinition
    boolean containsBeanDefinition(String beanName);
    
    // 获取所有BeanDefinition的数量
    int getBeanDefinitionCount();
    
    // 获取所有BeanDefinition的名字
    String[] getBeanDefinitionNames();
   
    
    // 获取指定类型bean的Provider
    // allowEagerInit主要是解决FactoryBean的情况。若为false，只会去检查FactoryBean本身,若为true，FactoryBean本身和它的产生的对象都会被检查匹配
    <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType, boolean allowEagerInit);
    // 获取ResolvableType指定的bean的Provider
    <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType, boolean allowEagerInit);
     // 获取ResolvableType指定的bean名字
    String[] getBeanNamesForType(ResolvableType type);
    
    // 获取ResolvableType指定的bean名字
    // includeNonSingletons是否包括单例
    String[] getBeanNamesForType(ResolvableType type, boolean includeNonSingletons, boolean allowEagerInit);
        
    // 获取指定类型的bean名称与实例
    <T> Map<String, T> getBeansOfType(@Nullable Class<T> type) throws BeansException;
    
    // 获取指定类型的bean名称与实例
    <T> Map<String, T> getBeansOfType(@Nullable Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) throws BeansException;
    
    // 获取指定注解的bean名称
   	String[] getBeanNamesForAnnotation(Class<? extends Annotation> annotationType); 
    
    // 获取指定注解的bean名称与实例
    Map<String, Object> getBeansWithAnnotation(Class<? extends Annotation> annotationType) throws BeansException;

    // 查找指定Bean名称与注解类型的bean
    <A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType) throws NoSuchBeanDefinitionException;
    
    // 查找指定Bean名称与注解类型的bean
	<A extends Annotation> A findAnnotationOnBean(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit) throws NoSuchBeanDefinitionException;
    
    // 查找指定Bean名称与注解类型的bean
    <A extends Annotation> Set<A> findAllAnnotationsOnBean(String beanName, Class<A> annotationType, boolean allowFactoryBeanInit)
        throws NoSuchBeanDefinitionException;
    
}

注意一个BeanFactory同时实现了HierarchicalBeanFactory和ListableBeanFactory，那ListableBeanFactory中获取所有bean的操作会不会去父容器parentBeanFactory中搜索呢？答案是不会。

ListableBeanFactory中注释说明了这种场景，ListableBeanFactory只会对获取当前BeanFactory中的所有bean，可以使用BeanFactoryUtils工具类实现递归搜索父容器所有bean的诉求。

/** 
 * <p>If this is a {@link HierarchicalBeanFactory}, the return values will <i>not</i>
 * take any BeanFactory hierarchy into account, but will relate only to the beans
 * defined in the current factory. Use the {@link BeanFactoryUtils} helper class
 * to consider beans in ancestor factories too.
 */