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

Objective-C 解析 XML 與建構 JSON:從 NSXMLParser 到 SBJson 的完整實踐

編輯:iOS 開發綜合

網路通訊離不開資料格式。雖然 JSON 早已是主流,但仍有不少老舊後端介面吐 XML,因此兩種都要會。本文示範如何用 NSXMLParser 逐節點解析 XML,以及用 SBJson 完成 JSON 的解析與拼裝。

一、解析 XML

以下以解析本地檔案為例;若資料來自網路,只要把回應轉成 NSData 即可,後續流程完全相同。

待解析的 users.xml:

<?xml version="1.0" encoding="UTF-8"?>
<AllUsers>
  <message>用戶資訊</message>
  <user>
    <name>芳仔小腳印</name>
    <age>10</age>
    <school>JiangSu University</school>
  </user>
  <user>
    <name>毒蟲</name>
    <age>22</age>
    <school>NanJing University</school>
  </user>
  <user>
    <name>女神</name>
    <age>23</age>
    <school>HongKong University</school>
  </user>
</AllUsers>

目標是把每個 user 節點變成一個字典,全部收進陣列:

(
    { message = "用戶資訊"; },
    { age = 10; name = "芳仔小腳印"; school = "JiangSu University"; },
    { age = 22; name = "毒蟲";       school = "NanJing University"; },
    { age = 23; name = "女神";       school = "HongKong University"; }
)

步驟一:宣告代理

讓控制器遵守 NSXMLParserDelegate。

步驟二:啟動解析

// 「關鍵節點」:遇到它們就該新開一個字典來裝
NSArray *keyElements  = @[@"message", @"user"];

// 「欄位節點」:這些才是真正要存的值
NSArray *rootElements = @[@"message", @"name", @"age", @"school"];

// 取得檔案路徑並轉為 Data
NSString *xmlPath = [[NSBundle mainBundle] pathForResource:@"users" ofType:@"xml"];
NSData *data = [[NSData alloc] initWithContentsOfFile:xmlPath];

// 建立解析器
NSXMLParser *xmlParser = [[NSXMLParser alloc] initWithData:data];
xmlParser.delegate = self;

BOOL flag = [xmlParser parse];
NSLog(flag ? @"解析成功" : @"解析出錯");

解析過程需要幾個暫存變數,宣告在 .m 的 class extension 中:

NSString          *currentElement;   // 目前所處的欄位節點名
NSString          *currentValue;     // 目前累積到的文字值
NSMutableDictionary *rootDic;        // 目前這一組資料
NSMutableArray      *finalArray;     // 最終結果

步驟三:實作四個代理方法

NSXMLParser 是流式解析,它不一次給你整棵樹,而是像唱名一樣,遇到一個節點就通知你一次。理解這點,四個回調的職責就很清楚:

#pragma mark - 開始解析
- (void)parserDidStartDocument:(NSXMLParser *)parser
{
    finalArray = [[NSMutableArray alloc] init];
}

#pragma mark - 遇到開始標籤
- (void)parser:(NSXMLParser *)parser
didStartElement:(NSString *)elementName
  namespaceURI:(NSString *)namespaceURI
 qualifiedName:(NSString *)qName
    attributes:(NSDictionary *)attributeDict
{
    for (NSString *key in self.keyElements) {
        if ([elementName isEqualToString:key]) {
            // 關鍵節點開始 → 開一個新字典
            rootDic = [[NSMutableDictionary alloc] initWithCapacity:0];
        } else {
            for (NSString *element in self.rootElements) {
                if ([element isEqualToString:elementName]) {
                    currentElement = elementName;
                    currentValue   = [NSString string];
                }
            }
        }
    }
}

#pragma mark - 遇到文字內容
- (void)parser:(NSXMLParser *)parser foundCharacters:(NSString *)string
{
    if (currentElement) {
        currentValue = string;
        [rootDic setObject:string forKey:currentElement];
    }
}

#pragma mark - 遇到結束標籤
- (void)parser:(NSXMLParser *)parser
 didEndElement:(NSString *)elementName
  namespaceURI:(NSString *)namespaceURI
 qualifiedName:(NSString *)qName
{
    if (currentElement) {
        [rootDic setObject:currentValue forKey:currentElement];
        currentElement = nil;
        currentValue   = nil;
    }

    for (NSString *key in self.keyElements) {
        if ([elementName isEqualToString:key] && rootDic) {
            // 關鍵節點結束 → 把這組資料收進陣列
            [finalArray addObject:rootDic];
        }
    }
}

#pragma mark - 解析結束
- (void)parserDidEndDocument:(NSXMLParser *)parser
{
}

解析完成後列印 finalArray:

(
    { message = "用戶資訊"; },
    { age = 10; name = "芳仔小腳印"; school = "JiangSu University"; },
    { age = 22; name = "毒蟲";       school = "NanJing University"; },
    { age = 23; name = "女神";       school = "HongKong University"; }
)

一個實務上的坑:foundCharacters 可能被呼叫多次。長文字節點若含實體或跨區塊,系統會分段回傳,此例中直接覆寫 currentValue 會導致內容被截斷。嚴謹寫法應該用 appendString: 累加。

二、用 SBJson 處理 JSON

SBJson 是 iOS 早期常用的開源 JSON 庫(專案網址:https://www.superloopy.io/json-framework/)。

1. 基本解析

NSData *responseData = [respones responseData];
NSString *strResponser = [[NSString alloc] initWithData:responseData
                                              encoding:NSUTF8StringEncoding];
SBJsonParser *parser = [[SBJsonParser alloc] init];
NSMutableDictionary *dicMessageInfo = [parser objectWithString:strResponser];

NSString *sender = [dicMessageInfo objectForKey:@"sender"];
[parser release];

2. 嵌套結構的解析

遇到多層結構,逐層取出即可,不需要一次寫完:

NSData *responseData = [respones responseData];
NSString *strResponser = [[NSString alloc] initWithData:responseData
                                              encoding:NSUTF8StringEncoding];

SBJsonParser *parser = [[SBJsonParser alloc] init];
NSMutableDictionary *dicMessageInfo = [parser objectWithString:strResponser];

// 先取外層
NSMutableDictionary *cross = [dicMessageInfo objectForKey:@"cross"];
// 再取內層
NSString *cross1 = [cross objectForKey:@"1"];

[parser release];
NSLog(@"cross1: %@", cross1);

3. 拼裝 JSON 字串

SBJsonWriter 的 - (NSString *)stringWithObject:(id)value 能把符合 key/value 結構的 NSDictionary 直接序列化。其餘零碎欄位則用 NSMutableString 手工拼接:

- (void)appendString:(NSString *)aString;
- (void)appendFormat:(NSString *)format, ... NS_FORMAT_FUNCTION(1, 2);
- (NSString *)getJsonString
{
    NSMutableString *json = [NSMutableString stringWithCapacity:128];
    NSString *jsonString = nil;
    SBJsonWriter *writer = [[SBJsonWriter alloc] init];

    [json appendString:@"{\"data\":{"];
    [json appendFormat:@"\"%@\":\"%d\",", @"reset", reset];

    if (missionStatus != NULL) {
        jsonString = [writer stringWithObject:status];
        if (jsonString != NULL) {
            [json appendString:@"\"status\":"];
            [json appendString:jsonString];
        }
    }

    [json appendString:@"}}"];
    return json;
}

拼完後強烈建議丟到 https://jsonlint.com/ 驗證一次格式,手工拼接最容易漏引號或多了逗號。

4. 更穩妥的做法:用多層 NSDictionary 取代手工拼接

手工拼字串註定要與引號、逗號、轉義字元纏鬥。既然 SBJsonWriter 能序列化字典,那不如全程用字典建構結構:

NSDictionary *dataDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
    mac,         @"mac",
    game,        @"game",
    devicetoken, @"devicetoken",
    device,      @"device",
    gv,          @"gv",
    lang,        @"lang",
    os,          @"os",
    hardware,    @"hardware",
    down,        @"down",
    nil];

NSDictionary *parmDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
    @"getSession",  @"act",
    dataDictionary, @"data",
    nil];

NSDictionary *jsonDictionary = [NSDictionary dictionaryWithObjectsAndKeys:
    pv,            @"pv",
    parmDictionary, @"param",
    nil];

SBJsonWriter *writer = [[SBJsonWriter alloc] init];
NSString *jsonString = [writer stringWithObject:jsonDictionary];
NSLog(@"%@", jsonString);

這種寫法層次分明,改欄位時不必擔心漏掉標點,也不需要記憶轉義規則,是建構複雜嵌套結構時的首選。

補充:NSJSONSerialization

如果專案沒有歷史包袱,其實 iOS 5 之後就內建了 NSJSONSerialization,不必再引入第三方庫:

NSData *data = [NSJSONSerialization JSONObjectWithData:responseData
                                               options:NSJSONReadingMutableContainers
                                                 error:&error];

NSData *jsonData = [NSJSONSerialization dataWithJSONObject:jsonDictionary
                                                  options:0
                                                    error:&error];

本文保留 SBJson 的寫法,是因為仍有大量維護中的老專案在用,看懂它比重新發明輪子實際。

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