• 前言

  1. 对于IOC容器而言,BeanDefinition的载入过程,相当于把定义的BeanDefinition在IOC容器中转换成一个Spring内部表示的数据机构的过程。简单说,就是把Spring配置文件中的bean的定义转成Spring的内部数据结构。
  2. 上一篇博客已经描述了Spring如何通过web.xml的配置读取配置路径,通过Resource接口读取配置文件。简单回忆一下上一篇博客的代码顺序。借用上个博客的一张图来看下代码的顺序:
  • BeanDefinition的载入和解析

    我们接着上一篇的代码,在AbstractBeanDefinitionReader的loadBeanDefinitions方法中,我们定位到了Resource[],看下简略代码:
    代码1.1:AbstractBeanDefinitionReader的loadBeanDefinitions方法
       
       
    1. public int loadBeanDefinitions(String location, Set<Resource> actualResources) throws BeanDefinitionStoreException {
    2. ...
    3. if (resourceLoader instanceof ResourcePatternResolver) {
    4. Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);
    5. int loadCount = loadBeanDefinitions(resources);
    6. ...
    7. }else {
    8. Resource resource = resourceLoader.getResource(location);
    9. int loadCount = loadBeanDefinitions(resource);
    10. ...
    11. }
    12. }
  • 将xml文件转换成DOM对象
    通过getResource()方法得到Resource之后,那么就开始了真正加载Bean资源。因为Spring可以对应不同形式的BeanDefinition,我们这里讲的是xml的形式,所以就需要到XmlBeanDefinitionReader的实现中去看源码。
    代码1.2:XmlBeanDefinitionReader的loadBeanDefinitions及doLoadBeanDefinitions方法
 
 
  1. //该方法-->调用入口
  2. public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
  3. return loadBeanDefinitions(new EncodedResource(resource));
  4. }
  5. //该方法-->载入xml形式的BeanDefinition的地方
  6. public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
  7. Assert.notNull(encodedResource, "EncodedResource must not be null");
  8. if (logger.isInfoEnabled()) {
  9. logger.info("Loading XML bean definitions from " + encodedResource.getResource());
  10. }
  11. //这里是获取线程局部变量
  12. Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
  13. if (currentResources == null) {
  14. currentResources = new HashSet<EncodedResource>(4);
  15. this.resourcesCurrentlyBeingLoaded.set(currentResources);
  16. }
  17. if (!currentResources.add(encodedResource)) {
  18. throw new BeanDefinitionStoreException(
  19. "Detected cyclic loading of " + encodedResource + " - check your import definitions!");
  20. }
  21. try {
  22. //将资源文件转换为IO输入流
  23. InputStream inputStream = encodedResource.getResource().getInputStream();
  24. try {
  25. InputSource inputSource = new InputSource(inputStream);
  26. if (encodedResource.getEncoding() != null) {
  27. inputSource.setEncoding(encodedResource.getEncoding());
  28. }
  29. //具体读取过程的方法
  30. return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
  31. }
  32. finally {
  33. inputStream.close();
  34. }
  35. }
  36. catch (IOException ex) {
  37. throw new BeanDefinitionStoreException(
  38. "IOException parsing XML document from " + encodedResource.getResource(), ex);
  39. }
  40. finally {
  41. currentResources.remove(encodedResource);
  42. if (currentResources.isEmpty()) {
  43. this.resourcesCurrentlyBeingLoaded.remove();
  44. }
  45. }
  46. }
  47. //该方法-->从特定XML文件中实际载入Bean定义资源
  48. protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
  49. throws BeanDefinitionStoreException {
  50. try {
  51. int validationMode = getValidationModeForResource(resource);
  52. //将XML文件转换为DOM对象,解析过程由documentLoader实现
  53. Document doc = this.documentLoader.loadDocument(
  54. inputSource, getEntityResolver(), this.errorHandler, validationMode, isNamespaceAware());
  55. //这里是启动对Bean定义解析的详细过程,该解析过程会用到Spring的Bean配置规则【下文详解】
  56. return registerBeanDefinitions(doc, resource);
  57. }
  58. .....
  59. }

上面的过程完成了两个动作:(1)资源文件转换成IO输入流;(2)将xml文件转换成DOM对象。至于解析xml文件的方法,里面是通过创建解析工厂,设置xml解析校检,通过工厂创建解析器,然后parse(),所以这个过程我们就不再看了。

  • 按照Spring的Bean规则对Document对象进行解析
    走主线:得到dom对象后,开始启动对bean定义的详细解析。来看registerBeanDefinitions方法。
    代码1.3:XmlBeanDefinitionReader的loadBeanDefinitions方法
 
 
  1. public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
  2. //得到BeanDefinitionDocumentReader来对xml格式的BeanDefinition解析
  3. BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();、
  4. //获得容器中注册的Bean数量
  5. int countBefore = getRegistry().getBeanDefinitionCount();
  6. //解析过程入口,BeanDefinitionDocumentReader只是个接口,具体的解析实现过程有实现类DefaultBeanDefinitionDocumentReader完成
  7. documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
  8. //统计解析的Bean数量
  9. return getRegistry().getBeanDefinitionCount() - countBefore;
  10. }

我觉得看到这里,是个正常人都会想骂人了,搞这么复杂这么饶人,真TM恶心。不过话说回来,我们作为一个学习者,都知道别人是优秀的,这么设计肯定有很多的道理。讲真,我看IOC源码N遍了,有些地方还是不能理解。废话少说,因为马上就要进入真正解析的地方了,我们稍微总结下上面那么多的饶人的代码。其实就2个核心思想:(1)首先,通过调用XML解析器将Bean定义资源文件转换得到Document对象,但是这些Document对象并没有按照Spring的Bean规则进行解析。这一步是载入的过程。(2)其次,在完成通用的XML解析之后,按照Spring的Bean规则对Document对象进行解析。按照Spring的Bean规则对Document对象解析的过程是在接口BeanDefinitionDocumentReader的实现类DefaultBeanDefinitionDocumentReader中实现的。OK,重点来了。(友情提示,会绕好几个方法。)

代码1.4:DefaultBeanDefinitionDocumentReader的registerBeanDefinitions及parseBeanDefinitions方法

 
 
  1. //该方法--根据Spring DTD对Bean的定义规则解析Bean定义Document对象
  2. public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
  3. this.readerContext = readerContext;
  4. logger.debug("Loading bean definitions");
  5. //获取根元素
  6. Element root = doc.getDocumentElement();
  7. //具体的解析过程由BeanDefinitionParserDelegate实现,BeanDefinitionParserDelegate中定义了Spring Bean定义XML文件的各种元素 (Delegate:代表、委派的意思)
  8. BeanDefinitionParserDelegate delegate = createHelper(readerContext, root);
  9. preProcessXml(root);
  10. //从Document的根元素开始进行Bean定义的Document对象
  11. parseBeanDefinitions(root, delegate);
  12. postProcessXml(root);
  13. }
  14. //该方法--使用Spring的Bean规则从Document的根元素开始进行Bean定义的Document对象
  15. protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
  16. //如果使用了Spring默认的XML命名空间
  17. if (delegate.isDefaultNamespace(root)) {
  18. //遍历根元素的所有子节点
  19. NodeList nl = root.getChildNodes();
  20. for (int i = 0; i < nl.getLength(); i++) {
  21. Node node = nl.item(i);
  22. //如果该节点是XML元素节点
  23. if (node instanceof Element) {
  24. Element ele = (Element) node;
  25. //如果该节点使用的是Spring默认的XML命名空间
  26. if (delegate.isDefaultNamespace(ele)) {
  27. //使用Spring的Bean规则解析元素节点
  28. parseDefaultElement(ele, delegate);
  29. }
  30. else {
  31. //没有使用Spring默认的XML命名空间,则使用用户自定义的解析规则解析元素节点
  32. //(如:自定义的xsd等)
  33. delegate.parseCustomElement(ele);
  34. }
  35. }
  36. }
  37. }
  38. else {
  39. //Document的根节点没有使用Spring默认的命名空间,则使用用户自定义的解析规则解析Document根节点
  40. delegate.parseCustomElement(root);
  41. }
  42. }

上面这段代码又墨迹了一会,这里主要是看节点元素是否是Spring的规范,因为它允许我们自定义解析规范,那么正常我们是利用Spring的规则,所以我们来看parseDefaultElement(ele, delegate)方法。

代码1.5:DefaultBeanDefinitionDocumentReader的parseDefaultElement方法

 
 
  1. private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
  2. //如果元素节点是<Import>导入元素,进行导入解析
  3. if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
  4. importBeanDefinitionResource(ele);
  5. }
  6. //如果元素节点是<Alias>别名元素,进行别名解析
  7. else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
  8. processAliasRegistration(ele);
  9. }
  10. //如果普通的<Bean>元素,按照Spring的Bean规则解析元素
  11. else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
  12. processBeanDefinition(ele, delegate);
  13. }
  14. }

不知道大家看到这里是不是有种释放的感觉,终于TM的看到了自己熟悉的一点东西了。

  • Bean资源的解析

    OK,下面的东西大家会更熟悉,我们主要看对Bean的解析。

    代码1.6:DefaultBeanDefinitionDocumentReader的processBeanDefinition方法

       
       
    1. //解析bean资源
    2. protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
    3. //BeanDefinitionHolder是对BeanDefinition的封装,包括BeanDefinition,beanName,aliases
    4. //对Document对象中<Bean>元素的解析由BeanDefinitionParserDelegate实现
    5. BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
    6. if (bdHolder != null) {
    7. bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
    8. try {
    9. //向Spring IoC容器注册解析得到的Bean定义,
    10. //这是Bean定义向IoC容器注册的入口 ,实际上是放到一个Map里面 【后面再看】
    11. BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
    12. }
    13. catch (BeanDefinitionStoreException ex) {
    14. getReaderContext().error("Failed to register bean definition with name '" +
    15. bdHolder.getBeanName() + "'", ele, ex);
    16. }
    17. // Send registration event.
    18. getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
    19. }
    20. }

    processBeanDefinition方法又引入了BeanDefinitionHolder的概念,注释上我也写了,是一个封装类。因为BeanDefinition是完完整整的Bean定义的解析,holder加了beanName相当于一个key我们也看到了register方法,这个我们后续再单独讲下,下面进入parseBeanDefinitionElement具体解析Bean定义的地方。:

    代码1.7:BeanDefinitionParserDelegate的parseBeanDefinitionElement方法

       
       
    1. //该方法--diaoy 入口
    2. public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
    3. return parseBeanDefinitionElement(ele, null);
    4. }
    5. //该方法--解析Bean定义资源文件中的<Bean>元素,这个方法中主要处理<Bean>元素的id,name和别名属性
    6. public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) {
    7. String id = ele.getAttribute(ID_ATTRIBUTE);//id
    8. String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);//name
    9. List<String> aliases = new ArrayList<String>();//aliase
    10. if (StringUtils.hasLength(nameAttr)) {
    11. String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, BEAN_NAME_DELIMITERS);
    12. aliases.addAll(Arrays.asList(nameArr));
    13. }
    14. String beanName = id;
    15. //如果<Bean>元素中没有配置id属性时,将别名中的第一个值赋值给beanName
    16. if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
    17. beanName = aliases.remove(0);
    18. if (logger.isDebugEnabled()) {
    19. logger.debug("No XML 'id' specified - using '" + beanName +
    20. "' as bean name and " + aliases + " as aliases");
    21. }
    22. }
    23. //检查<Bean>元素所配置的id或者name的唯一性,containingBean标识<Bean>元素中是否包含子<Bean>元素
    24. if (containingBean == null) {
    25. checkNameUniqueness(beanName, aliases, ele);
    26. }
    27. //详细对<Bean>元素中配置的Bean定义进行解析的地方【property,description,parent等】
    28. AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
    29. if (beanDefinition != null) {
    30. if (!StringUtils.hasText(beanName)) {
    31. try {
    32. if (containingBean != null) {
    33. //如果<Bean>元素中没有配置id、别名或者name,且没有包含子
    34. //<Bean>元素,为解析的Bean生成一个唯一beanName并注册
    35. beanName = BeanDefinitionReaderUtils.generateBeanName(
    36. beanDefinition, this.readerContext.getRegistry(), true);
    37. }
    38. else {
    39. beanName = this.readerContext.generateBeanName(beanDefinition);
    40. //如果<Bean>元素中没有配置id、别名或者name,但包含了子
    41. //<Bean>元素,为解析的Bean使用别名向IoC容器注册
    42. String beanClassName = beanDefinition.getBeanClassName();
    43. //为解析的Bean使用别名注册时,为了向后兼容Spring1.2/2.0,给别名添加类名后缀
    44. if (beanClassName != null &&
    45. beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
    46. !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
    47. aliases.add(beanClassName);
    48. }
    49. }
    50. if (logger.isDebugEnabled()) {
    51. logger.debug("Neither XML 'id' nor 'name' specified - " +
    52. "using generated bean name [" + beanName + "]");
    53. }
    54. }
    55. catch (Exception ex) {
    56. error(ex.getMessage(), ele);
    57. return null;
    58. }
    59. }
    60. String[] aliasesArray = StringUtils.toStringArray(aliases);
    61. return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
    62. }
    63. return null;
    64. }

    看到这里大家是不是心里舒服多了,我们看到这里还没有对bean进行完整的解析,具体的参数配置在parseBeanDefinitionElement方法中,我们继续看下对参数的解析。

    代码1.8:BeanDefinitionParserDelegate的parseBeanDefinitionElement方法

       
       
    1. public AbstractBeanDefinition parseBeanDefinitionElement(
    2. Element ele, String beanName, BeanDefinition containingBean) {
    3. //记录解析的<Bean
    4. this.parseState.push(new BeanEntry(beanName));
    5. //这里只读取<Bean>元素中配置的class名字,然后载入到BeanDefinition中去
    6. //只是记录配置的class名字,并不做实例化,对象的实例化在依赖注入时完成
    7. String className = null;
    8. //如果<Bean>元素中配置了parent属性,则获取parent属性的值
    9. if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
    10. className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
    11. }
    12. try {
    13. String parent = null;
    14. if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
    15. parent = ele.getAttribute(PARENT_ATTRIBUTE);
    16. }
    17. //根据<Bean>元素配置的class名称和parent属性值创建BeanDefinition
    18. AbstractBeanDefinition bd = createBeanDefinition(className, parent);
    19. //对<Bean>元素的不同的属性解析【不再写注释了,代码很清晰】
    20. parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
    21. bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
    22. parseMetaElements(ele, bd);
    23. parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
    24. parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
    25. parseConstructorArgElements(ele, bd);
    26. parsePropertyElements(ele, bd);
    27. parseQualifierElements(ele, bd);
    28. bd.setResource(this.readerContext.getResource());
    29. bd.setSource(extractSource(ele));
    30. return bd;
    31. }
    32. catch (ClassNotFoundException ex) {
    33. error("Bean class [" + className + "] not found", ele, ex);
    34. }
    35. catch (NoClassDefFoundError err) {
    36. error("Class that bean class [" + className + "] depends on not found", ele, err);
    37. }
    38. catch (Throwable ex) {
    39. error("Unexpected failure during bean definition parsing", ele, ex);
    40. }
    41. finally {
    42. this.parseState.pop();
    43. }
    44. return null;
    45. }

    只要使用过Spring,对Spring配置文件比较熟悉的人,通过对上述源码的分析,就会明白我们在Spring配置文件中<Bean>元素的中配置的属性就是通过该方法解析和设置到Bean中去的。
    注意:在解析<Bean>元素过程中没有创建和实例化Bean对象,只是创建了Bean对象的定义类BeanDefinition,将<Bean>元素中的配置信息设置到BeanDefinition中作为记录,当依赖注入时才使用这些记录信息创建和实例化具体的Bean对象。
    上面方法中一些对一些配置如元信息(meta)、qualifier等的解析,我们在Spring中配置时使用的也不多,我们在使用Spring的<Bean>元素时,配置最多的是<property>属性。那么我们其实是有必要了解这些属性如何配置的,文章太长了,下一篇文章再说吧。

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐