且构网

分享程序员开发的那些事...
且构网 - 分享程序员编程开发的那些事

【死磕 Spring】----- IOC 之解析 bean 标签:开启解析进程

更新时间:2022-09-23 21:42:35

import 标签解析完毕了,再看 Spring 中最复杂也是最重要的标签 bean 标签的解析过程。

在方法 parseDefaultElement() 中,如果遇到标签 为 bean 则调用 processBeanDefinition() 方法进行 bean 标签解析,如下:


  1. protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {

  2. BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);

  3. if (bdHolder != null) {

  4. bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);

  5. try {

  6. // Register the final decorated instance.

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

  8. }

  9. catch (BeanDefinitionStoreException ex) {

  10. getReaderContext().error("Failed to register bean definition with name '" +

  11. bdHolder.getBeanName() + "'", ele, ex);

  12. }

  13. // Send registration event.

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

  15. }

  16. }

整个过程分为四个步骤

  1. 调用 BeanDefinitionParserDelegate.parseBeanDefinitionElement() 进行元素解析,解析过程中如果失败,返回 null,错误由 ProblemReporter 处理。如果解析成功则返回 BeanDefinitionHolder 实例 bdHolder。BeanDefinitionHolder 为持有 name 和 alias 的 BeanDefinition。

  2. 若实例 bdHolder 不为空,则调用 BeanDefinitionParserDelegate.decorateBeanDefinitionIfRequired() 进行自定义标签处理

  3. 解析完成后,则调用 BeanDefinitionReaderUtils.registerBeanDefinition() 对 bdHolder 进行注册

  4. 发出响应事件,通知相关的监听器,完成 Bean 标签解析

先看方法 parseBeanDefinitionElement(),如下:


  1. public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {

  2. // 解析 ID 属性

  3. String id = ele.getAttribute(ID_ATTRIBUTE);

  4. // 解析 name 属性

  5. String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);


  6. // 分割 name 属性

  7. List<String> aliases = new ArrayList<>();

  8. if (StringUtils.hasLength(nameAttr)) {

  9. String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);

  10. aliases.addAll(Arrays.asList(nameArr));

  11. }


  12. String beanName = id;

  13. if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {

  14. beanName = aliases.remove(0);

  15. if (logger.isDebugEnabled()) {

  16. logger.debug("No XML 'id' specified - using '" + beanName +

  17. "' as bean name and " + aliases + " as aliases");

  18. }

  19. }


  20. // 检查 name 的唯一性

  21. if (containingBean == null) {

  22. checkNameUniqueness(beanName, aliases, ele);

  23. }


  24. // 解析 属性,构造 AbstractBeanDefinition

  25. AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);

  26. if (beanDefinition != null) {

  27. // 如果 beanName 不存在,则根据条件构造一个 beanName

  28. if (!StringUtils.hasText(beanName)) {

  29. try {

  30. if (containingBean != null) {

  31. beanName = BeanDefinitionReaderUtils.generateBeanName(

  32. beanDefinition, this.readerContext.getRegistry(), true);

  33. }

  34. else {

  35. beanName = this.readerContext.generateBeanName(beanDefinition);

  36. String beanClassName = beanDefinition.getBeanClassName();

  37. if (beanClassName != null &&

  38. beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&

  39. !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {

  40. aliases.add(beanClassName);

  41. }

  42. }

  43. if (logger.isDebugEnabled()) {

  44. logger.debug("Neither XML 'id' nor 'name' specified - " +

  45. "using generated bean name [" + beanName + "]");

  46. }

  47. }

  48. catch (Exception ex) {

  49. error(ex.getMessage(), ele);

  50. return null;

  51. }

  52. }

  53. String[] aliasesArray = StringUtils.toStringArray(aliases);


  54. // 封装 BeanDefinitionHolder

  55. return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);

  56. }


  57. return null;

  58. }

这个方法还没有对 Bean 标签进行解析,只是在解析动作之前做了一些功能架构,主要的工作有:

  • 解析 id、name 属性,确定 alias 集合,检测 beanName 是否唯一

  • 调用方法 parseBeanDefinitionElement() 对属性进行解析并封装成 GenericBeanDefinition 实例 beanDefinition

  • 根据所获取的信息(beanName、aliases、beanDefinition)构造 BeanDefinitionHolder 实例对象并返回。

这里有必要说下 beanName 的命名规则:如果 id 不为空,则 beanName = id;如果 id 为空,但是 alias 不空,则 beanName 为 alias 的第一个元素,如果两者都为空,则根据默认规则来设置 beanName。

上面三个步骤第二个步骤为核心方法,它主要承担解析 Bean 标签中所有的属性值。如下:


  1. public AbstractBeanDefinition parseBeanDefinitionElement(

  2. Element ele, String beanName, @Nullable BeanDefinition containingBean) {


  3. this.parseState.push(new BeanEntry(beanName));


  4. String className = null;

  5. // 解析 class 属性

  6. if (ele.hasAttribute(CLASS_ATTRIBUTE)) {

  7. className = ele.getAttribute(CLASS_ATTRIBUTE).trim();

  8. }

  9. String parent = null;


  10. // 解析 parent 属性

  11. if (ele.hasAttribute(PARENT_ATTRIBUTE)) {

  12. parent = ele.getAttribute(PARENT_ATTRIBUTE);

  13. }


  14. try {


  15. // 创建用于承载属性的 GenericBeanDefinition 实例

  16. AbstractBeanDefinition bd = createBeanDefinition(className, parent);


  17. // 解析默认 bean 的各种属性

  18. parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);


  19. // 提取 description

  20. bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));


  21. // 解析元数据

  22. parseMetaElements(ele, bd);


  23. // 解析 lookup-method 属性

  24. parseLookupOverrideSubElements(ele, bd.getMethodOverrides());


  25. // 解析 replaced-method 属性

  26. parseReplacedMethodSubElements(ele, bd.getMethodOverrides());


  27. // 解析构造函数参数

  28. parseConstructorArgElements(ele, bd);


  29. // 解析 property 子元素

  30. parsePropertyElements(ele, bd);


  31. // 解析 qualifier 子元素

  32. parseQualifierElements(ele, bd);


  33. bd.setResource(this.readerContext.getResource());

  34. bd.setSource(extractSource(ele));


  35. return bd;

  36. }

  37. catch (ClassNotFoundException ex) {

  38. error("Bean class [" + className + "] not found", ele, ex);

  39. }

  40. catch (NoClassDefFoundError err) {

  41. error("Class that bean class [" + className + "] depends on not found", ele, err);

  42. }

  43. catch (Throwable ex) {

  44. error("Unexpected failure during bean definition parsing", ele, ex);

  45. }

  46. finally {

  47. this.parseState.pop();

  48. }


  49. return null;

  50. }

到这里,Bean 标签的所有属性我们都可以看到其解析的过程,也就说到这里我们已经解析一个基本可用的 BeanDefinition。

由于解析过程较为漫长,篇幅较大,为了更好的观看体验,将这篇博文进行拆分。下篇博客主要介绍 BeanDefinition,以及解析默认 Bean 的过程( parseBeanDefinitionAttributes()


原文发布时间为:2018-09-19
本文作者: Java技术驿站
本文来自云栖社区合作伙伴“ ”,了解相关信息可以关注“ Java技术驿站”。