使用Ono讀取XML文件

使用Ono讀取XML文件

在做App的過程中日丹,讀取XML文件是最常見的功能之一。并且在iOS的發(fā)展過程中涌現(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)樹”)忠聚,之后就通過遍歷樹結(jié)構(gòu)可以檢索任意XML節(jié)點(diǎn)设哗,讀取它的屬性和值。而起通常情況下两蟀,可以借助XPath网梢,直接查詢XML節(jié)點(diǎn)。
SAX解析XML赂毯,是基于事件通知的模式战虏,一邊讀取XML文檔一邊處理,不必等整個(gè)文檔加載完之后才采取操作党涕,當(dāng)在讀取解析過程中遇到需要處理的對(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一樣友好的接口蚜锨。

不過現(xiàn)在的Ono有點(diǎn)比較坑的是沒有提供修改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)是否為空

除了上面直接的屬性外西土,還可以通過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.通過選擇器獲取類型節(jié)點(diǎn)

如何在解析的過程中找到目標(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ō)就是通過一級(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中通過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)系作者
  • 序言:七十年代末弄跌,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子尝苇,更是在濱河造成了極大的恐慌铛只,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,686評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件糠溜,死亡現(xiàn)場(chǎng)離奇詭異淳玩,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)非竿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,668評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門蜕着,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人红柱,你說(shuō)我怎么就攤上這事承匣”统耍” “怎么了?”我有些...
    開封第一講書人閱讀 158,160評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵悄雅,是天一觀的道長(zhǎng)驱敲。 經(jīng)常有香客問我,道長(zhǎng)宽闲,這世上最難降的妖魔是什么众眨? 我笑而不...
    開封第一講書人閱讀 56,736評(píng)論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮容诬,結(jié)果婚禮上娩梨,老公的妹妹穿的比我還像新娘。我一直安慰自己览徒,他們只是感情好狈定,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,847評(píng)論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著习蓬,像睡著了一般纽什。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上躲叼,一...
    開封第一講書人閱讀 50,043評(píng)論 1 291
  • 那天芦缰,我揣著相機(jī)與錄音,去河邊找鬼枫慷。 笑死让蕾,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的或听。 我是一名探鬼主播探孝,決...
    沈念sama閱讀 39,129評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼誉裆!你這毒婦竟也來(lái)了顿颅?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,872評(píng)論 0 268
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤足丢,失蹤者是張志新(化名)和其女友劉穎元镀,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體霎桅,經(jīng)...
    沈念sama閱讀 44,318評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,645評(píng)論 2 327
  • 正文 我和宋清朗相戀三年讨永,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了滔驶。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,777評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡卿闹,死狀恐怖揭糕,靈堂內(nèi)的尸體忽然破棺而出萝快,到底是詐尸還是另有隱情,我是刑警寧澤著角,帶...
    沈念sama閱讀 34,470評(píng)論 4 333
  • 正文 年R本政府宣布揪漩,位于F島的核電站,受9級(jí)特大地震影響吏口,放射性物質(zhì)發(fā)生泄漏奄容。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,126評(píng)論 3 317
  • 文/蒙蒙 一产徊、第九天 我趴在偏房一處隱蔽的房頂上張望昂勒。 院中可真熱鬧,春花似錦舟铜、人聲如沸戈盈。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,861評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)塘娶。三九已至,卻和暖如春痊夭,著一層夾襖步出監(jiān)牢的瞬間刁岸,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,095評(píng)論 1 267
  • 我被黑心中介騙來(lái)泰國(guó)打工生兆, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留难捌,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,589評(píng)論 2 362
  • 正文 我出身青樓鸦难,卻偏偏與公主長(zhǎng)得像根吁,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子合蔽,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,687評(píng)論 2 351

推薦閱讀更多精彩內(nèi)容