您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 使用技巧 >> iOS 技巧大全

iOS 解析 XML:以 NSXMLParser 與 SAX 模式實作

編輯:iOS 技巧大全

前陣子想試著用豆瓣的 API 做點東西,於是碰上了 XML 解析這個問題。當時老師還沒教到,只能自己查。

SAX 與 DOM 的選擇

XML 解析主要有 SAX 與 DOM 兩種模式,iOS 上兩者都可用。DOM 會把整份文件載入記憶體形成樹狀結構,適合需要隨機存取或修改的場景;SAX 則是流式解析,由解析器由上往下掃描,遇到特定結構就觸發回呼,記憶體佔用量小、速度快,但無法回頭修改。本文選擇 SAX 模式。

核心類別

iOS 解析 XML 用的是自帶的 NSXML 框架,核心是 NSXMLParser 類別與它的代理協定 NSXMLParserDelegate。主要的解析工作都在代理的實作類別中完成。代理中定義了許多回呼方法,在解析器由上往下遍歷文件的過程中,遇到文件開始、標籤開始、字串、標籤結束、文件結束時就會觸發對應方法。

五個常用的代理方法

文件開始時觸發:

- (void)parserDidStartDocument:(NSXMLParser *)parser

遇到新標籤時觸發。其中 namespaceURI 是命名空間,qualifiedName 是限定名,attributes 是字典型別的屬性集合:

- (void)parser:(NSXMLParser *)parser
    didStartElement:(NSString *)elementName
       namespaceURI:(NSString *)namespaceURI
      qualifiedName:(NSString *)qName
         attributes:(NSDictionary *)attributeDict

找到字串時觸發:

- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string

遇到結束標籤時觸發:

- (void)parser:(NSXMLParser *)parser
      didEndElement:(NSString *)elementName
       namespaceURI:(NSString *)namespaceURI
      qualifiedName:(NSString *)qName

文件結束時觸發:

- (void)parserDidEndDocument:(NSXMLParser *)parser

準備解析的 XML 檔

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <person id="1">
        <firstName>Wythe</firstName>
        <lastName>xu</lastName>
        <age>22</age>
    </person>
    <person id="2">
        <firstName>li</firstName>
        <lastName>si</lastName>
        <age>31</age>
    </person>
    <person id="3">
        <firstName>Dipen</firstName>
        <lastName>Shah</lastName>
        <age>24</age>
    </person>
</root>

ViewController.h

#import <UIKit/UIKit.h>

@interface ViewController : UIViewController <NSXMLParserDelegate>

@property NSXMLParser *parser;
@property NSMutableArray *person;
@property NSString *currenttag;

@end

ViewController.m

#import "ViewController.h"

@interface ViewController ()
@end

@implementation ViewController

@synthesize parser = _parser, person = _person, currenttag = _currenttag;

- (id)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil
{
    self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
    if (self) {
        // Custom initialization
    }
    return self;
}

- (void)viewDidLoad
{
    [super viewDidLoad];

    NSString *xmlFilePath = [[NSBundle mainBundle] pathForResource:@"info" ofType:@"xml"];
    NSData *data = [[NSData alloc] initWithContentsOfFile:xmlFilePath];
    self.parser = [[NSXMLParser alloc] initWithData:data];
    self.parser.delegate = self;
    [self.parser parse];
    NSLog(@"%@", _person);
}

- (void)didReceiveMemoryWarning
{
    [super didReceiveMemoryWarning];
}

#pragma mark delegate method

- (void)parserDidStartDocument:(NSXMLParser *)parser
{
    _person = [[NSMutableArray alloc] init];
    NSLog(@"start parse 1");
}

- (void)parser:(NSXMLParser *)parser
    didStartElement:(NSString *)elementName
       namespaceURI:(NSString *)namespaceURI
      qualifiedName:(NSString *)qName
         attributes:(NSDictionary *)attributeDict
{
    _currenttag = elementName;
    if ([_currenttag isEqualToString:@"person"]) {
        NSString *_id = [attributeDict objectForKey:@"id"];
        NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];
        [dict setObject:_id forKey:@"id"];
        [_person addObject:dict];
    }
    NSLog(@"start element");
}

- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string
{
    NSMutableDictionary *dict = [_person lastObject];
    if ([_currenttag isEqualToString:@"firstName"] && dict) {
        [dict setObject:string forKey:@"firstName"];
    }
    if ([_currenttag isEqualToString:@"lastName"] && dict) {
        [dict setObject:string forKey:@"lastName"];
    }
    if ([_currenttag isEqualToString:@"age"] && dict) {
        [dict setObject:string forKey:@"age"];
    }
    NSLog(@"found characters");
}

- (void)parser:(NSXMLParser *)parser
      didEndElement:(NSString *)elementName
       namespaceURI:(NSString *)namespaceURI
      qualifiedName:(NSString *)qName
{
    _currenttag = nil;
    NSLog(@"end element");
}

- (void)parserDidEndDocument:(NSXMLParser *)parser
{
    NSLog(@"parse end");
}

@end

解析流程觀察

透過中斷點與輸出訊息,可以看到整個解析順序是:文件開始 → 標籤開始 → 找到字串 → 標籤結束 → 文件結束,不斷循環:

2014-09-10 16:45:32.920 xmlforblog[3820:60b] start parse 1
2014-09-10 16:45:32.921 xmlforblog[3820:60b] start element
2014-09-10 16:45:32.922 xmlforblog[3820:60b] found characters
...
2014-09-10 16:45:32.936 xmlforblog[3820:60b] parse end

最終結果:

(
    { age = 22; firstName = Wythe; id = 1; lastName = xu; },
    { age = 31; firstName = li;    id = 2; lastName = si; },
    { age = 24; firstName = Dipen; id = 3; lastName = Shah; }
)

處理邏輯的兩個關鍵點

我們的處理主要落在標籤開始與找到字串這兩個方法中。

標籤開始時,先判斷標籤名稱。如果是 person,代表接下來就是一個人的資料,於是建立一個可變字典並把 id 屬性存進去:

- (void)parser:(NSXMLParser *)parser
    didStartElement:(NSString *)elementName
       namespaceURI:(NSString *)namespaceURI
      qualifiedName:(NSString *)qName
         attributes:(NSDictionary *)attributeDict
{
    _currenttag = elementName;
    if ([_currenttag isEqualToString:@"person"]) {
        NSString *_id = [attributeDict objectForKey:@"id"];
        NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];
        [dict setObject:_id forKey:@"id"];
        [_person addObject:dict];
    }
    NSLog(@"start element");
}

找到字串時,依當前標籤名把值存進剛才建立的字典:

- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string
{
    NSMutableDictionary *dict = [_person lastObject];
    if ([_currenttag isEqualToString:@"firstName"] && dict) {
        [dict setObject:string forKey:@"firstName"];
    }
    if ([_currenttag isEqualToString:@"lastName"] && dict) {
        [dict setObject:string forKey:@"lastName"];
    }
    if ([_currenttag isEqualToString:@"age"] && dict) {
        [dict setObject:string forKey:@"age"];
    }
    NSLog(@"found characters");
}

不斷循環這個過程,最後就能解析出整份 XML 文件。

命名空間的坑

最後補充一點:以上只處理一般的 XML。如果你照著這套程式碼去解析豆瓣 API 的 XML,會發現行不通。原因是許多網站資料量大、欄位名稱可能重複,因此採用了命名空間(namespace)。帶命名空間的文件,elementName 與 qName 的內容不同,判斷邏輯需要改為比對 qName(例如 ns:person),或在 NSXMLParser 初始化時不要關閉 shouldProcessNamespaces,並改用 namespaceURI 做判斷。

兩個實務提醒

foundCharacters 可能被多次呼叫。 依 XML 內容與編碼,同一段文字可能被切分成好幾次回呼,特別是文字中包含實體參照(如 &amp;)時。穩健的做法是用一個 NSMutableString 暫存,在 didEndElement: 時才把完整字串寫入。

考慮改用 JSON。 若 API 同時提供 JSON 格式,優先使用 JSON——NSJSONSerialization 一行就能完成解析,程式碼量與錯誤率都遠低於 SAX。XML 主要用於必須對接既有系統或 SOAP 服務的情境。

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