SAX解析XML 詳解 （轉）

時間  2019-12-09
標籤 sax 解析 xml 詳解 欄目 XML 简体版
原文   原文鏈接


    JAVA 解析 XML 一般有兩種方式，DOM 和 SAX。DOM 雖然是 W3C 的標準，提供了標準的解析方式，但它的解析效率一直不盡如人意，由於使用DOM解析XML時，解析器讀入整個文檔並構建一個駐留內存的樹結構（節點樹）， 而後您的代碼纔可使用 DOM 的標準接口來操做這個樹結構。但大部分狀況下咱們只對文檔的部份內容感興趣，根本就不用先解析整個文檔，而且從節點樹的根節點來索引一些咱們須要的數據也 是很是耗時的。 
    SAX是一種XML解析的替代方法。相比於文檔對象模型DOM，SAX 是讀取和操做 XML 數據的更快速、更輕量的方
法。SAX 容許您在讀取文檔時處理它，從而沒必要等待整個文檔被存儲以後才採起操做。它不涉及 DOM 所必需的開銷和概念跳躍。 SAX API是一個基於事件的API ，適用於處理數據流，即隨着數據的流動而依次處理數據。SAX API
在其解析您的文檔時發生必定事件的時候會通知您。在您對其響應時，您不做保存的數據將會 被拋棄。
    下面是一個SAX解析XML的示例（有點長，由於詳細註解了SAX事件處理的全部方法），SAX API中主要有四種處理事件的接口，它們分別是ContentHandler，DTDHandler， EntityResolver 和 ErrorHandler 。下面的例子可能有點冗長，實際上只要繼承DefaultHandler 類 ，再覆蓋一部分 處理事件的方法 一樣能夠達到這個示例的效果，但爲了縱觀全局，仍是看看SAX API裏面全部主要的事件解析方法吧。（ 實際上DefaultHandler就是實現了上面的四個事件處理器接口，而後提供了每一個抽象方法的默認實現。）

1，ContentHandler 接口 ：接收文檔邏輯內容的通知 的處理器接口。java

Java代碼   收藏代碼
  1. import org.xml.sax.Attributes;  
  2. import org.xml.sax.ContentHandler;  
  3. import org.xml.sax.Locator;  
  4. import org.xml.sax.SAXException;  
  5.   
  6. class MyContentHandler implements ContentHandler{  
  7.     StringBuffer jsonStringBuffer ;  
  8.     int frontBlankCount = 0;  
  9.     public MyContentHandler(){  
  10.         jsonStringBuffer = new StringBuffer();  
  11.     }  
  12.     /* 
  13.      * 接收字符數據的通知。 
  14.      * 在DOM中 ch[begin:end] 至關於Text節點的節點值（nodeValue） 
  15.      */  
  16.     @Override  
  17.     public void characters(char[] ch, int begin, int length) throws SAXException {  
  18.         StringBuffer buffer = new StringBuffer();  
  19.         for(int i = begin ; i < begin+length ; i++){  
  20.             switch(ch[i]){  
  21.                 case '\\':buffer.append("\\\\");break;  
  22.                 case '\r':buffer.append("\\r");break;  
  23.                 case '\n':buffer.append("\\n");break;  
  24.                 case '\t':buffer.append("\\t");break;  
  25.                 case '\"':buffer.append("\\\"");break;  
  26.                 default : buffer.append(ch[i]);   
  27.             }  
  28.         }  
  29.         System.out.println(this.toBlankString(this.frontBlankCount)+  
  30.                 ">>> characters("+length+"): "+buffer.toString());  
  31.     }  
  32.   
  33.       
  34.     /* 
  35.      * 接收文檔的結尾的通知。 
  36.      */  
  37.     @Override  
  38.     public void endDocument() throws SAXException {  
  39.         System.out.println(this.toBlankString(--this.frontBlankCount)+  
  40.                 ">>> end document");  
  41.     }  
  42.   
  43.       
  44.     /* 
  45.      * 接收文檔的結尾的通知。 
  46.      * 參數意義以下： 
  47.      *    uri ：元素的命名空間 
  48.      *    localName ：元素的本地名稱（不帶前綴） 
  49.      *    qName ：元素的限定名（帶前綴） 
  50.      *  
  51.      */  
  52.     @Override  
  53.     public void endElement(String uri,String localName,String qName)  
  54.             throws SAXException {  
  55.         System.out.println(this.toBlankString(--this.frontBlankCount)+  
  56.                 ">>> end element : "+qName+"("+uri+")");  
  57.     }  
  58.   
  59.     /* 
  60.      * 結束前綴 URI 範圍的映射。 
  61.      */  
  62.     @Override  
  63.     public void endPrefixMapping(String prefix) throws SAXException {  
  64.         System.out.println(this.toBlankString(--this.frontBlankCount)+  
  65.                 ">>> end prefix_mapping : "+prefix);  
  66.     }  
  67.   
  68.     /* 
  69.      * 接收元素內容中可忽略的空白的通知。 
  70.      * 參數意義以下： 
  71.      *     ch : 來自 XML 文檔的字符 
  72.      *     start : 數組中的開始位置 
  73.      *     length : 從數組中讀取的字符的個數 
  74.      */  
  75.     @Override  
  76.     public void ignorableWhitespace(char[] ch, int begin, int length)  
  77.             throws SAXException {  
  78.         StringBuffer buffer = new StringBuffer();  
  79.         for(int i = begin ; i < begin+length ; i++){  
  80.             switch(ch[i]){  
  81.                 case '\\':buffer.append("\\\\");break;  
  82.                 case '\r':buffer.append("\\r");break;  
  83.                 case '\n':buffer.append("\\n");break;  
  84.                 case '\t':buffer.append("\\t");break;  
  85.                 case '\"':buffer.append("\\\"");break;  
  86.                 default : buffer.append(ch[i]);   
  87.             }  
  88.         }  
  89.         System.out.println(this.toBlankString(this.frontBlankCount)+">>> ignorable whitespace("+length+"): "+buffer.toString());  
  90.     }  
  91.       
  92.     /* 
  93.      * 接收處理指令的通知。 
  94.      * 參數意義以下： 
  95.      *     target : 處理指令目標 
  96.      *     data : 處理指令數據，若是未提供，則爲 null。 
  97.      */  
  98.     @Override  
  99.     public void processingInstruction(String target,String data)  
  100.             throws SAXException {  
  101.         System.out.println(this.toBlankString(this.frontBlankCount)+">>> process instruction : (target = \""  
  102.                 +target+"\",data = \""+data+"\")");  
  103.     }  
  104.   
  105.     /* 
  106.      * 接收用來查找 SAX 文檔事件起源的對象。 
  107.      * 參數意義以下： 
  108.      *     locator : 能夠返回任何 SAX 文檔事件位置的對象 
  109.      */  
  110.     @Override  
  111.     public void setDocumentLocator(Locator locator) {  
  112.         System.out.println(this.toBlankString(this.frontBlankCount)+  
  113.                 ">>> set document_locator : (lineNumber = "+locator.getLineNumber()  
  114.                 +",columnNumber = "+locator.getColumnNumber()  
  115.                 +",systemId = "+locator.getSystemId()  
  116.                 +",publicId = "+locator.getPublicId()+")");  
  117.           
  118.     }  
  119.   
  120.     /* 
  121.      * 接收跳過的實體的通知。 
  122.      * 參數意義以下：  
  123.      *     name : 所跳過的實體的名稱。若是它是參數實體，則名稱將以 '%' 開頭， 
  124.      *            若是它是外部 DTD 子集，則將是字符串 "[dtd]" 
  125.      */  
  126.     @Override  
  127.     public void skippedEntity(String name) throws SAXException {  
  128.         System.out.println(this.toBlankString(this.frontBlankCount)+  
  129.                 ">>> skipped_entity : "+name);  
  130.     }  
  131.   
  132.     /* 
  133.      * 接收文檔的開始的通知。 
  134.      */  
  135.     @Override  
  136.     public void startDocument() throws SAXException {  
  137.         System.out.println(this.toBlankString(this.frontBlankCount++)+  
  138.                 ">>> start document ");  
  139.     }  
  140.   
  141.     /* 
  142.      * 接收元素開始的通知。 
  143.      * 參數意義以下： 
  144.      *    uri ：元素的命名空間 
  145.      *    localName ：元素的本地名稱（不帶前綴） 
  146.      *    qName ：元素的限定名（帶前綴） 
  147.      *    atts ：元素的屬性集合 
  148.      */  
  149.     @Override  
  150.     public void startElement(String uri, String localName, String qName,   
  151.             Attributes atts) throws SAXException {  
  152.         System.out.println(this.toBlankString(this.frontBlankCount++)+  
  153.                 ">>> start element : "+qName+"("+uri+")");  
  154.     }  
  155.       
  156.     /* 
  157.      * 開始前綴 URI 名稱空間範圍映射。 
  158.      * 此事件的信息對於常規的命名空間處理並不是必需： 
  159.      * 當 http://xml.org/sax/features/namespaces 功能爲 true（默認）時， 
  160.      * SAX XML 讀取器將自動替換元素和屬性名稱的前綴。 
  161.      * 參數意義以下： 
  162.      *    prefix ：前綴 
  163.      *    uri ：命名空間 
  164.      */  
  165.     @Override  
  166.     public void startPrefixMapping(String prefix,String uri)  
  167.             throws SAXException {  
  168.         System.out.println(this.toBlankString(this.frontBlankCount++)+  
  169.                 ">>> start prefix_mapping : xmlns:"+prefix+" = "  
  170.                 +"\""+uri+"\"");  
  171.           
  172.     }  
  173.       
  174.     private String toBlankString(int count){  
  175.         StringBuffer buffer = new StringBuffer();  
  176.         for(int i = 0;i<count;i++)  
  177.             buffer.append("    ");  
  178.         return buffer.toString();  
  179.     }  
  180.       
  181. }  

 

2，DTDHandler 接口 ：接收與 DTD 相關的事件的通知的處理器接口。node

Java代碼   收藏代碼
  1. import org.xml.sax.DTDHandler;  
  2. import org.xml.sax.SAXException;  
  3.   
  4. public class MyDTDHandler implements DTDHandler {  
  5.   
  6.     /* 
  7.      * 接收註釋聲明事件的通知。 
  8.      * 參數意義以下： 
  9.      *     name - 註釋名稱。 
  10.      *     publicId - 註釋的公共標識符，若是未提供，則爲 null。 
  11.      *     systemId - 註釋的系統標識符，若是未提供，則爲 null。 
  12.      */  
  13.     @Override  
  14.     public void notationDecl(String name, String publicId, String systemId)  
  15.             throws SAXException {  
  16.         System.out.println(">>> notation declare : (name = "+name  
  17.                 +",systemId = "+publicId  
  18.                 +",publicId = "+systemId+")");  
  19.     }  
  20.   
  21.     /* 
  22.      * 接收未解析的實體聲明事件的通知。 
  23.      * 參數意義以下： 
  24.      *     name - 未解析的實體的名稱。 
  25.      *     publicId - 實體的公共標識符，若是未提供，則爲 null。 
  26.      *     systemId - 實體的系統標識符。 
  27.      *     notationName - 相關注釋的名稱。 
  28.      */  
  29.     @Override  
  30.     public void unparsedEntityDecl(String name,  
  31.             String publicId,  
  32.             String systemId,  
  33.             String notationName) throws SAXException {  
  34.         System.out.println(">>> unparsed entity declare : (name = "+name  
  35.                 +",systemId = "+publicId  
  36.                 +",publicId = "+systemId  
  37.                 +",notationName = "+notationName+")");  
  38.     }  
  39.   
  40. }  

 


3，EntityResolver 接口 ：是用於解析實體的基本接口。json

Java代碼   收藏代碼
  1. import java.io.IOException;  
  2.   
  3. import org.xml.sax.EntityResolver;  
  4. import org.xml.sax.InputSource;  
  5. import org.xml.sax.SAXException;  
  6.   
  7. public class MyEntityResolver implements EntityResolver {  
  8.   
  9.     /* 
  10.      * 容許應用程序解析外部實體。 
  11.      * 解析器將在打開任何外部實體（頂級文檔實體除外）前調用此方法 
  12.      * 參數意義以下： 
  13.      *     publicId ： 被引用的外部實體的公共標識符，若是未提供，則爲 null。 
  14.      *     systemId ： 被引用的外部實體的系統標識符。 
  15.      * 返回： 
  16.      *     一個描述新輸入源的 InputSource 對象，或者返回 null， 
  17.      *     以請求解析器打開到系統標識符的常規 URI 鏈接。 
  18.      */  
  19.     @Override  
  20.     public InputSource resolveEntity(String publicId, String systemId)  
  21.             throws SAXException, IOException {  
  22.         return null;  
  23.     }  
  24.   
  25. }  

 
4，ErrorHandler接口 ：是錯誤處理程序的基本接口。數組

Java代碼   收藏代碼
  1. import org.xml.sax.ErrorHandler;  
  2. import org.xml.sax.SAXException;  
  3. import org.xml.sax.SAXParseException;  
  4.   
  5. public class MyErrorHandler implements ErrorHandler {  
  6.   
  7.     /* 
  8.      * 接收可恢復的錯誤的通知 
  9.      */  
  10.     @Override  
  11.     public void error(SAXParseException e) throws SAXException {  
  12.         System.err.println("Error ("+e.getLineNumber()+","  
  13.                 +e.getColumnNumber()+") : "+e.getMessage());  
  14.     }  
  15.       
  16.     /* 
  17.      * 接收不可恢復的錯誤的通知。 
  18.      */  
  19.     @Override  
  20.     public void fatalError(SAXParseException e) throws SAXException {  
  21.         System.err.println("FatalError ("+e.getLineNumber()+","  
  22.                 +e.getColumnNumber()+") : "+e.getMessage());  
  23.     }  
  24.   
  25.     /* 
  26.      * 接收不可恢復的錯誤的通知。 
  27.      */  
  28.     @Override  
  29.     public void warning(SAXParseException e) throws SAXException {  
  30.         System.err.println("Warning ("+e.getLineNumber()+","  
  31.                 +e.getColumnNumber()+") : "+e.getMessage());  
  32.     }  
  33.   
  34. }  

 

Test 類的主方法打印解析books.xml時的事件信息。app

Java代碼   收藏代碼
  1. import java.io.FileNotFoundException;  
  2. import java.io.FileReader;  
  3. import java.io.IOException;  
  4.   
  5. import org.xml.sax.ContentHandler;  
  6. import org.xml.sax.DTDHandler;  
  7. import org.xml.sax.EntityResolver;  
  8. import org.xml.sax.ErrorHandler;  
  9. import org.xml.sax.InputSource;  
  10. import org.xml.sax.SAXException;  
  11. import org.xml.sax.XMLReader;  
  12. import org.xml.sax.helpers.XMLReaderFactory;  
  13.   
  14.   
  15. public class Test {  
  16.   
  17.     public static void main(String[] args) throws SAXException,   
  18.             FileNotFoundException, IOException {  
  19.         //建立處理文檔內容相關事件的處理器  
  20.         ContentHandler contentHandler = new MyContentHandler();  
  21.         //建立處理錯誤事件處理器  
  22.         ErrorHandler errorHandler = new MyErrorHandler();  
  23.         //建立處理DTD相關事件的處理器  
  24.         DTDHandler dtdHandler = new MyDTDHandler();  
  25.         //建立實體解析器  
  26.         EntityResolver entityResolver = new MyEntityResolver();  
  27.           
  28.         //建立一個XML解析器（經過SAX方式讀取解析XML）  
  29.         XMLReader reader = XMLReaderFactory.createXMLReader();   
  30.         /* 
  31.          * 設置解析器的相關特性 
  32.          *     http://xml.org/sax/features/validation = true 表示開啓驗證特性 
  33.          *     http://xml.org/sax/features/namespaces = true 表示開啓命名空間特性 
  34.          */  
  35.         reader.setFeature("http://xml.org/sax/features/validation",true);  
  36.         reader.setFeature("http://xml.org/sax/features/namespaces",true);  
  37.         //設置XML解析器的處理文檔內容相關事件的處理器  
  38.         reader.setContentHandler(contentHandler);  
  39.         //設置XML解析器的處理錯誤事件處理器  
  40.         reader.setErrorHandler(errorHandler);  
  41.         //設置XML解析器的處理DTD相關事件的處理器  
  42.         reader.setDTDHandler(dtdHandler);  
  43.         //設置XML解析器的實體解析器  
  44.         reader.setEntityResolver(entityResolver);  
  45.         //解析books.xml文檔  
  46.         reader.parse(new InputSource(new FileReader("books.xml")));  
  47.     }  
  48.   
  49. }  

 


books.xml 文件的內容以下： ide

 

Xml代碼   收藏代碼
  1. <?xml version="1.0" encoding="GB2312"?>  
  2. <books  count="3" xmlns="http://test.org/books">  
  3.     <!--books's comment-->  
  4.     <book id="1">  
  5.         <name>Thinking in JAVA</name>  
  6.     </book>  
  7.     <book id="2">  
  8.         <name>Core JAVA2</name>  
  9.     </book>  
  10.     <book id="3">  
  11.         <name>C++ primer</name>  
  12.     </book>  
  13. </books>  

 
控制檯輸出以下： this

 

>>> set document_locator : (lineNumber = 1,columnNumber = 1,systemId = null,publicId = null)
>>> start document
Error (2,7) : Document is invalid: no grammar found.
Error (2,7) : Document root element "books", must match DOCTYPE root "null".
    >>> start prefix_mapping : xmlns: = " http://test.org/books "
        >>> start element : books( http://test.org/books )
            >>> characters(2): \n\t
            >>> characters(2): \n\t
            >>> start element : book( http://test.org/books )
                >>> characters(3): \n\t\t
                >>> start element : name( http://test.org/books )
                    >>> characters(16): Thinking in JAVA
                >>> end element : name( http://test.org/books )
                >>> characters(2): \n\t
            >>> end element : book( http://test.org/books )
            >>> characters(2): \n\t
            >>> start element : book( http://test.org/books )
                >>> characters(3): \n\t\t
                >>> start element : name( http://test.org/books )
                    >>> characters(10): Core JAVA2
                >>> end element : name( http://test.org/books )
                >>> characters(2): \n\t
            >>> end element : book( http://test.org/books )
            >>> characters(2): \n\t
            >>> start element : book( http://test.org/books )
                >>> characters(3): \n\t\t
                >>> start element : name( http://test.org/books )
                    >>> characters(10): C++ primer
                >>> end element : name( http://test.org/books )
                >>> characters(2): \n\t
            >>> end element : book( http://test.org/books )
            >>> characters(1): \n
        >>> end element : books( http://test.org/books )     >>> end prefix_mapping : >>> end document
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程