Spring NameSpaceHandler的加载过程

最新推荐文章于 2021-04-13 22:22:43 发布

chuanlongyue7205

最新推荐文章于 2021-04-13 22:22:43 发布

阅读量662

点赞数

文章标签： java web.xml

原文链接：https://my.oschina.net/Aruforce/blog/3067107

版权

1. 调用链

调用ContextLoadListenner.initWebApplicationContext（）；
调用ContextLoadListenner.createWebApplicationContext（）：根据web.xml里面的contextClass配置的参数名确定Context类，如果没有就使用默认的WebApplicationContext，并创建这个类的实例wac,调用wac.refresh（）；
调用ContextLoadListenner.configureAndRefreshWebApplicationContext(): 根据web.xml配置的contextConfigLocation参数确定配置文件位置
调用wac.refresh（）：
调用wac.obtainFreshBeanFactory();
调用wac.refreshBeanFactory()
调用wac.loadBeanDefinitions(beanFactory):创建XmlBeanDefinitionReader reader
调用reader.loadBeanDefinitions(configLocation):确定文件存在并创建IO流

public int loadBeanDefinitions(EncodedResource encodedResource) ｛
   InputStream inputStream = encodedResource.getResource().getInputStream();
   try {
      InputSource inputSource = new InputSource(inputStream);
      if (encodedResource.getEncoding() != null) {
        inputSource.setEncoding(encodedResource.getEncoding());
      }
      return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
   }
｝

调用 reader.doLoadBeanDefinitions()：构造docreader 解析xml

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)throws BeanDefinitionStoreException {
   Document doc = doLoadDocument(inputSource, resource);
   return registerBeanDefinitions(doc, resource);
}

调用 reader.registerBeanDefinitions()

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
   BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
   int countBefore = getRegistry().getBeanDefinitionCount();
   documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
   return getRegistry().getBeanDefinitionCount() - countBefore;
}

调用 documentReader.registerBeanDefinition

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
   this.readerContext = readerContext;
   logger.debug("Loading bean definitions");
   Element root = doc.getDocumentElement();//其实就是beans标签
   doRegisterBeanDefinitions(root);
   }

12 . 简化的代码

protected void doRegisterBeanDefinitions(Element root) {
    preProcessXml(root);
    parseBeanDefinitions(root, this.delegate);//上下两个方法调用都是空实现，没用
    postProcessXml(root);
}

真的加载逻辑

protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
    if (delegate.isDefaultNamespace(root)) {
        NodeList nl = root.getChildNodes();//xml doc 对象
        for (int i = 0; i < nl.getLength(); i++) {
            Node node = nl.item(i);// 一个个的标签
            if (node instanceof Element) {
                Element ele = (Element) node;
                if (delegate.isDefaultNamespace(ele)) {
                    parseDefaultElement(ele, delegate);
                }else {
                    delegate.parseCustomElement(ele);
                }
            }
        }
    }else {
        delegate.parseCustomElement(root);
    }
}

xml标签tag标签解析

public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) {
    String namespaceUri = getNamespaceURI(ele);
    NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
    if (handler == null) {
        error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
        return null;
    }
    return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
}

从缓存的数据寻找对应namespace的URI对应的NameSpcaeHandler

public NamespaceHandler resolve(String namespaceUri) {
    Map<String, Object> handlerMappings = getHandlerMappings();
    Object handlerOrClassName = handlerMappings.get(namespaceUri);
    if (handlerOrClassName == null) {
        return null;
    } else if (handlerOrClassName instanceof NamespaceHandler) {
        return (NamespaceHandler) handlerOrClassName;
    }else {
        String className = (String) handlerOrClassName;
        try {
            Class<?> handlerClass = ClassUtils.forName(className, this.classLoader);
            if (!NamespaceHandler.class.isAssignableFrom(handlerClass)) {
                throw new FatalBeanException("Class [" + className + "] for namespace [" + namespaceUri +"] does not implement the [" + NamespaceHandler.class.getName() + "] interface");
            }
            NamespaceHandler namespaceHandler = (NamespaceHandler) BeanUtils.instantiateClass(handlerClass);// 创建handler对象
            namespaceHandler.init();//初始化
            handlerMappings.put(namespaceUri, namespaceHandler);
            return namespaceHandler;
        }catch (ClassNotFoundException ex) {
        throw new FatalBeanException("NamespaceHandler class [" + className + "] for namespace [" +namespaceUri + "] not found", ex);
        }catch (LinkageError err) {
        throw new FatalBeanException("Invalid NamespaceHandler class [" + className + "] for namespace [" +	namespaceUri + "]: problem with handler class file or dependent class", err);
        }
    }
}

这一步骤原理在ClassLoader.getResources(String location)加载所有jar里面的spring.handlers 这个文件里的配置

private Map<String, Object> getHandlerMappings() {
    if (this.handlerMappings == null) {
        synchronized (this) {
            if (this.handlerMappings == null) {
                try {
                    Properties mappings =PropertiesLoaderUtils.loadAllProperties(this.handlerMappingsLocation, this.classLoader);
                    if (logger.isDebugEnabled()) {
                        logger.debug("Loaded NamespaceHandler mappings: " + mappings);
                    }
                    Map<String, Object> handlerMappings = new ConcurrentHashMap<String, Object>(mappings.size());
                    CollectionUtils.mergePropertiesIntoMap(mappings, handlerMappings);
                    this.handlerMappings = handlerMappings;
                }catch (IOException ex) {
                    throw new IllegalStateException("Unable to load NamespaceHandler mappings from location [" + this.handlerMappingsLocation + "]", ex);
                }
            }
        }
    }
    return this.handlerMappings;
}