关于Spring中加载xsd文件出现故障的文章总结

本文原文连接: http://blog.youkuaiyun.com/bluishglc/article/details/7596118 ,转载请注明出处！

有时候你会发现过去一直启动正常的系统，某天启动时会报出形如下面的错误：

[plain]  view plain  copy

1. org.xml.sax.SAXParseException: schema_reference.4: Failed to read schema document 'http://www.springframework.org/schema/beans/spring-beans-2.0.xsd', because 1) could not find the document; 2) the document could not be read; 3) the root element of the document is not <xsd:schema>.  

很显然，spring xml配置文件中指定的xsd文件读取不到了，原因多是因为断网或spring的官网暂时无法连接导致的。 你可以通过在浏览器输入xsd文件的URL，如：http://www.springframework.org/schema/beans/spring-beans-2.0.xsd 进行确认。

关于这个问题，网上有两种常见的解决方法，第一种简单有效，但是工作量大，即：把所有spring配置文件中url形式的xsd路径转换成指向本地xsd文件的classpath形式的路径，例如：classpath:org/springframework/beans/factory/xml/spring-beans-2.5.xsd ,再有一种方法就是在本机搭建web服务器，按URL创建相应文件夹，放入对应xsd文件，在本机hosts文件中加入"127.0.0.1 www.springframework.org".实际上，这两种方法都属于“歪打正着”式的方法，直正弄明白这一问题还需要从spring的XSD文件加载机制谈起。

首先：你必须知道一点：spring在加载xsd文件时总是先试图在本地查找xsd文件(spring的jar包中已经包含了所有版本的xsd文件)，如果没有找到，才会转向去URL指定的路径下载。这是非常合理的做法，并不像看上去的那样，每次都是从站点下载的。事实上，假如你的所有配置是正确定的，你的工程完全可以在断网的情况下启动而不会报上面的错误。Spring加载xsd文件的类是PluggableSchemaResolver，你可以查看一下它的源码来验证上述说法。另外，你可以在log4j.xml文件中加入：

[html]  view plain  copy

1. <logger name="org.springframework.beans.factory.xml">  
2.     <level value="all" />  
3. </logger>  

通过日志了解spring是何加载xsd文件的。

接下来，问题就是为什么spring在本地没有找到需要的文件，不得不转向网站下载。关于这个问题，其实也非常简单。在很多spring的jar包里，在META-INF目录下都有一个spring.schemas，这是一个property文件，其内容类似于下面：

[plain]  view plain  copy

1. http\://www.springframework.org/schema/beans/spring-beans-2.0.xsd=org/springframework/beans/factory/xml/spring-beans-2.0.xsd  
2. http\://www.springframework.org/schema/beans/spring-beans-2.5.xsd=org/springframework/beans/factory/xml/spring-beans-2.5.xsd  
3. http\://www.springframework.org/schema/beans/spring-beans-3.0.xsd=org/springframework/beans/factory/xml/spring-beans-3.0.xsd  
4. ....  

实际上，这个文件就是spring关于xsd文件在本地存放路径的映射，spring就是通过这个文件在本地（也就是spring的jar里）查找xsd文件的。那么，查找不到的原因排除URL输入有误之外，可能就是声明的xsd文件版本在本地不存在。一般来说，新版本的spring jar包会将过去所有版本(应该是自2.0以后)的xsd打包，并在spring.schemas文件中加入了对应项，出现问题的情况往往是声明使用了一个高版本的xsd文件，如3.0，但依赖的spring的jar包却是2.5之前的版本，由于2.5版本自然不可能包含3.0的xsd文件，此时就会导致spring去站点下载目标xsd文件，如遇断网或是目标站点不可用，上述问题就发生了。

但是，在实现开发中，出现上述错误的几率并不高，最常见的导致这一问题的原因其实与使用了一个名为“assembly”的maven打包插件有关。很多项目需要将工程连同其所依赖的所有jar包打包成一个jar包，maven的assembly插件就是用来完成这个任务的。但是由于工程往往依赖很多的jar包，而被依赖的jar又会依赖其他的jar包，这样，当工程中依赖到不同的版本的spring时，在使用assembly进行打包时，只能将某一个版本jar包下的spring.schemas文件放入最终打出的jar包里，这就有可能遗漏了一些版本的xsd的本地映射，进而出现了文章开始提到的错误。如果你的项目是打成单一jar的，你可以通过检查最终生成的jar里的spring.schemas文件来确认是不是这种情况。而关于这种情况，解决的方法一般是推荐使用另外一种打包插件shade,它确实是一款比assembly更加优秀的工具，在对spring.schemas文件处理上，shade能够将所有jar里的spring.schemas文件进行合并，在最终生成的单一jar包里，spring.schemas包含了所有出现过的版本的集合！

以上就是spring加载XSD文件的机制和出现问题的原因分析。实际上，我们应该让我们工程在启动时总是加载本地的xsd文件，而不是每次去站点下载，做到这一点就需要你结合上述提及的种种情况对你的工程进行一番检查。

这里还有一篇文章是说明为什么我们在配置spring的xsd的时候不加上版本号更加的好

原文链接：http://blog.youkuaiyun.com/hengyunabc/article/details/22295749

为什么dubbo启动没有问题？

这篇blog源于一个疑问：

我们公司使了阿里的dubbo，但是阿里的开源网站http://code.alibabatech.com，挂掉有好几个月了，为什么我们的应用启动没有问题？

我们的应用的Spring配置文件里有类似的配置：

[html]  view plain  copy

 

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"  
4.     xsi:schemaLocation="http://www.springframework.org/schema/beans  
5.             http://www.springframework.org/schema/beans/spring-beans.xsd  
6.             http://code.alibabatech.com/schema/dubbo  
7.             http://code.alibabatech.com/schema/dubbo/dubbo.xsd">  

我们都知道Spring在启动时是要检验XML文件的。或者为什么在Eclipse里xml没有错误提示？

比如这样的一个Spring配置：

[html]  view plain  copy

 

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans"  
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">  
5. </beans>  

我们也可以在后面加上版本号：

[html]  view plain  copy

 

1. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">  

有这个版本号和没有有什么区别呢？

XML的一些概念

首先来看下xml的一些概念：

xml的schema里有namespace，可以给它起个别名。比如常见的spring的namespace：

[html]  view plain  copy

 

1. xmlns:mvc="http://www.springframework.org/schema/mvc"  
2. xmlns:context="http://www.springframework.org/schema/context"  

通常情况下，namespace对应的URI是一个存放XSD的地址，尽管规范没有这么要求。如果没有提供schemaLocation，那么Spring的XML解析器会从namespace的URI里加载XSD文件。我们可以把配置文件改成这个样子，也是可以正常工作的：

[html]  view plain  copy

 

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <beans xmlns="http://www.springframework.org/schema/beans/spring-beans.xsd"  
3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">  

schemaLocation提供了一个xml namespace到对应的XSD文件的一个映射，所以我们可以看到，在xsi:schemaLocation后面配置的字符串都是成对的，前面的是namespace的URI，后面是xsd文件的URI。比如：

[html]  view plain  copy

 

1. xsi:schemaLocation="http://www.springframework.org/schema/beans  
2. http://www.springframework.org/schema/beans/spring-beans.xsd  
3. http://www.springframework.org/schema/security  
4. http://www.springframework.org/schema/security/spring-security.xsd"  

Spring是如何校验XML的

Spring默认在启动时是要加载XSD文件来验证xml文件的，所以如果有的时候断网了，或者一些开源软件切换域名，那么就很容易碰到应用启动不了。我记得当时Oracle收购Sun公司时，遇到过这个情况。

为了防止这种情况，Spring提供了一种机制，默认从本地加载XSD文件。打开spring-context-3.2.0.RELEASE.jar，可以看到里面有两个特别的文件：

spring.handlers

[plain]  view plain  copy

 

1. http\://www.springframework.org/schema/context=org.springframework.context.config.ContextNamespaceHandler  
2. http\://www.springframework.org/schema/jee=org.springframework.ejb.config.JeeNamespaceHandler  
3. http\://www.springframework.org/schema/lang=org.springframework.scripting.config.LangNamespaceHandler  
4. http\://www.springframework.org/schema/task=org.springframework.scheduling.config.TaskNamespaceHandler  
5. http\://www.springframework.org/schema/cache=org.springframework.cache.config.CacheNamespaceHandler  

spring.schemas

[plain]  view plain  copy

 

1. http\://www.springframework.org/schema/context/spring-context-2.5.xsd=org/springframework/context/config/spring-context-2.5.xsd  
2. http\://www.springframework.org/schema/context/spring-context-3.0.xsd=org/springframework/context/config/spring-context-3.0.xsd  
3. http\://www.springframework.org/schema/context/spring-context-3.1.xsd=org/springframework/context/config/spring-context-3.1.xsd  
4. http\://www.springframework.org/schema/context/spring-context-3.2.xsd=org/springframework/context/config/spring-context-3.2.xsd  
5. http\://www.springframework.org/schema/context/spring-context.xsd=org/springframework/context/config/spring-context-3.2.xsd  
6. ...  

再打开jar包里的org/springframework/context/config/ 目录，可以看到下面有

spring-context-2.5.xsd
spring-context-3.0.xsd
spring-context-3.1.xsd
spring-context-3.2.xsd

很明显，可以想到Spring是把XSD文件放到本地了，再在spring.schemas里做了一个映射，优先从本地里加载XSD文件。

并且Spring很贴心，把旧版本的XSD文件也全放了。这样可以防止升级了Spring版本，而配置文件里用的还是旧版本的XSD文件，然后断网了，应用启动不了。

我们还可以看到，在没有配置版本号时，用的就是当前版本的XSD文件：

[html]  view plain  copy

 

1. http\://www.springframework.org/schema/context/spring-context.xsd=org/springframework/context/config/spring-context-3.2.xsd  

同样，我们打开dubbo的jar包，可以在它的spring.schemas文件里看到有这样的配置：

[html]  view plain  copy

 

1. http\://code.alibabatech.com/schema/dubbo/dubbo.xsd=META-INF/dubbo.xsd  

所以，Spring在加载dubbo时，会从dubbo的jar里加载dubbo.xsd。

如何跳过Spring的XML校验？

可以用这样的方式来跳过校验：

[html]  view plain  copy

 

1. GenericXmlApplicationContext context = new GenericXmlApplicationContext();  
2. context.setValidating(false);  

如何写一个自己的spring xml namespace扩展

可以参考Spring的文档，实际上是相当简单的。只要实现自己的NamespaceHandler，再配置一下spring.handlers和spring.schemas就可以了。

http://docs.spring.io/spring/docs/current/spring-framework-reference/html/extensible-xml.html

其它的一些东东

防止XSD加载不成功的一个思路

http://hellojava.info/?p=135

齐全的Spring的namespace的列表

http://stackoverflow.com/questions/11174286/spring-xml-namespaces-how-do-i-find-what-are-the-implementing-classes-behind-t

Spring core

• aop - AopNamespaceHandler
• c - SimpleConstructorNamespaceHandler
• cache - CacheNamespaceHandler
• context - ContextNamespaceHandler
• jdbc - JdbcNamespaceHandler
• jee - JeeNamespaceHandler
• jms - JmsNamespaceHandler
• lang - LangNamespaceHandler
• mvc - MvcNamespaceHandler
• oxm - OxmNamespaceHandler
• p - SimplePropertyNamespaceHandler
• task - TaskNamespaceHandler
• tx - TxNamespaceHandler
• util - UtilNamespaceHandler

Spring Security

• security - SecurityNamespaceHandler
• oauth - OAuthSecurityNamespaceHandler

Spring integration

• int - IntegrationNamespaceHandler
• amqp - AmqpNamespaceHandler
• event - EventNamespaceHandler
• feed - FeedNamespaceHandler
• file - FileNamespaceHandler
• ftp - FtpNamespaceHandler
• gemfire - GemfireIntegrationNamespaceHandler
• groovy - GroovyNamespaceHandler
• http - HttpNamespaceHandler
• ip - IpNamespaceHandler
• jdbc - JdbcNamespaceHandler
• jms - JmsNamespaceHandler
• jmx - JmxNamespaceHandler
• mail - MailNamespaceHandler
• redis - RedisNamespaceHandler
• rmi - RmiNamespaceHandler
• script - ScriptNamespaceHandler
• security - IntegrationSecurityNamespaceHandler
• sftp - SftpNamespaceHandler
• stream - StreamNamespaceHandler
• twitter - TwitterNamespaceHandler
• ws - WsNamespaceHandler
• xml - IntegrationXmlNamespaceHandler
• xmpp - XmppNamespaceHandler

总结：

为什么不要在Spring的配置里，配置上XSD的版本号？
因为如果没有配置版本号，取的就是当前jar里的XSD文件，减少了各种风险。
而且这样约定大于配置的方式很优雅。

参考：

http://stackoverflow.com/questions/10768873/spring-di-applicationcontext-xml-how-exactly-is-xsischemalocation-used

http://stackoverflow.com/questions/11174286/spring-xml-namespaces-how-do-i-find-what-are-the-implementing-classes-behind-t

http://docs.spring.io/spring/docs/current/spring-framework-reference/html/extensible-xml.html