使用Ono讀取XML文件

在做App的過程中，讀取XML文件是最常見的功能之一。并且在iOS的發展過程中涌現出了多種XML的解決方案。如Apple自家提供的NSXMLParser和libxml2(C接口).另外還有大量第三方庫工具如TBXML、TouchXML、KissXML、TinyXML。在raywenderlich上面有個詳細的對比，他的對比結論是：

• 如果僅僅是解析比較小的XML數據，可以考慮NSXMLParser、TouchXML、KissXML或者GDataXML ，理由是簡單好用
• 如果是解析比較大數據的XML，則推薦 libxml2(SAX模式)或者 TBXML。性能較好，但是使用復雜

解析XML通常有兩種方式：DOM和SAX

DOM解析XML時，讀入整個XML文檔并構建一個駐留內存的樹結構（稱“節點樹”），之后就通過遍歷樹結構可以檢索任意XML節點，讀取它的屬性和值。而起通常情況下，可以借助XPath，直接查詢XML節點。
SAX解析XML，是基于事件通知的模式，一邊讀取XML文檔一邊處理，不必等整個文檔加載完之后才采取操作，當在讀取解析過程中遇到需要處理的對象，會發出通知對其進行處理。

從上面來看，后兩者可以滿足各種場景，只是使用上面偏向復雜，尤其是libxml2還是C接口。而今天我們要介紹的是Ono就是對這個C接口的libxml2的一層OC友好接口的封裝，這個接口是誰設計的呢？靠譜么？

來，我們可以看下他的作者:Mattt Thompson，matt github顯示他供職于Apple，且是著名的FormatKit的作者。

這樣它就既繼承了libxml2的高效，同時又擁有了和NSXMLParser一樣友好的接口。

不過現在的Ono有點比較坑的是沒有提供修改XML的接口，僅可用于讀取的XML(如配置文件、數據文件)的場景(客戶端更多的場景還是解析XML)。

1. 集成Ono

Ono提供了CocoaPods支持，因此只要在Podfile里面加上

pod 'Ono'

然后執行pod install 即可完成對Ono的安裝，由于Ono是封裝的libxml2，因此需要在“Build Phases”里面的“Link Binary with Libraries”里面添加上對libxml2的依賴.可以看到Ono的源碼非常簡單，只有兩個文件（外加一個版本信息文件）總共1.5k行左右代碼完成對libxml2的一個友好OC API的封裝。

在需要用到Ono的文件里面import頭文件：

#import <Ono/Ono.h>

即可。

Demo可以參考作者自己的Demo。

2. 加載XML數據

XML數據對象由ONOXMLDocument來表示。其可以從NSData或者NSString中進行加載。

XMLDocumentWithString:(NSString *)string
            encoding:(NSStringEncoding)encoding
               error:(NSError * __autoreleasing *)error;
               
XMLDocumentWithData:(NSData *)data
                     error:(NSError * __autoreleasing *)error;

encoding參數表示數據的格式，可以從文件中讀取數據內容到NSData中，然后從NSData中進行解析得到一個ONOXMLDocument。如：

ONOXMLDocument *document = [ONOXMLDocument XMLDocumentWithData:[NSData dataWithContentsOfFile:xmlFilePath] error:&error];
if (error || nil == document) {
     NSLog(@"[Error] %@", error);
     return nil;
}

3.獲取節點信息

ONOXMLDocument有個rootElement成員表示XML數據的根節點，其實一個ONOXMLElement結構對象。該結構用來描述每一個節點，每個節點的屬性都保存在該對象中，如:

除了上面直接的屬性外，還可以通過Ono提供的接口直接獲得相關信息

• -(id)valueForAttribute:(NSString *)attribute;

直接獲得這個節點的某個屬性。比如

<?xml version="1.0" encoding="utf-8"?>
<student name="pony">   </student>

要獲得student節點的name屬性,直接對student（tag為student）節點調用valueForAttribute：@“name” 即可。

• -(NSString *)stringValue;

將該節點的內容當成字符串，獲取該節點的字符串值。如：

<?xml version="1.0" encoding="utf-8"?>
<city> shenzhen     </city>

city節點(tag為city)的 stringValue 為“shenzhen”。

• -(NSNumber *)numberValue;

將該節點的內容當成數字，獲取該節點的數字內容。如：

<?xml version="1.0" encoding="utf-8"?>
<number> 1024   </number>   

number節點的numberValue為1024

• -(NSDate *)dateValue;
  將該節點當成日期進行解析，獲得該節點的日期內容。如：

  <?xml version="1.0" encoding="utf-8"?>
  <date> 2016-03-15 </date>

date節點的dateValue為NSDate表示的2016年3月15日，可見這里接口非常友好，Ono已經自動幫我們轉換成了NSDate類型。

4.獲取同類節點

為了方便使用Ono為我們封裝了一系列的遍歷接口，可以滿足基本的使用，如：

獲得指定tag的第一個元素

-(ONOXMLElement *)firstChildWithTag:(NSString *)tag;

如果用于
<?xml version="1.0" encoding="utf-8"?>
<city> shenzhen </city>
<city> shanghai </city>
傳入city會得到第一個"shenzhen"。

返回值為tag的所有子節點

-(NSArray *)childrenWithTag:(NSString *)tag;

如果對上面數據進行操作則可以得到"shanghai"、"shenzhen"組成的數組，一般對于數組較為常用。

按照索引返回第idx個子節點

-(id)objectAtIndexedSubscript:(NSUInteger)idx;

將節點按照順序進行排列，按照索引返回第idx個子節點。

5.通過選擇器獲取類型節點

如何在解析的過程中找到目標節點，或者怎么去遍歷節點元素，Ono支持兩種選擇器

XPath： XPath是XML文檔內容尋址語言，他將一個XML文檔建模成為一棵節點樹，有不同類型的節點，包括元素節點、屬性節點和正文節點。XPath定義了一種方法來計算每類的節點的字串值。簡單來說就是通過一級一級路徑找元素

CSS： CSS就是CSS那個描述HTML格式里面用到的選擇器方法，一般用于HTML，如使用#id來根據ID獲取元素,以及使用.class來根據class獲取元素.

因此Ono既支持標準格式的XML也支持HTML(HTML是XML的子集)。

Ono中通過ONOSearching協議定義了其選擇器接口：

//XPath API
- (id <NSFastEnumeration>)XPath:(NSString *)XPath;
- (void)enumerateElementsWithXPath:(NSString *)XPath
                       usingBlock:(void (^)(ONOXMLElement *element, NSUInteger idx, BOOL *stop))block;
- (ONOXMLElement *)firstChildWithXPath:(NSString *)XPath;      

//CSS API
- (id <NSFastEnumeration>)CSS:(NSString *)CSS;
- (void)enumerateElementsWithCSS:(NSString *)CSS
                     usingBlock:(void (^)(ONOXMLElement *element, NSUInteger idx, BOOL *stop))block;                     
- (ONOXMLElement *)firstChildWithCSS:(NSString *)CSS;                      

可以看到XPath的接口和CSS基本是對應一致的，其實也就是適用對象不同，CSS用于HTML，XPath用于XML，這里當然我們就以XPath來進行介紹。接口主要分成三類

獲得所有符合XPath描述的節點對象

(id <NSFastEnumeration>)XPath:(NSString *)XPath;

可以獲得獲得符合XPath描述的所有對象的一個可迭代對象，可以適用for...in...語法對其進行遍歷，然后取出每個ONOXMLElement進行相關操作。

獲得符合條件的第一個節點

(ONOXMLElement *)firstChildWithXPath:(NSString *)XPath;

字面意思以及說的很清楚了，就是獲得符合XPath描述的所有節點中的第一個節點。

遍歷符合的XPath節點

(void)enumerateElementsWithXPath:(NSString *)XPath 
                                 usingBlock:(void (^)(ONOXMLElement *element, NSUInteger idx, BOOL *stop))block;

手動獲得所有符合XPath定義的節點迭代器再進行操作，在代碼上面還是比較的不美觀，Ono結合OC的block特點，還為我們提供了一個用block遍歷節點的接口。該函數會將block運行于符合XPath定義的節點。

element表示所遍歷到的節點，idx表示其下標，該下標就是上面objectAtIndexedSubscript用到的下標， stop控制是否繼續遍歷，如果被設置為NO，則不繼續遍歷了。比如:

 NSString *XPath = @"http://food/name";
 NSLog(@"XPath Search: %@", XPath);
 [document enumerateElementsWithXPath:XPath usingBlock:^(ONOXMLElement *element, __unused NSUInteger idx, __unused BOOL *stop) {
     NSLog(@"%@", element);
 }];

會一次打印出所有food節點下的name節點。