spring深入理解二(关于容器工作源码)

扫码关注公众号:Java 技术驿站

发送:vip
将链接复制到本浏览器,永久解锁本站全部文章

【公众号:Java 技术驿站】 【加作者微信交流技术,拉技术群】

spring基本工作原理如下:

1.查找bean配置文件

2.加载bean配置文件并解析生成中间表示BeanDefinition

3.注册beanDefinition

4.如果是单例或lazy-init=false,则直接生成bean

spring将

1.查找bean配置文件

2.加载bean配置文件并解析生成中间表示BeanDefinition

3.注册beanDefinition

这三部分开,可以提供更多的定制给用户。

spring将配置文件之类的文件资源抽象成一个Resource,封装了getInputStream,isClose等方法。

Resource有子类ClasspathResouce及FileSystemResource

Resouce解决了第一步查找bean配置文件的问题

接着要解决第二步载bean配置文件并解析生成中间表示BeanDefinition。

spring这个是通过BeanDefinitionReader(接口)去做。

BeanDefinitionReader有实现XmlBeanDefinitionReader等。

XmlBeanDefinitionReader有个参数为容器BeanRegistry用于存放解析后的BeanDefinition。

即BeanDefinitionReader可以分三步完成第二步任务:1.将Resource中的inputStream解析成xml的Dom形式 2.根据Dom,生成BeanDefinition 3.注册到BeanRegistry中

这里将resource解析成Dom是用另一个类DefaultDocumentLoader去做。解析xml生成BeanDefinition并注册则交给BeanDefinitionDocumentReader去做。

可以看出spring设计XmlBeanDefinitionReader类时,将这个类的职责分解,并将每一部分任务交给相应的类去做。

例子:

ClassPathResource res=new ClassPathResource(“containerTest.xml”); //定位资源

DefaultListableBeanFactory factory=new DefaultListableBeanFactory(); //BeanRegistry容器,可以认为提供了一个map用于存储beanDefinition

XmlBeanDefinitionReader reader=new XmlBeanDefinitionReader(factory); //配置读取类

int n=reader.loadBeanDefinitions(res); //触发,XmlBeanDefinitionReader加载,解析配置文件,生成BeanDefinition的动作

B b=(B) factory.getBean(“b”);

以下分析这部分源码.

首先说明DefaultListableBeanFactory实现了BeanDefinitionRegistry接口,代表一个能够存放BeanDefinition的容器。

XmlBeanDefinitionReader是个beanDefinition读取器,完成配置文件定位,加载分析,生成beanDefinition及注册到容器中(这几个任务单独交由不同组件去做)。

XmlBeanDefinitionReader已经有个元素就是beanRegistry容器。因此XmlBeanDefinitionReader reader=new XmlBeanDefinitionReader(factory) 只是将容器设置

到XmlBeanDefinitionReader的registry属性上。

接着调用XmlBeanDefinitionReader的loadBeanDefinitions,开始对于ClassPathResource的资源的定位,加载分析等后续操作。

源码如下:

public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {

return loadBeanDefinitions(new EncodedResource(resource));

}

可以看到这里,对于resource这里又封装成EncodedResource,这个EncodedResource封装了encoding,用于在读取流的时候采用何种编码。

接着将EncodedResource传给loadBeanDefinitions方法。

在看loadBeanDefinitions方法前,不妨先问自己一个问题,如果在当前containerTest.xml文件中又import了containerTest.xml会怎么样?

理论上,是要报错的,如果是这样,如何做?

loadBeanDefinitions方法如下:

public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {

Assert.notNull(encodedResource, “EncodedResource must not be null”);

if (logger.isInfoEnabled()) {

logger.info(“Loading XML bean definitions from ” + encodedResource.getResource());

}

/**

这里的set,解决了资源文件重复引用的问题

通过将EncodedResource放入一个集合set,然后将将这个set放入到一个

ThreadLocal当中:ThreadLocal<Set> resourcesCurrentlyBeingLoaded

每次加载新资源文件就将其放入到这个集合中,如果已经存在,放入失败则抛出异常

**/

Set 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!”);

}

//不存在当前资源文件,进行定位,加载分析,形成beanDefinition并注册到容器中

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();

}

}

}

上面代码已经注明为了防止资源文件重复引入,通过将EncodedResource放入一个集合set,然后将将这个set放入到一个

ThreadLocal当中:ThreadLocal<Set> resourcesCurrentlyBeingLoaded,

每次加载新资源文件就将其放入到这个集合中,如果已经存在,放入失败则抛出异常。

如果不存在,则进行后续操作。后续操作交由doLoadBeanDefinitions去做。

doLoadBeanDefinitions方法如下:

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)

throws BeanDefinitionStoreException {

try {

int validationMode = getValidationModeForResource(resource);//获取验证xml的模式,有xsd,dtd及auto。这里为xsd

//加载xml,形成xml的Dom。

Document doc = this.documentLoader.loadDocument(

inputSource, getEntityResolver(), this.errorHandler, validationMode, isNamespaceAware());

//根据得到的xml Dom,进行后续解析Dom,生成BeanDefinition,注册操作

return registerBeanDefinitions(doc, resource);

}

catch (BeanDefinitionStoreException ex) {

throw ex;

}

catch (SAXParseException ex) {

throw new XmlBeanDefinitionStoreException(resource.getDescription(),

“Line ” + ex.getLineNumber() + ” in XML document from ” + resource + ” is invalid”, ex);

}

catch (SAXException ex) {

throw new XmlBeanDefinitionStoreException(resource.getDescription(),

“XML document from ” + resource + ” is invalid”, ex);

}

catch (ParserConfigurationException ex) {

throw new BeanDefinitionStoreException(resource.getDescription(),

“Parser configuration exception parsing XML from ” + resource, ex);

}

catch (IOException ex) {

throw new BeanDefinitionStoreException(resource.getDescription(),

“IOException parsing XML document from ” + resource, ex);

}

catch (Throwable ex) {

throw new BeanDefinitionStoreException(resource.getDescription(),

“Unexpected exception parsing XML document from ” + resource, ex);

}

}

在这个方法中,可以看到解析文件流,并生成xml的Dom文档是通过DocumentLoader类的loadDocument来做,职责比较内聚。

生成Dom后,调用registerBeanDefinitions,进行后续操作。

registerBeanDefinitions方法,后续需要根据传入的dom,进行dom解析生成BeanDenition,并注册。

registerBeanDefinitions方法代码如下:

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {

BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();

documentReader.setEnvironment(this.getEnvironment());

int countBefore = getRegistry().getBeanDefinitionCount();

documentReader.registerBeanDefinitions(doc, createReaderContext(resource));

return getRegistry().getBeanDefinitionCount() – countBefore;

}

方法第一句BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();

创建了一个BeanDefinitionDocumentReader,用于真正解析dom及注册任务,这也让我们看到了一个风格:功能内聚。

当前所处类XmlBeanDefinitionReader做了一个协调组合作用,叫一帮人一起干活,当然XmlBeanDefinitionReader本身也做了一些验证,初始化操作,如前面提到的保证某个资源文件只会被加载一次。

创建了documentReader后,接着int countBefore = getRegistry().getBeanDefinitionCount();获取当前容器已经注册beanDefinition的数量。

然后调用documentReader的registerBeanDefinitions进行后续操作。所有都完成后,返回这次注册的beanDefinition数量(return getRegistry().getBeanDefinitionCount() – countBefore)。

接着我们继续查看registerBeanDefinitions方法,代码如下。

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {

this.readerContext = readerContext;

logger.debug(“Loading bean definitions”);

Element root = doc.getDocumentElement();

doRegisterBeanDefinitions(root);

}

很简单,这个方法获取doc文档中的根元素,为 [beans]。

然后调用doRegisterBeanDefinitions进行处理,代码如下:

protected void doRegisterBeanDefinitions(Element root) {

String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);

if (StringUtils.hasText(profileSpec)) {

Assert.state(this.environment != null, “environment property must not be null”);

String[] specifiedProfiles = StringUtils.tokenizeToStringArray(profileSpec, `` BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);

if (!this.environment.acceptsProfiles(specifiedProfiles)) {

return;

}

}

// any nested elements will cause recursion in this method. In

// order to propagate and preserve default-* attributes correctly,

// keep track of the current (parent) delegate, which may be null. Create

// the new (child) delegate with a reference to the parent for fallback purposes,

// then ultimately reset this.delegate back to its original (parent) reference.

// this behavior emulates a stack of delegates without actually necessitating one.

BeanDefinitionParserDelegate parent = this.delegate;

this.delegate = createHelper(readerContext, root, parent);

preProcessXml(root);

parseBeanDefinitions(root, this.delegate);

postProcessXml(root);

this.delegate = parent;`

}

可以看到,最前面是if (StringUtils.hasText(profileSpec)) 里的代码是与spring提供的profile功能相关,类似maven的profile。

我们这里没用profile,应该,跳转到

BeanDefinitionParserDelegate parent = this.delegate;及

this.delegate = createHelper(readerContext, root, parent);

这两句创建了一个BeanDefinitionParserDelegate实例,用于完成生成beanDenition,及注册任务。

preProcessXml用于处理用户自定义xml类型,这里由于没有,所以是个空方法。

parseBeanDefinitions(root, this.delegate);完成生成beanDenition及注册工作,代码如下:

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {

if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {

//如果是import资源文件,则进行import资源文件逻辑

importBeanDefinitionResource(ele);

}

else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {

//如果元素是alias

processAliasRegistration(ele);

}

else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {

//如果元素是bean,则生成beanDefinition,及注册

processBeanDefinition(ele, delegate);

}

else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {

// recurse

doRegisterBeanDefinitions(ele);

}

}

这个方法主要关注bean元素的处理,是在else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {这个分支当中。

可以看到调用了processBeanDefinition进行处理,代码如下:

/**

* Process the given bean element, parsing the bean definition

* and registering it with the registry.

*/

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {

//delegate负责解析xml element,生成beanDenition并放入到BeanDefinitionHolder当中

BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);

if (bdHolder != null) {

bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);

try {

// Register the final decorated instance.

BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());

}

catch (BeanDefinitionStoreException ex) {

getReaderContext().error(“Failed to register bean definition with name ‘” +

bdHolder.getBeanName() + “‘”, ele, ex);

}

// Send registration event.

getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));

}

}

可以看到这个方法,用delegate.parseBeanDefinitionElement(ele)生成BeanDefinition(解析 <bean id=”” name=“”>这样的标签元素,将其值放入到生成的BeanDefinition实例中),并放入到BeanDenitionHolder当中。

接着重点看

// Register the final decorated instance.

BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());

这句,这个就是将beanDenition注册到容器中了。BeanDefinitionReaderUtils.registerBeanDefinition代码如下:

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 aliase : aliases) {

registry.registerAlias(beanName, aliase);

}

}

}

从中可以看到,注册调用的是容器的方法:registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());

在registry.registerBeanDefinition中会有对于如果已经存在beanDenition,是否允许覆盖等逻辑。最终这个方法会以同步操作存储beanDenition的map,来将

beanDenition的name为key,VALUE为beanDenition,放入到这个map。

代码如下:

public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)

throws BeanDefinitionStoreException {

Assert.hasText(beanName, “Bean name must not be empty”);

Assert.notNull(beanDefinition, “BeanDefinition must not be null”);

if (beanDefinition instanceof AbstractBeanDefinition) {

try {

((AbstractBeanDefinition) beanDefinition).validate();

}

catch (BeanDefinitionValidationException ex) {

throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,

“Validation of bean definition failed”, ex);

}

}

synchronized (this.beanDefinitionMap) {

//如果已经存在旧的相同名称的beanDenition,看是否允许覆盖,不允许直接抛错

Object oldBeanDefinition = this.beanDefinitionMap.get(beanName);

if (oldBeanDefinition != null) {

if (!this.allowBeanDefinitionOverriding) {

throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,

“Cannot register bean definition [” + beanDefinition + “] for bean ‘” + beanName +

“‘: There is already [” + oldBeanDefinition + “] bound.”);

}

else {

if (this.logger.isInfoEnabled()) {

this.logger.info(“Overriding bean definition for bean ‘” + beanName +

“‘: replacing [” + oldBeanDefinition + “] with [” + beanDefinition + “]”);

}

}

}

else {

this.beanDefinitionNames.add(beanName);

this.frozenBeanDefinitionNames = null;

}

//将beanDenition放入map,key为bean的name,value为beanDenition

this.beanDefinitionMap.put(beanName, beanDefinition);

}

resetBeanDefinition(beanName);

}

赞(0) 打赏
版权归原创作者所有,任何形式的转载请联系博主:daming_90:Java 技术驿站 » spring深入理解二(关于容器工作源码)

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

微信扫一扫打赏