spring之BeanDefinitionRegistry分析

今天药忘吃喽~ 2023-01-17 07:42 115阅读 0赞

## 1：写在前面 ##

我们定义bean时不管是通过java config方式，还是xml配置文件的方式，最终都会[解析成BeanDefinition][BeanDefinition]，而`这些BeanDefinition`都需要注册到容器中，这个注册的过程是通过接口`org.springframework.beans.factory.support.BeanDefinitionRegistry`来定义的，该接口也正是本文我们要分析的API，先来看下类图：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70]  
其中顶层接口是`org.springframework.core.AliasRegistry`，用于bean别名的管理，我们就从这个接口的分析开始。

## 2：AliasRegistry ##

该接口定义了别名注册相关的能力，源码如下：

org.springframework.core.AliasRegistry
    // 别名管理的公共接口，作为BeanDefinitionRegistry的父接口
    public interface AliasRegistry { 
    
    	// 给name注册一个别名alias
    	void registerAlias(String name, String alias);
    
    	// 删除别名
    	void removeAlias(String alias);
    
    	// 检测name是否是一个别名名称
    	boolean isAlias(String name);
    
    	// 返回指定标准bean名称的所有的别名的数组，如果没有则返回空数组
    	String[] getAliases(String name);
    
    }

## 3：BeanDefinitionRegistry ##

定义Bean定义注册相关操作的接口，其实现类主要是`org.springframework.beans.factory.BeanFactory`,如`DefaultListableBeanFactory`,`GenericApplicationContext`，源码如下：

org.springframework.beans.factory.support.BeanDefinitionRegistry
    
    // 定义bean定义的注册相关方法的接口
    public interface BeanDefinitionRegistry extends AliasRegistry { 
    
    	// 在注册中心注册一个bean定义，必须支持RootBeanDefinition和ChildBeanDefinition
    	void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
    			throws BeanDefinitionStoreException;
    
    	// 移除对应bean名称的bean定义
    	void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
    
    	// 返回给定bean名称对应的bean定义
    	BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
    
    	// 检查注册中心是否包含指定名称的bean定义
    	boolean containsBeanDefinition(String beanName);
    
    	// 返回注册中心中所有的bean定义的名称的数组
    	String[] getBeanDefinitionNames();
    
    	// 返回注册中心中bean定义的个数
    	int getBeanDefinitionCount();
    
    	// 返回beanName是否被占用，即已经在注册中心中注册了bean定义
    	boolean isBeanNameInUse(String beanName);
    }

## 4：SimpleBeanDefinitionRegistry ##

全类名为`org.springframework.beans.factory.support.SimpleBeanDefinitionRegistry`,是BeanDefinitionRegistry的简单实现类，源码如下：

// BeanDefinitionRegistry接口的简单实现类，提供了注册的能力，但不具备工厂能力
    public class SimpleBeanDefinitionRegistry extends SimpleAliasRegistry implements BeanDefinitionRegistry { 
    
    	// beanName->BeanDefinition的Map
    	private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(64);
    	
    	// 注册beandefinition
    	@Override
    	public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
    			throws BeanDefinitionStoreException { 
    
    		Assert.hasText(beanName, "'beanName' must not be empty");
    		Assert.notNull(beanDefinition, "BeanDefinition must not be null");
    		// beanName为key，beandefinition为value，存储
    		this.beanDefinitionMap.put(beanName, beanDefinition);
    	}
    
    	// 删除beandefinition
    	@Override
    	public void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException { 
    		if (this.beanDefinitionMap.remove(beanName) == null) { 
    			throw new NoSuchBeanDefinitionException(beanName);
    		}
    	}
    
    	// 获取beandefinition
    	@Override
    	public BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException { 
    		BeanDefinition bd = this.beanDefinitionMap.get(beanName);
    		if (bd == null) { 
    			throw new NoSuchBeanDefinitionException(beanName);
    		}
    		return bd;
    	}
    
    	// 是否包含名称为beanName的beandefinition
    	@Override
    	public boolean containsBeanDefinition(String beanName) { 
    		return this.beanDefinitionMap.containsKey(beanName);
    	}
    
    	// 获取所有的beanName数组
    	@Override
    	public String[] getBeanDefinitionNames() { 
    		return StringUtils.toStringArray(this.beanDefinitionMap.keySet());
    	}
    
    	// 获取beandefinition的个数
    	@Override
    	public int getBeanDefinitionCount() { 
    		return this.beanDefinitionMap.size();
    	}
    
    	// beanName是否在使用中
    	@Override
    	public boolean isBeanNameInUse(String beanName) { 
    		return isAlias(beanName) || containsBeanDefinition(beanName);
    	}
    
    }

## 5：DefaultListableBeanFactory ##

在拥有了beandefinition注册能力的同时，因为也实现了`org.springframework.beans.factory.BeanFactory`接口，所以也具有bean工厂的能力，我们来分别看下是如何实现注册和移除beandefinition的。

### 5.1：注册beandefinition ###

org.springframework.beans.factory.support.DefaultListableBeanFactory#registerBeanDefinition
    public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
    			throws BeanDefinitionStoreException { 
    
    	// ...省略不重要逻辑...
    	else {  // 不存在名称为beanName的beandefinition
    		if (hasBeanCreationStarted()) { 
    			synchronized (this.beanDefinitionMap) { 
    				// beanName->beandefinition放到map中
    				this.beanDefinitionMap.put(beanName, beanDefinition);
    				// 设置信息的beanName集合
    				List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
    				updatedDefinitions.addAll(this.beanDefinitionNames);
    				updatedDefinitions.add(beanName);
    				this.beanDefinitionNames = updatedDefinitions;
    				removeManualSingletonName(beanName);
    			}
    		}
    		else { 
    			// beanName->beandefinition放到map中
    			this.beanDefinitionMap.put(beanName, beanDefinition);
    			// 添加beanName
    			this.beanDefinitionNames.add(beanName);
    			removeManualSingletonName(beanName);
    		}
    		this.frozenBeanDefinitionNames = null;
    	}
    
    	if (existingDefinition != null || containsSingleton(beanName)) { 
    		resetBeanDefinition(beanName);
    	}
    	else if (isConfigurationFrozen()) { 
    		clearByTypeCache();
    	}
    }

### 5.2：移除beandefinition ###

org.springframework.beans.factory.support.DefaultListableBeanFactory#removeBeanDefinition
    public void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException { 
    		Assert.hasText(beanName, "'beanName' must not be empty");
    	// 根据bean名称查询beandefinition
    	BeanDefinition bd = this.beanDefinitionMap.remove(beanName);
    	if (bd == null) { 
    		if (logger.isTraceEnabled()) { 
    			logger.trace("No bean named '" + beanName + "' found in " + this);
    		}
    		throw new NoSuchBeanDefinitionException(beanName);
    	}
    
    	if (hasBeanCreationStarted()) { 
    		synchronized (this.beanDefinitionMap) { 
    			List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames);
    			// 从所有beanname名称集合中移除，注意这里不从map中移除
    			updatedDefinitions.remove(beanName);
    			// 设置新的beanname集合
    			this.beanDefinitionNames = updatedDefinitions;
    		}
    	}
    	else { 
    		// 从所有beanname名称集合中移除，注意这里不从map中移除
    		this.beanDefinitionNames.remove(beanName);
    	}
    	this.frozenBeanDefinitionNames = null;
    
    	resetBeanDefinition(beanName);
    }

## 6：GenericApplicationContext ##

该类对于beandefinition的注册和移除都是委托给DefaultListableBeanFactory来实现的，因此这里仅贴下代码：

org.springframework.context.support.GenericApplicationContext#registerBeanDefinition
    public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
    			throws BeanDefinitionStoreException { 
    
    	this.beanFactory.registerBeanDefinition(beanName, beanDefinition);
    }
    org.springframework.context.support.GenericApplicationContext#removeBeanDefinition
    public void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException { 
    	this.beanFactory.removeBeanDefinition(beanName);
    }

[BeanDefinition]: https://blog.csdn.net/wang0907/article/details/114016448
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dhbmcwOTA3_size_16_color_FFFFFF_t_70]: /images/20221021/f4f642ac36554d3e9d8789dfc949ba6a.png