Spring如何載入XSD檔案(org.xml.sax.SAXParseException: Failed to read schema document錯誤的解決方案)

本文原文串連: http://blog.csdn.net/bluishglc/article/details/7596118 ,轉載請註明出處！

有時候你會發現過去一直啟動正常的系統，某天啟動時會報出形如下面的錯誤：

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檔案中加入：

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

通過日誌瞭解spring是何載入xsd檔案的。

接下來，問題就是為什麼spring在本地沒有找到需要的檔案，不得不轉向網站下載。關於這個問題，其實也非常簡單。在很多spring的jar包裡，在META-INF目錄下都有一個spring.schemas，這是一個property檔案，其內容類別似於下面：

http\://www.springframework.org/schema/beans/spring-beans-2.0.xsd=org/springframework/beans/factory/xml/spring-beans-2.0.xsdhttp\://www.springframework.org/schema/beans/spring-beans-2.5.xsd=org/springframework/beans/factory/xml/spring-beans-2.5.xsdhttp\://www.springframework.org/schema/beans/spring-beans-3.0.xsd=org/springframework/beans/factory/xml/spring-beans-3.0.xsd....

實際上，這個檔案就是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檔案，而不是每次去網站下載，做到這一點就需要你結合上述提及的種種情況對你的工程進行一番檢查。