使用Ono讀取XML文件

使用Ono讀取XML文件

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

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

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

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

從上面來(lái)看，后兩者可以滿足各種場(chǎng)景，只是使用上面偏向復(fù)雜，尤其是libxml2還是C接口。而今天我們要介紹的是Ono就是對(duì)這個(gè)C接口的libxml2的一層OC友好接口的封裝，這個(gè)接口是誰(shuí)設(shè)計(jì)的呢？靠譜么？

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

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

不過(guò)現(xiàn)在的Ono有點(diǎn)比較坑的是沒(méi)有提供修改XML的接口，僅可用于讀取的XML(如配置文件、數(shù)據(jù)文件)的場(chǎng)景(客戶端更多的場(chǎng)景還是解析XML)。

1. 集成Ono

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

pod 'Ono'

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

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

#import <Ono/Ono.h>

即可。

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

2. 加載XML數(shù)據(jù)

XML數(shù)據(jù)對(duì)象由ONOXMLDocument來(lái)表示。其可以從NSData或者NSString中進(jìn)行加載。

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

encoding參數(shù)表示數(shù)據(jù)的格式，可以從文件中讀取數(shù)據(jù)內(nèi)容到NSData中，然后從NSData中進(jìn)行解析得到一個(gè)ONOXMLDocument。如：

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

3.獲取節(jié)點(diǎn)信息

ONOXMLDocument有個(gè)rootElement成員表示XML數(shù)據(jù)的根節(jié)點(diǎn)，其實(shí)一個(gè)ONOXMLElement結(jié)構(gòu)對(duì)象。該結(jié)構(gòu)用來(lái)描述每一個(gè)節(jié)點(diǎn)，每個(gè)節(jié)點(diǎn)的屬性都保存在該對(duì)象中，如:

屬性 類型 意義說(shuō)明
tag NSString 節(jié)點(diǎn)的名字
lineNumber NSUInteger 所在行號(hào)
attributes NSDictionary 節(jié)點(diǎn)屬性
parent ONOXMLElement 父親節(jié)點(diǎn)
children NSArray 子節(jié)點(diǎn)
previousSibling ONOXMLElement 左（前一個(gè)）兄弟節(jié)點(diǎn)
nextSibling ONOXMLElement 右兄弟節(jié)點(diǎn)
blank BOOL 節(jié)點(diǎn)是否為空

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

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

直接獲得這個(gè)節(jié)點(diǎn)的某個(gè)屬性。比如

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

要獲得student節(jié)點(diǎn)的name屬性,直接對(duì)student（tag為student）節(jié)點(diǎn)調(diào)用valueForAttribute：@“name” 即可。

  • -(NSString *)stringValue;

將該節(jié)點(diǎn)的內(nèi)容當(dāng)成字符串，獲取該節(jié)點(diǎn)的字符串值。如：

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

city節(jié)點(diǎn)(tag為city)的 stringValue 為“shenzhen”。

  • -(NSNumber *)numberValue;

將該節(jié)點(diǎn)的內(nèi)容當(dāng)成數(shù)字，獲取該節(jié)點(diǎn)的數(shù)字內(nèi)容。如：

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

number節(jié)點(diǎn)的numberValue為1024

  • -(NSDate *)dateValue;
    將該節(jié)點(diǎn)當(dāng)成日期進(jìn)行解析，獲得該節(jié)點(diǎn)的日期內(nèi)容。如：

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

date節(jié)點(diǎn)的dateValue為NSDate表示的2016年3月15日，可見這里接口非常友好，Ono已經(jīng)自動(dòng)幫我們轉(zhuǎn)換成了NSDate類型。

4.獲取同類節(jié)點(diǎn)

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

獲得指定tag的第一個(gè)元素

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

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

返回值為tag的所有子節(jié)點(diǎn)

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

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

按照索引返回第idx個(gè)子節(jié)點(diǎn)

-(id)objectAtIndexedSubscript:(NSUInteger)idx;

將節(jié)點(diǎn)按照順序進(jìn)行排列，按照索引返回第idx個(gè)子節(jié)點(diǎn)。

5.通過(guò)選擇器獲取類型節(jié)點(diǎn)

如何在解析的過(guò)程中找到目標(biāo)節(jié)點(diǎn)，或者怎么去遍歷節(jié)點(diǎn)元素，Ono支持兩種選擇器

XPath： XPath是XML文檔內(nèi)容尋址語(yǔ)言，他將一個(gè)XML文檔建模成為一棵節(jié)點(diǎn)樹，有不同類型的節(jié)點(diǎn)，包括元素節(jié)點(diǎn)、屬性節(jié)點(diǎn)和正文節(jié)點(diǎn)。XPath定義了一種方法來(lái)計(jì)算每類的節(jié)點(diǎn)的字串值。簡(jiǎn)單來(lái)說(shuō)就是通過(guò)一級(jí)一級(jí)路徑找元素

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

因此Ono既支持標(biāo)準(zhǔn)格式的XML也支持HTML(HTML是XML的子集)。

Ono中通過(guò)ONOSearching協(xié)議定義了其選擇器接口：

//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基本是對(duì)應(yīng)一致的，其實(shí)也就是適用對(duì)象不同，CSS用于HTML，XPath用于XML，這里當(dāng)然我們就以XPath來(lái)進(jìn)行介紹。接口主要分成三類

獲得所有符合XPath描述的節(jié)點(diǎn)對(duì)象

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

可以獲得獲得符合XPath描述的所有對(duì)象的一個(gè)可迭代對(duì)象，可以適用for...in...語(yǔ)法對(duì)其進(jìn)行遍歷，然后取出每個(gè)ONOXMLElement進(jìn)行相關(guān)操作。

獲得符合條件的第一個(gè)節(jié)點(diǎn)

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

字面意思以及說(shuō)的很清楚了，就是獲得符合XPath描述的所有節(jié)點(diǎn)中的第一個(gè)節(jié)點(diǎn)。

遍歷符合的XPath節(jié)點(diǎn)

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

手動(dòng)獲得所有符合XPath定義的節(jié)點(diǎn)迭代器再進(jìn)行操作，在代碼上面還是比較的不美觀，Ono結(jié)合OC的block特點(diǎn)，還為我們提供了一個(gè)用block遍歷節(jié)點(diǎn)的接口。該函數(shù)會(huì)將block運(yùn)行于符合XPath定義的節(jié)點(diǎn)。

element表示所遍歷到的節(jié)點(diǎn)，idx表示其下標(biāo)，該下標(biāo)就是上面objectAtIndexedSubscript用到的下標(biāo)， stop控制是否繼續(xù)遍歷，如果被設(shè)置為NO，則不繼續(xù)遍歷了。比如:

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

會(huì)一次打印出所有food節(jié)點(diǎn)下的name節(jié)點(diǎn)。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 發(fā)現(xiàn) 關(guān)注 消息 iOS 第三方庫(kù)、插件、知名博客總結(jié) 作者大灰狼的小綿羊哥哥關(guān)注 2017.06.26 09:4...
    肇東周閱讀 15,296評(píng)論 4贊 61
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,554評(píng)論 19贊 139
  • 1. XML總結(jié) 1.1. XML簡(jiǎn)介 XML : 可擴(kuò)展的標(biāo)記語(yǔ)言。（和HTML非常類似的） 可擴(kuò)展的。 自定義...
    Ethan_Walker閱讀 3,375評(píng)論 0贊 12
  • 本文參加#感悟三下鄉(xiāng)，青春筑夢(mèng)行#活動(dòng)，本人承諾，文章內(nèi)容為原創(chuàng)，且未在其他平臺(tái)發(fā)表過(guò)。 時(shí)間過(guò)得很快，暑期實(shí)...
    安徽財(cái)經(jīng)大學(xué)新時(shí)代新青年閱讀 772評(píng)論 0贊 8
  • 1. if his job need him to do, this job isn't worth for you
    享悅moonlight閱讀 353評(píng)論 0贊 0

友情鏈接更多精彩內(nèi)容