您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發綜合

iOS XML 解析:NSXMLParser 的事件驅動模式與委派回呼完整說明

編輯:iOS 開發綜合

iOS SDK 內建的 NSXMLParser 採用事件驅動模式解析 XML,本質上是 SAX 而非 DOM。它自己不保存任何解析結果,遇到元素、屬性、CDATA 區塊、註解等結構時,就通知 delegate 並交由 delegate 全權處理,同時也會回報錯誤。

理解這個前提很重要:你寫的 delegate 方法就是解析器的全部狀態管理責任所在。這也是 SAX 模式省記憶體的原因,但代價是程式碼需要自己維護上下文。

步驟一:讀取檔案內容到 NSData

NSString *path = [[NSBundle mainBundle] pathForResource:@"filename" ofType:@"xml"];
NSFileHandle *file = [NSFileHandle fileHandleForReadingAtPath:path];
NSData *data = [file readDataToEndOfFile];
[file closeFile];

步驟二:建立 parser 並設定 delegate

NSXMLParser *m_parser = [[NSXMLParser alloc] initWithData:data];
[m_parser setDelegate:self];   // 該類別宣告時需實作 NSXMLParserDelegate 協議

BOOL flag = [m_parser parse];
if (flag) {
    NSLog(@"獲取指定路徑的 xml 文件成功");
} else {
    NSLog(@"獲取指定路徑的 xml 文件失敗");
}
[m_parser release];

除了從 NSData 初始化,也可以直接從 URL 建立:

NSXMLParser *parser = [[NSXMLParser alloc] initWithContentsOfURL:[NSURL URLWithString:urlString]];

封裝成一個方法會更整齊:

- (void)parseXMLFileAtURL:(NSURL *)URL parseError:(NSError **)error {
    NSXMLParser *parser = [[NSXMLParser alloc] initWithContentsOfURL:URL];
    [parser setDelegate:self];
    [parser setShouldProcessNamespaces:NO];
    [parser setShouldReportNamespacePrefixes:NO];
    [parser setShouldResolveExternalEntities:NO];
    [parser parse];

    NSError *parseError = [parser parserError];
    if (parseError && error) {
        *error = parseError;
    }
    [parser release];
}

這三個設定各有用途。setShouldProcessNamespaces: 控制是否把命名空間拆解到 elementName 中;setShouldReportNamespacePrefixes: 決定是否回報前綴資訊;setShouldResolveExternalEntities: 設為 NO 可以避免解析器去下載外部 DTD 實體——這在處理不可信的 XML 時是重要的安全設定,能降低 XXE(XML External Entity)攻擊風險。

步驟三:實作委派回呼

呼叫 [parser parse] 後,程式就會開始跳進各個 delegate 方法。整個 XML 會被遍歷一次,解析器識別每個元素名稱,你在其中建立容器以便日後儲存資料;實際的存入動作通常在 didEndElement 中完成。

解析開始時的初始化:

// 宣告實例變數 dataDict 與 parserObjects
- (void)parserDidStartDocument:(NSXMLParser *)parser {
    dataDict = [[NSMutableDictionary alloc] initWithCapacity:0];  // 每一條資訊用字典存
    parserObjects = [[NSMutableArray alloc] init];                // 每一組資訊用陣列存
}

遇到開始標籤:這個方法可以取得節點開頭的值與屬性。例如遇到 <book catalog="Programming">,所有屬性都會放在 attributeDict 中。

- (void)parser:(NSXMLParser *)parser
didStartElement:(NSString *)elementName
   namespaceURI:(NSString *)namespaceURI
  qualifiedName:(NSString *)qualifiedName
     attributes:(NSDictionary *)attributeDict {
    if ([elementName isEqualToString:@"book"]) {
        NSString *catalog = [attributeDict objectForKey:@"catalog"];
    } else if (...) {
        // ……
    }
}

讀取標籤之間的文字:

- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string {
    // 記錄所取得的文字
}

- (void)parser:(NSXMLParser *)parser foundCDATA:(NSData *)CDATABlock {
    // NSLog(@"cData:%@", [NSString stringWithUTF8String:[CDATABlock bytes]]);
}

遇到結束標籤:此處是「一個標籤完成」的時機,通常也是把累積到的內容寫進容器的位置。

- (void)parser:(NSXMLParser *)parser
  didEndElement:(NSString *)elementName
   namespaceURI:(NSString *)namespaceURI
  qualifiedName:(NSString *)qName {
    // 把該元素的資料存入 dataDict / parserObjects
}

解析結束:

- (void)parserDidEndDocument:(NSXMLParser *)parser {
    // 後續整理、通知 UI 更新
}

實作上最容易踩的三個坑

第一,foundCharacters 會被分多次呼叫。這是 SAX 解析最典型的陷阱。當文字節點中夾雜 CDATA、註解或實體參照時,解析器可能把同一段文字拆成數次回呼。因此絕對不能在 foundCharacters 中直接 append 就當完成,正確做法是用一個 NSMutableString 暫存,在 didEndElement 時才取出使用並清空。否則你會看到文字被切碎或重複。

第二,delegate 物件必須存活到解析結束。若 delegate 是某個 view controller,而解析過程中該物件被釋放,回呼就會失效。同步解析(在當前執行緒呼叫 parse)時這通常不是問題,但若你把解析放到背景執行緒,就要自行確保生命週期。

第三,同步解析會凍結 UI。[parser parse] 是阻塞式的,大檔案在主執行緒解析會讓界面完全無回應。實務上應放到背景佇列,完成後再回主執行緒更新 UI。另外記得實作 parser:parseErrorOccurred:,把錯誤資訊往上傳,而不是讓解析失敗靜默發生。

什麼情況該改用其他方案

NSXMLParser 的優勢是系統內建、無需外部相依、記憶體占用低。但若你的 XML 需要隨機存取(例如依 XPath 抓某個節點、或需要回頭讀父節點),SAX 模式會非常痛苦,因為你得自己在 delegate 中維護完整的樹狀結構——那等於重新實作一次 DOM。

這類需求下,改用 NSXMLDocument(原為第三方 KissXML,後由 Foundation 提供)或直接換用 JSON 格式會更合適。選擇解析方式的判斷標準很簡單:只需要循序讀一遍,用 NSXMLParser;需要任意跳查,用樹狀 API。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved