使用Ono讀取XML文件

使用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結構對象。該結構用來描述每一個節點,每個節點的屬性都保存在該對象中,如:

屬性 類型 意義說明
tag NSString 節點的名字
lineNumber NSUInteger 所在行號
attributes NSDictionary 節點屬性
parent ONOXMLElement 父親節點
children NSArray 子節點
previousSibling ONOXMLElement 左(前一個)兄弟節點
nextSibling ONOXMLElement 右兄弟節點
blank BOOL 節點是否為空

除了上面直接的屬性外,還可以通過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節點。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,732評論 6 539
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,214評論 3 426
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,781評論 0 382
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,588評論 1 316
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,315評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,699評論 1 327
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,698評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,882評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,441評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,189評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,388評論 1 372
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,933評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,613評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,023評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,310評論 1 293
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,112評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,334評論 2 377

推薦閱讀更多精彩內容