Spring BeanDefinitionRegistry 接口

Spring BeanDefinitionRegistry 接口

Registry 登记/注册 顾名思义, 该接口设计的目的是用于保存和管理 Bean定义描述(BeanDefinition)
org.springframework.beans.factory.support.BeanDefinitionRegistry

1. package org.springframework.beans.factory.support;
3. import org.springframework.beans.factory.BeanDefinitionStoreException;
4. import org.springframework.beans.factory.NoSuchBeanDefinitionException;
5. import org.springframework.beans.factory.config.BeanDefinition;
6. import org.springframework.core.AliasRegistry;
8. /**
9. * Interface for registries that hold bean definitions, for example RootBeanDefinition
10. * and ChildBeanDefinition instances. Typically implemented by BeanFactories that
11. * internally work with the AbstractBeanDefinition hierarchy.
12. *
13. * Registry 登记/注册 顾名思义 该接口设计的目的是用于保存和管理 Bean定义描述(BeanDefinition), 例如:  RootBeanDefinition 和 ChildBeanDefinition 实例
14. *
15. * <p>This is the only interface in Spring's bean factory packages that encapsulates
16. * <i>registration</i> of bean definitions. The standard BeanFactory interfaces
17. * only cover access to a <i>fully configured factory instance</i>.
18. *
19. * <p>Spring's bean definition readers expect to work on an implementation of this
20. * interface. Known implementors within the Spring core are DefaultListableBeanFactory
21. * and GenericApplicationContext.
22. *
23. * @author Juergen Hoeller
24. * @since 26.11.2003
25. * @see org.springframework.beans.factory.config.BeanDefinition
26. * @see AbstractBeanDefinition
27. * @see RootBeanDefinition
28. * @see ChildBeanDefinition
29. * @see DefaultListableBeanFactory
30. * @see org.springframework.context.support.GenericApplicationContext
31. * @see org.springframework.beans.factory.xml.XmlBeanDefinitionReader
32. * @see PropertiesBeanDefinitionReader
33. */
34. public interface BeanDefinitionRegistry extends AliasRegistry {
36.         /**
37.          * Register a new bean definition with this registry.
38.          * Must support RootBeanDefinition and ChildBeanDefinition.
39.          *
40.          * 根据名称注册一个新的 BeanDefinition
41.          * @param beanName the name of the bean instance to register
42.          * @param beanDefinition definition of the bean instance to register
43.          * @throws BeanDefinitionStoreException if the BeanDefinition is invalid
44.          * @throws BeanDefinitionOverrideException if there is already a BeanDefinition
45.          * for the specified bean name and we are not allowed to override it
46.          * @see GenericBeanDefinition
47.          * @see RootBeanDefinition
48.          * @see ChildBeanDefinition
49.          */
50.         void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
51.                         throws BeanDefinitionStoreException;
53.         /**
54.          * Remove the BeanDefinition for the given name.
55.          *
56.          * 根据名称移除一个 BeanDefinition
57.          * @param beanName the name of the bean instance to register
58.          * @throws NoSuchBeanDefinitionException if there is no such bean definition
59.          */
60.         void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
62.         /**
63.          * Return the BeanDefinition for the given bean name.
64.          *
65.          * 根据名称获取 BeanDefinition
66.          * @param beanName name of the bean to find a definition for
67.          * @return the BeanDefinition for the given name (never {@code null})
68.          * @throws NoSuchBeanDefinitionException if there is no such bean definition
69.          */
70.         BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
72.         /**
73.          * Check if this registry contains a bean definition with the given name.
74.          * 检查给定名称是否已存在
75.          * @param beanName the name of the bean to look for
76.          * @return if this registry contains a bean definition with the given name
77.          */
78.         boolean containsBeanDefinition(String beanName);
80.         /**
81.          * Return the names of all beans defined in this registry.
82.          * @return the names of all beans defined in this registry,
83.          * or an empty array if none defined
84.          */
85.         String[] getBeanDefinitionNames();
87.         /**
88.          * Return the number of beans defined in the registry.
89.          * @return the number of beans defined in the registry
90.          */
91.         int getBeanDefinitionCount();
93.         /**
94.          * Determine whether the bean definition for the given name is overridable,
95.          * i.e. whether {@link #registerBeanDefinition} would successfully return
96.          * against an existing definition of the same name.
97.          * <p>The default implementation returns {@code true}.
98.          *
99.          *  判定给定的名称是否允许覆盖它的 BeanDefinition
100.          *
101.          * @param beanName the name to check
102.          * @return whether the definition for the given bean name is overridable
103.          * @since 6.1
104.          */
105.         default boolean isBeanDefinitionOverridable(String beanName) {
106.                 return true;
107.         }
109.         /**
110.          * Determine whether the given bean name is already in use within this registry,
111.          * i.e. whether there is a local bean or alias registered under this name.
112.          * @param beanName the name to check
113.          * @return whether the given bean name is already in use
114.          */
115.         boolean isBeanNameInUse(String beanName);
116. }

复制代码

DefaultListableBeanFactory 的实现

大多数情况下, 我们项目的 BeanFactory 的实例是 DefaultListableBeanFactory, 它也是一个 BeanDefinitionRegistry
org.springframework.beans.factory.support.DefaultListableBeanFactory#registerBeanDefinition

1. public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFactory  
2.        implements ConfigurableListableBeanFactory, BeanDefinitionRegistry, Serializable {
3.       
4.       
5.        .........
6.        
7.         /**
8.          * 注册一个 BeanDefinition 的方法
9.          */
10.         @Override
11.         public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
12.                         throws BeanDefinitionStoreException {
14.                 Assert.hasText(beanName, "Bean name must not be empty");
15.                 Assert.notNull(beanDefinition, "BeanDefinition must not be null");
17.                 if (beanDefinition instanceof AbstractBeanDefinition abd) {
18.                         try {
19.                                 abd.validate();
20.                         }
21.                         catch (BeanDefinitionValidationException ex) {
22.                                 throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
23.                                                 "Validation of bean definition failed", ex);
24.                         }
25.                 }
26.                 // 获取一下是否有这个 bean 的 BeanDefinition
27.                 BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
28.                 if (existingDefinition != null) {
29.                         // 如果有 且 不允许覆盖, 则抛出 BeanDefinitionOverrideException
30.                         if (!isBeanDefinitionOverridable(beanName)) {
31.                                 throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
32.                         }
33.                         else if (existingDefinition.getRole() < beanDefinition.getRole()) {
34.                                 // e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
35.                                 if (logger.isInfoEnabled()) {
36.                                         logger.info("Overriding user-defined bean definition for bean '" + beanName +
37.                                                         "' with a framework-generated bean definition: replacing [" +
38.                                                         existingDefinition + "] with [" + beanDefinition + "]");
39.                                 }
40.                         }
41.                         else if (!beanDefinition.equals(existingDefinition)) {
42.                                 if (logger.isDebugEnabled()) {
43.                                         logger.debug("Overriding bean definition for bean '" + beanName +
44.                                                         "' with a different definition: replacing [" + existingDefinition +
45.                                                         "] with [" + beanDefinition + "]");
46.                                 }
47.                         }
48.                         else {
49.                                 if (logger.isTraceEnabled()) {
50.                                         logger.trace("Overriding bean definition for bean '" + beanName +
51.                                                         "' with an equivalent definition: replacing [" + existingDefinition +
52.                                                         "] with [" + beanDefinition + "]");
53.                                 }
54.                         }
55.                         this.beanDefinitionMap.put(beanName, beanDefinition);
56.                 }
57.                 else {
58.                         if (isAlias(beanName)) {
59.                                 //判断下, 别名是否覆盖.
60.                                 String aliasedName = canonicalName(beanName);
61.                                 if (!isBeanDefinitionOverridable(aliasedName)) {
62.                                         if (containsBeanDefinition(aliasedName)) {  // alias for existing bean definition
63.                                                 throw new BeanDefinitionOverrideException(
64.                                                                 beanName, beanDefinition, getBeanDefinition(aliasedName));
65.                                         }
66.                                         else {  // alias pointing to non-existing bean definition
67.                                                 throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
68.                                                                 "Cannot register bean definition for bean '" + beanName +
69.                                                                 "' since there is already an alias for bean '" + aliasedName + "' bound.");
70.                                         }
71.                                 }
72.                                 else {
73.                                         removeAlias(beanName);
74.                                 }
75.                         }
76.                         if (hasBeanCreationStarted()) {
77.                                 //bean 是否已经开始创建中. 后面再研究, 不是这个分支
78.                                 // Cannot modify startup-time collection elements anymore (for stable iteration)
79.                                 synchronized (this.beanDefinitionMap) {
80.                                         this.beanDefinitionMap.put(beanName, beanDefinition);
81.                                         List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
82.                                         updatedDefinitions.addAll(this.beanDefinitionNames);
83.                                         updatedDefinitions.add(beanName);
84.                                         this.beanDefinitionNames = updatedDefinitions;
85.                                         removeManualSingletonName(beanName);
86.                                 }
87.                         }
88.                         else {
89.                                 // 放到 beanDefinitionMap, key 是 beanName; value 是 beanDefinition;
90.                                 // Still in startup registration phase
91.                                 this.beanDefinitionMap.put(beanName, beanDefinition);
92.                                 // 别名 添加到 beanDefinitionNames
93.                                 this.beanDefinitionNames.add(beanName);
94.                                 removeManualSingletonName(beanName);
95.                         }
96.                         this.frozenBeanDefinitionNames = null;
97.                 }
99.                 if (existingDefinition != null || containsSingleton(beanName)) {
100.                         resetBeanDefinition(beanName);
101.                 }
102.                 else if (isConfigurationFrozen()) {
103.                         clearByTypeCache();
104.                 }
105.         }
106.         /**
107.          * 移除一个 BeanDefinition 的方法
108.          */
109.         @Override
110.         public void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException {
111.                 Assert.hasText(beanName, "'beanName' must not be empty");
113.                 //从 beanDefinitionMap 中移除
114.                 BeanDefinition bd = this.beanDefinitionMap.remove(beanName);
115.                 if (bd == null) {
116.                         if (logger.isTraceEnabled()) {
117.                                 logger.trace("No bean named '" + beanName + "' found in " + this);
118.                         }
119.                         throw new NoSuchBeanDefinitionException(beanName);
120.                 }
121.                 //bean 是否已经开始创建中
122.                 if (hasBeanCreationStarted()) {
123.                         // Cannot modify startup-time collection elements anymore (for stable iteration)
124.                         synchronized (this.beanDefinitionMap) {
125.                                 List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames);
126.                                 updatedDefinitions.remove(beanName);
127.                                 this.beanDefinitionNames = updatedDefinitions;
128.                         }
129.                 }
130.                 else {
131.                         //从 beanDefinitionNames 中移除
132.                         // Still in startup registration phase
133.                         this.beanDefinitionNames.remove(beanName);
134.                 }
135.                 this.frozenBeanDefinitionNames = null;
137.                 resetBeanDefinition(beanName);
138.         }
139.     ........

复制代码

对于 DefaultListableBeanFactory 的实现主要就是使用两个集合存起来:

1.         /**
2.          * 这个 Map 存储所有已注册 BeanDefinition, 其中 key是bean主要name, value 是 BeanDefinition
3.          */
4.         private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);
6.         /**  
7.          * 这个list 存储所有的 bean definition 名称  
8.          */  
9.         private volatile List<String> beanDefinitionNames = new ArrayList<>(256);
10.        

复制代码

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！