程序包 org.springframework.beans.factory.support

类 StaticListableBeanFactory

    • 方法详细资料

      • addBean

        public void addBean​(String name,
                    Object bean)
        Add a new singleton bean.

        Will overwrite any existing instance for the given name.

        参数:
        name - the name of the bean
        bean - the bean instance

      • getBean

        public Object getBean​(String name)
               throws BeansException
        从接口复制的说明: BeanFactory
        Return an instance, which may be shared or independent, of the specified bean.

        This method allows a Spring BeanFactory to be used as a replacement for the Singleton or Prototype design pattern. Callers may retain references to returned objects in the case of Singleton beans.

        Translates aliases back to the corresponding canonical bean name.

        Will ask the parent factory if the bean cannot be found in this factory instance.

        指定者:
        getBean 在接口中 BeanFactory
        参数:
        name - the name of the bean to retrieve
        返回:
        an instance of the bean
        抛出:
        NoSuchBeanDefinitionException - if there is no bean with the specified name
        BeansException - if the bean could not be obtained

      • getBean

        public <T> T getBean​(String name,
                     @Nullable
                     Class<T> requiredType)
              throws BeansException
        从接口复制的说明: BeanFactory
        Return an instance, which may be shared or independent, of the specified bean.

        Behaves the same as BeanFactory.getBean(String), but provides a measure of type safety by throwing a BeanNotOfRequiredTypeException if the bean is not of the required type. This means that ClassCastException can't be thrown on casting the result correctly, as can happen with BeanFactory.getBean(String).

        Translates aliases back to the corresponding canonical bean name.

        Will ask the parent factory if the bean cannot be found in this factory instance.

        指定者:
        getBean 在接口中 BeanFactory
        参数:
        name - the name of the bean to retrieve
        requiredType - type the bean must match; can be an interface or superclass
        返回:
        an instance of the bean
        抛出:
        NoSuchBeanDefinitionException - if there is no such bean definition
        BeanNotOfRequiredTypeException - if the bean is not of the required type
        BeansException - if the bean could not be created

      • getBean

        public Object getBean​(String name,
                      Object... args)
               throws BeansException
        从接口复制的说明: BeanFactory
        Return an instance, which may be shared or independent, of the specified bean.

        Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

        指定者:
        getBean 在接口中 BeanFactory
        参数:
        name - the name of the bean to retrieve
        args - arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)
        返回:
        an instance of the bean
        抛出:
        NoSuchBeanDefinitionException - if there is no such bean definition
        BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype
        BeansException - if the bean could not be created

      • getBean

        public <T> T getBean​(Class<T> requiredType,
                     Object... args)
              throws BeansException
        从接口复制的说明: BeanFactory
        Return an instance, which may be shared or independent, of the specified bean.

        Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

        This method goes into ListableBeanFactory by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, use ListableBeanFactory and/or BeanFactoryUtils.

        指定者:
        getBean 在接口中 BeanFactory
        参数:
        requiredType - type the bean must match; can be an interface or superclass
        args - arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)
        返回:
        an instance of the bean
        抛出:
        NoSuchBeanDefinitionException - if there is no such bean definition
        BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype
        BeansException - if the bean could not be created

      • containsBean

        public boolean containsBean​(String name)
        从接口复制的说明: BeanFactory
        Does this bean factory contain a bean definition or externally registered singleton instance with the given name?

        If the given name is an alias, it will be translated back to the corresponding canonical bean name.

        If this factory is hierarchical, will ask any parent factory if the bean cannot be found in this factory instance.

        If a bean definition or singleton instance matching the given name is found, this method will return true whether the named bean definition is concrete or abstract, lazy or eager, in scope or not. Therefore, note that a true return value from this method does not necessarily indicate that BeanFactory.getBean(java.lang.String) will be able to obtain an instance for the same name.

        指定者:
        containsBean 在接口中 BeanFactory
        参数:
        name - the name of the bean to query
        返回:
        whether a bean with the given name is present

      • getAliases

        public String[] getAliases​(String name)
        从接口复制的说明: BeanFactory
        Return the aliases for the given bean name, if any.

        All of those aliases point to the same bean when used in a BeanFactory.getBean(java.lang.String) call.

        If the given name is an alias, the corresponding original bean name and other aliases (if any) will be returned, with the original bean name being the first element in the array.

        Will ask the parent factory if the bean cannot be found in this factory instance.

        指定者:
        getAliases 在接口中 BeanFactory
        参数:
        name - the bean name to check for aliases
        返回:
        the aliases, or an empty array if none
        另请参阅:
        BeanFactory.getBean(java.lang.String)

      • getBeanDefinitionCount

        public int getBeanDefinitionCount()
        从接口复制的说明: ListableBeanFactory
        Return the number of beans defined in the factory.

        Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.

        指定者:
        getBeanDefinitionCount 在接口中 ListableBeanFactory
        返回:
        the number of beans defined in the factory

      • getBeanDefinitionNames

        public String[] getBeanDefinitionNames()
        从接口复制的说明: ListableBeanFactory
        Return the names of all beans defined in this factory.

        Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.

        指定者:
        getBeanDefinitionNames 在接口中 ListableBeanFactory
        返回:
        the names of all beans defined in this factory, or an empty array if none defined

      • getBeanNamesForType

        public String[] getBeanNamesForType​(@Nullable
                                    ResolvableType type)
        从接口复制的说明: ListableBeanFactory
        Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

        NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

        Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.

        Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

        Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

        This version of getBeanNamesForType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for getBeanNamesForType(type, true, true).

        Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

        指定者:
        getBeanNamesForType 在接口中 ListableBeanFactory
        参数:
        type - the generically typed class or interface to match
        返回:
        the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
        另请参阅:
        BeanFactory.isTypeMatch(String, ResolvableType), FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)

      • getBeanNamesForType

        public String[] getBeanNamesForType​(@Nullable
                                    ResolvableType type,
                                    boolean includeNonSingletons,
                                    boolean allowEagerInit)
        从接口复制的说明: ListableBeanFactory
        Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

        NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

        Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).

        Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

        Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

        Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

        指定者:
        getBeanNamesForType 在接口中 ListableBeanFactory
        参数:
        type - the generically typed class or interface to match
        includeNonSingletons - whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)
        allowEagerInit - whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.
        返回:
        the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
        另请参阅:
        FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType, boolean, boolean)

      • getBeanNamesForType

        public String[] getBeanNamesForType​(@Nullable
                                    Class<?> type)
        从接口复制的说明: ListableBeanFactory
        Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

        NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

        Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.

        Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

        Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

        This version of getBeanNamesForType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for getBeanNamesForType(type, true, true).

        Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

        指定者:
        getBeanNamesForType 在接口中 ListableBeanFactory
        参数:
        type - the class or interface to match, or null for all bean names
        返回:
        the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
        另请参阅:
        FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)

      • getBeanNamesForType

        public String[] getBeanNamesForType​(@Nullable
                                    Class<?> type,
                                    boolean includeNonSingletons,
                                    boolean allowEagerInit)
        从接口复制的说明: ListableBeanFactory
        Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

        NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

        Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).

        Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

        Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

        Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

        指定者:
        getBeanNamesForType 在接口中 ListableBeanFactory
        参数:
        type - the class or interface to match, or null for all bean names
        includeNonSingletons - whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)
        allowEagerInit - whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.
        返回:
        the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none
        另请参阅:
        FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)

      • getBeansOfType

        public <T> Map<String,​T> getBeansOfType​(@Nullable
                                              Class<T> type)
                                       throws BeansException
        从接口复制的说明: ListableBeanFactory
        Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

        NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

        Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.

        Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beansOfTypeIncludingAncestors to include beans in ancestor factories too.

        Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

        This version of getBeansOfType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for getBeansOfType(type, true, true).

        The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.

        指定者:
        getBeansOfType 在接口中 ListableBeanFactory
        参数:
        type - the class or interface to match, or null for all concrete beans
        返回:
        a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
        抛出:
        BeansException - if a bean could not be created
        另请参阅:
        FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)

      • getBeansOfType

        public <T> Map<String,​T> getBeansOfType​(@Nullable
                                              Class<T> type,
                                              boolean includeNonSingletons,
                                              boolean allowEagerInit)
                                       throws BeansException
        从接口复制的说明: ListableBeanFactory
        Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

        NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

        Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).

        Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beansOfTypeIncludingAncestors to include beans in ancestor factories too.

        Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

        The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.

        指定者:
        getBeansOfType 在接口中 ListableBeanFactory
        参数:
        type - the class or interface to match, or null for all concrete beans
        includeNonSingletons - whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)
        allowEagerInit - whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.
        返回:
        a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values
        抛出:
        BeansException - if a bean could not be created
        另请参阅:
        FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)