NSXMLParser 的 delegate 寫法有個老問題:回调和業務邏輯散落在各處,一個頁面要解析兩種 XML 就得寫兩套。用 Block 把回調打包起來,呼叫端就能寫成「一氣呵成」的形式。
- (void)loadXML {
NSURL *url = [NSURL URLWithString:@"https://www.baidu.com?format=xml"];
NSURLRequest *request = [NSURLRequest requestWithURL:url
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:2.0f];
NSURLResponse *response = nil;
NSError *error = nil;
NSData *data = [NSURLConnection sendSynchronousRequest:request
returningResponse:&response
error:&error];
MyXMLParser *myParser = [[MyXMLParser alloc] init];
if (self.dataList == nil) {
self.dataList = [NSMutableArray array];
} else {
[self.dataList removeAllObjects];
}
[myParser xmlParserWithData:data
StartName:@"video"
startElement:^(NSDictionary *dict) {
self.currentVideo = [[Video alloc] init];
self.currentVideo.videoId = [dict[@"videoId"] integerValue];
} endElement:^(NSString *elementName, NSString *result) {
if ([elementName isEqualToString:@"name"]) {
self.currentVideo.name = result;
} else if ([elementName isEqualToString:@"length"]) {
self.currentVideo.length = [result integerValue];
} else if ([elementName isEqualToString:@"video"]) {
[self.dataList addObject:self.currentVideo];
}
} finishedParser:^{
self.currentVideo = nil;
[self.tableView reloadData];
} errorParser:^{
self.currentVideo = nil;
[self.dataList removeAllObjects];
}];
}
四個 Block 分別對應四個時機:遇到目標節點、每個節點結束、文件解析完畢、解析出錯。呼叫端完全不需要知道 NSXMLParserDelegate 的存在。
typedef void(^startElementBlock)(NSDictionary *dict);
typedef void(^endElementBlock)(NSString *elementName, NSString *result);
typedef void(^xmlParserNotificationBlock)();
@interface MyXMLParser : NSObject
- (void)xmlParserWithData:(NSData *)data
StartName:(NSString *)startName
startElement:(startElementBlock)startElement
endElement:(endElementBlock)endElement
finishedParser:(xmlParserNotificationBlock)finishedParser
errorParser:(xmlParserNotificationBlock)errorParser;
@end
把 Block 型別用 typedef 命名,是這裡最值得學的習慣。否則方法宣告會长到難以閱讀,維護時也容易出錯。
@interface MyXMLParser () <NSXMLParserDelegate> {
startElementBlock _startElementBlock;
endElementBlock _endElementBlock;
xmlParserNotificationBlock _finishedBlock;
xmlParserNotificationBlock _errorBlock;
}
@property (strong, nonatomic) NSString *startElementName; // 目標節點名,如 video
@property (strong, nonatomic) NSMutableString *elementString; // 中轉字串
@end
@implementation MyXMLParser
- (void)xmlParserWithData:(NSData *)data
StartName:(NSString *)startName
startElement:(startElementBlock)startElement
endElement:(endElementBlock)endElement
finishedParser:(xmlParserNotificationBlock)finishedParser
errorParser:(xmlParserNotificationBlock)errorParser {
self.startElementName = startName;
_startElementBlock = startElement;
_endElementBlock = endElement;
_finishedBlock = finishedParser;
_errorBlock = errorParser;
NSXMLParser *parser = [[NSXMLParser alloc] initWithData:data];
[parser setDelegate:self];
[parser parse];
}
Block 必須先存成成員變數,delegate 方法才有辦法呼叫到它。這是整個封裝能成立的關鍵。
// 1. 文件開始:初始化中轉字串,不需對外互動
- (void)parserDidStartDocument:(NSXMLParser *)parser {
if (self.elementString == nil) {
self.elementString = [NSMutableString string];
}
}
// 2. 進入目標節點:需要對外互動,傳出屬性字典
- (void)parser:(NSXMLParser *)parser
didStartElement:(NSString *)elementName
namespaceURI:(NSString *)namespaceURI
qualifiedName:(NSString *)qName
attributes:(NSDictionary *)attributeDict {
if ([elementName isEqualToString:self.startElementName]) {
_startElementBlock(attributeDict);
}
[self.elementString setString:@""]; // 進入下一輪前清空
}
// 3. 發現文字:只需拼接,不需對外互動
- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string {
[self.elementString appendString:string];
}
// 4. 節點結束:依名稱與拼接結果判定,需要對外互動
- (void)parser:(NSXMLParser *)parser
didEndElement:(NSString *)elementName
namespaceURI:(NSString *)namespaceURI
qualifiedName:(NSString *)qName {
NSString *result = [NSString stringWithString:self.elementString];
_endElementBlock(elementName, result);
}
// 5. 全部結束:通知呼叫方刷新
- (void)parserDidEndDocument:(NSXMLParser *)parser {
[self.elementString setString:@""];
_finishedBlock();
}
// 出錯:通知呼叫方,並清空暫存
- (void)parser:(NSXMLParser *)parser parseErrorOccurred:(NSError *)parseError {
NSLog(@"解析出錯:%@", parseError.localizedDescription);
[self.elementString setString:@""];
_errorBlock();
}
@end
這個封裝的判断標準是「這個回調需不需要與外部互動」。foundCharacters 只是把字串 append 起來,屬於內部狀態維護,因此不必對外;而 didStartElement 要傳出屬性、didEndElement 要傳出節點值,就必須開一個 Block 讓呼叫端處理。
兩個實務提醒。第一,Block 會強引用呼叫端,若呼叫端又持有 parser,容易形成 retain cycle,必要時在 Block 內使用 weak self。第二,elementString 在每個節點結束後都要清空,否則下一個節點的值會被接在後面,這是新手最常遇到的「文字變長」bug。
另外,sendSynchronousRequest 會阻塞主線程,正式專案請改用 NSURLSession 的非同步任務;XML 解析若資料量大,也建議放到背景佇列執行,再回主線程更新 UI。