为什么需要BeanDefinition
我们在使用spring的时候，首先都会在xml或通过注解去定义一个bean，之后在IOC容器（ApplicationContext）创建一个bean的时，都会去寻找这些bean定义的配置内容，那这些配置内容的封装就是通过BeanDefinition来实现的。
BeanDefinition是在IOC容器初始化的时候创建的，也就是调用AbstractApplicationContext.refresh()方法触发，创建的过程一般分下面三个步骤：
- Bean配置资源的定位。这一步主要是依赖DefaultResourceLoader接口，通过此接口IOC容器可以从不同的位置以特定的方式去加载bean配置。DefaultResourceLoader接口是有许多不同实现的，像熟知的
ClassPathXmlApplicationContext，是从工程的根目录去寻找配置；FileSystemXmlApplicationContext，是从文件系统中去寻找配置。完成这一步，就相当于着我们想喝水就要先把井找到。 - BeanDefinition的载入。这一步是将配置资源转化成IOC容器可以理解的BeanDefinition，也就是bean的抽象，可以让IOC容器很方便的管理对象的定义和生成。这一步，就是用桶把水打上来。
- BeanDefinition的注册。这一步是将BeanDefinition注册到IOC容器（实际上就是把它放到容器中的一个Map里），之后在获取bean时，IOC容器可以查找到BeanDefinition并进行处理。这一步，就是把桶里的水装到碗里，为以后各个来想喝水的人提供资源。
Resource定位
我们以ClassPathXmlApplicationContext为例，来分析一下整个BeanDefinition的创建流程。
//一切开始的地方
public ClassPathXmlApplicationContext(
String[] configLocations/*配置文件位置*/, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
super(parent);
setConfigLocations(configLocations);
if (refresh) {
//IOC容器初始化，我们进入到这个方法
refresh();
}
}
refresh()方法是在AbstractApplicationContext中实现的，它定义了IOC容器初始化的一些流程，其中调用了obtainFreshBeanFactory()这个方法，这个方法里又调用refreshBeanFactory()方法，此方法内部才是BeanDefinition真正创建的地方。
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
customizeBeanFactory(beanFactory);
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
在refreshBeanFactory()这个方法当中，它构建了一个DefaultListableBeanFactory容器，这个容器对BeanDefinition的载入和注册有很大关系，之后我们在说。
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// 为给定的BeanFactory创建新的XmlBeanDefinitionReader。
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
// 对环境信息和ResourceLoader注入，ResourceLoader的具体实现还是要看
beanDefinitionReader.setEnvironment(this.getEnvironment());
beanDefinitionReader.setResourceLoader(this);
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
initBeanDefinitionReader(beanDefinitionReader);
loadBeanDefinitions(beanDefinitionReader);
}
关键是这个loadBeanDefinitions(beanDefinitionReader)，一步步断点打下去回来到另外一个loadBeanDefinitions(EncodedResource encodedResource)方法
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
Assert.notNull(encodedResource, "EncodedResource must not be null");
if (logger.isTraceEnabled()) {
logger.trace("Loading XML bean definitions from " + encodedResource);
}
// 获取Resource集合，EncodedResource是增强了编解码功能的一个封装。
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
if (currentResources == null) {
currentResources = new HashSet<>(4);
this.resourcesCurrentlyBeingLoaded.set(currentResources);
}
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
try {
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
inputStream.close();
}
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
currentResources.remove(encodedResource);
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
在这里通过流完成了资源文件读入的过程，之后我们进入doLoadBeanDefinitions看看BeanDefinitions的加载过程。
BeanDefinition的载入
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
//在这里通过XML解析器获取Document 对象
Document doc = doLoadDocument(inputSource, resource);
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
//得到BeanDefinitionDocumentReader 来对XML的BeanDefinition进行解析
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
//具体解析过程在这里完成
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
这个registerBeanDefinitions()的实现是在DefaultBeanDefinitionDocumentReader类中，具体方法是doRegisterBeanDefinitions()。
protected void doRegisterBeanDefinitions(Element root) {
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isDebugEnabled()) {
logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);
this.delegate = parent;
}
具体的BeanDefinition解析就是在这个BeanDefinitionParserDelegate完成的，他会把值从XML中取出来，放到生成的BeanDefinitionHolder中，BeanDefinitionHolder中持有生成的BeanDefinition，至此BeanDefinition理论上已经生成完成。
BeanDefinition的注册
在parseBeanDefinitions()中，解析完成的BeanDefinitionHolder会调用此方法来完成BeanDefinition到IOC容器的注册，这个注册实际上就是把BeanDefinition放到DefaultListableBeanFactory容器中的beanDefinitionMap中。完成注册之后，当创建新Bean的时候，就可以拿BeanDefinition来作为蓝本创建。
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
网友评论