【死磕 Spring】----- IOC 之解析 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. 
   

7. // 分割 name 属性

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

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

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

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

12. }

13. 
    

14. String beanName = id;

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

16. beanName = aliases.remove(0);

17. if (logger.isDebugEnabled()) {

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

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

20. }

21. }

22. 
    

23. // 检查 name 的唯一性

24. if (containingBean == null) {

25. checkNameUniqueness(beanName, aliases, ele);

26. }

27. 
    

28. // 解析 属性，构造 AbstractBeanDefinition

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

30. if (beanDefinition != null) {

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

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

33. try {

34. if (containingBean != null) {

35. beanName = BeanDefinitionReaderUtils.generateBeanName(

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

37. }

38. else {

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

40. String beanClassName = beanDefinition.getBeanClassName();

41. if (beanClassName != null &&

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

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

44. aliases.add(beanClassName);

45. }

46. }

47. if (logger.isDebugEnabled()) {

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

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

50. }

51. }

52. catch (Exception ex) {

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

54. return null;

55. }

56. }

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

58. 
    

59. // 封装 BeanDefinitionHolder

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

61. }

62. 
    

63. return null;

64. }

这个方法还没有对 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. 
   

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

5. 
   

6. String className = null;

7. // 解析 class 属性

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

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

10. }

11. String parent = null;

12. 
    

13. // 解析 parent 属性

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

15. parent = ele.getAttribute(PARENT_ATTRIBUTE);

16. }

17. 
    

18. try {

19. 
    

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

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

22. 
    

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

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

25. 
    

26. // 提取 description

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

28. 
    

29. // 解析元数据

30. parseMetaElements(ele, bd);

31. 
    

32. // 解析 lookup-method 属性

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

34. 
    

35. // 解析 replaced-method 属性

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

37. 
    

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

39. parseConstructorArgElements(ele, bd);

40. 
    

41. // 解析 property 子元素

42. parsePropertyElements(ele, bd);

43. 
    

44. // 解析 qualifier 子元素

45. parseQualifierElements(ele, bd);

46. 
    

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

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

49. 
    

50. return bd;

51. }

52. catch (ClassNotFoundException ex) {

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

54. }

55. catch (NoClassDefFoundError err) {

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

57. }

58. catch (Throwable ex) {

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

60. }

61. finally {

62. this.parseState.pop();

63. }

64. 
    

65. return null;

66. }

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

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

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