iOS开发之——XML/json数据解析

引子

数据解析在iOS开发中是不可或缺的一环,从服务器获取到的数据,就目前来说无非就是XML和json两种。今天我就来总结一下iOS平台下,常用的几种解析数据的方法及步骤。

XML文件解析

关于XML文档格式,这里不再赘述。XML百科介绍XML菜鸟学习。 关于XML解析,大致有两种方式:

  1. SAX(Simple API for XML):事件驱动机制。从根元素开始,按顺序一个个元素往下解析,它只在XML文档中查找特定条件的内容,并且只提取需要的东西,占用内存少,也比较灵活,所以适合解析大文件。
  2. DOM(Document Object Model):文档对象模型。一次性将整个XML文档加载进内存,放在一个树型结构中,需要的时候查找特定节点。实现简单,读写平衡,但是比较占内存,适合解析小文件。
  3. 这里我使用的XML例子如下:(中间很长的一坨只是为了说明自带的解析器并不会一下子把节点之间的所有字符串给解析完)。
<?xml version="1.0" encoding="UTF-8"?>
<Books>
<Book id="1">
<title>月亮与六便士</title>
<author>毛姆</author>
<summary>上帝的磨盘磨得很慢,却磨得很细上帝的磨盘磨得
很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很细上帝的磨盘
磨得很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很细上帝的
磨盘磨得很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很细上
帝的磨盘磨得很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很
</summary>
</Book>
<Book id="2">
<title>岛上书店</title>
<author>加布瑞埃拉·泽文</author>
<summary>小岛上书店的老板和他的书店</summary>
</Book>
<Book id="3">
<title>白夜行</title>
<author>东野圭吾</author>
<summary>畸形但却最深沉的爱情</summary>
</Book>
</Books>

NSXMLParser解析

NSXMLParser是iOS系统自带的解析类,属于SAX解析方式,在解析到每个元素的时候会通知代理,所以使用NSXMLParser必须遵守它的代理协议。

1. 使用步骤:

//1. 创建XML解析器
NSXMLParser *parser = [[NSXMLParser alloc]initWithData:self.xmlData];
//2. 设置解析器的代理
parser.delegate = self;
//3. 开始解析
[parser parse];

2. 代理方法

// 1. 打开文档,准备解析,一般在这里边用来将保存数据的数组暂时清空
- (void)parserDidStartDocument:(NSXMLParser *)parser;

//2. 发现节点。一般在这里主要进行数据模型的初始化和读取节点的属性值
- (void)parser:(NSXMLParser *)parser didStartElement:(NSString *)elementName
namespaceURI:(NSString *)namespaceURI
qualifiedName:(NSString *)qName
attributes:(NSDictionary<NSString *,NSString *> *)attributeDict
{
//节点的属性值是以字典的形式传递进来的,所以取的时候也按字典的读取方法取出来就行
self.book.bookID = [attributeDict[@"id"] integerValue];

//在准备开始解析下一个节点的数据时,先把数据清空
[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
{
//如果遇到了结束节点符号,则进行数据的保存
if ([elementName isEqualToString:@"Book"])
{
[self.books addObject:self.book];
}

//如果既不是数据的最后一个节点,也不是根节点,即为数据中间的节点,则将数据对应保存到模型中
//运用KVC保存,效率高,不过属性的名字一定要和节点的名称相对应
else if(![elementName isEqualToString:@"Books"])
{
[self.book setValue:self.elementString forKey:elementName];
}
//如果节点较少,也可以通过下边这种手动赋值的方式
else if ([elementName isEqualToString:@"title"])
{
self.book.title = self.elementString;
}
}

//5. 文档解析结束,可以把数据传递给主线程,进行相关的UI更新
- (void)parserDidEndDocument:(NSXMLParser *)parser

系统多次解析的情况:

这也是为什么要在第3步进行字符串的拼接和第2步的字符串的清空。

GDataXML解析

导入

GDataXML并没有和cocoaPod进行关联,所以无法使用Pod进行管理,只能从网上直接下载源文件,然后手动导入。好在GDataXML很简单,只有一个头文件和一个实现文件,使用的时候导入其头文件即可。
关于导入方法,首先需要添加libxml2.tbd动态库,然后添加两个编译参数,这在GDataXML.h中描述的很明白,如下:

// libxml includes require that the target Header Search Paths contain
//
// /usr/include/libxml2
//
// and Other Linker Flags contain
//
// -lxml2

如果遇到:
错误

那就这样解决:
解决
还有这样:

解析数据

//初始化GDataXMLDocument,将整个文档读入
GDataXMLDocument *doc = [[GDataXMLDocument alloc]initWithData:self.xmlData options:0 error:nil];
//获取根节点
GDataXMLElement *rootElement = [doc rootElement];
//获取根节点下的数据节点,返回值是数组类型
NSArray *Books = [rootElement elementsForName:@"Book"];
for (GDataXMLElement *book in Books)
{
HXTXMLDataModel *bookModel = [[HXTXMLDataModel alloc]init];
//获取Book节点的属性值
bookModel.bookID = [[[book attributeForName:@"id"] stringValue]integerValue];
//获取Book下的数据,并且赋值给数据模型
bookModel.title = [[[book elementsForName:@"title"]firstObject]stringValue];
bookModel.author = [[[book elementsForName:@"author"]firstObject]stringValue];
bookModel.summary = [[[book elementsForName:@"summary"]firstObject]stringValue];
//将数据模型添加至全局的模型数组中
[self.books addObject:bookModel];
}

HXTXMLDataModel *bookModel = self.books[0];
//取出数据,更新UI
self.Label1.text = [NSString stringWithFormat:@"%ld",bookModel.bookID];

GDataXML将文件整个读入内存,所以取值的时候一般都会返回包含所有数据的数组类型,如果要进行数据的查找,将会非常方便!不过不能像系统自带的那样通过KVC赋值给数据模型,这一点也可以看出来GDataXML比较适合小的文档解析使用。

Json文档解析

同样,关于json文档格式不会涉及太多,可以json百度百科
本例用到的json文档:

{
"Result": [
{
"id": "1",
"title": "月亮与六便士",
"author": "毛姆",
"summary": "上帝的磨盘磨得很慢,却磨得很细上帝的磨盘磨得
很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很细上帝的磨盘
磨得很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很细上帝的
磨盘磨得很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很细上
帝的磨盘磨得很慢,却磨得很细上帝的磨盘磨得很慢,却磨得很
细"
},
{

"id": "2",
"title": "岛上书店",
"author": "加布瑞埃拉·泽文",
"summary": "小岛上书店的老板和他的书店"
},
{
"id": "3",
"title": "白夜行",
"author": "东野圭吾",
"summary": "畸形但却最深沉的爱情"
},
]
}

本地json文件解析

其实iOS更新到现在,json解析的第三方框架也有很多,不过iOS系统自带的解析依然效率是最高的,所以这里着重讲一下系统自带的解析。对于json解析,最重要的是看清楚文档结构,不用一着急上来就要解析,json文档和OC之间的对应关系大致为:

json OC
大括号 {} NSDictionary
中括号 [] NSArray
双引号 “” NSString
数字 10、1.3 NSNumber

按照这个对应关系,我们来分析一下上边的json文档。

  • 首先最外层是一个大括号,所以最一开始应该用NSDictionary来接收解析出来的数据;
  • 其次所有的数据都在“Result”这个键对应的值里边,所以应该用keyForValue这个方法获取“Result”下边的数据,而这个数据最为外层是一对中括号[],所以应该用数组来进行接收;
  • 最后中括号[]里边依然是三个大括号{}括起来的数据,所以数组里边的元素都是NSDictionary类型,我们用NSDictionary对数组进行遍历,然后再次通过keyForValue获取最后我们需要的值。当然这一步,如果数据模型的属性和key值对应,则用KVC更是方便。
//懒加载json数据,转换成NSData以备解析
NSString *jsonPath = [[NSBundle mainBundle]pathForResource:@"书目" ofType:@"json"];
_jsonData = [NSData dataWithContentsOfFile:jsonPath];

//1. 用jsonDict字典来接收解析出来的初步数据
self.jsonDict = [NSJSONSerialization JSONObjectWithData:self.jsonData options:0 error:nil];
// NSLog(@"%@", self.jsonDict);
//2. 用键值取出Result对应的数据,保存在数组中
NSArray *resultArr = [self.jsonDict valueForKey:@"Result"];
//3. 获取包含最终数据的字典
NSDictionary *bookDict = [resultArr firstObject];
//4. 赋值给数据模型,当然用KVC更方便
HXTXMLDataModel *bookModel = [[HXTXMLDataModel alloc]init];
bookModel.bookID = [[[resultArr firstObject] valueForKey:@"id"]integerValue];
bookModel.title = [bookDict valueForKey:@"title"];
bookModel.author = [bookDict valueForKey:@"author"];
bookModel.summary = [bookDict valueForKey:@"summary"];
//5. 根据数据进行更新
self.Label1.text = [NSString stringWithFormat:@"%ld",bookModel.bookID];
self.Label2.text = bookModel.title;
self.Label3.text = bookModel.author;
self.Label4.text = bookModel.summary;

网络json文件解析

其实网络json文档解析,跟前边本地的步骤一样,只不过是从网络服务器进行数据获取,写在这里只是为了说明,从iOS9开始,网络请求数据的方法有些变化:

//网址
NSString *path = @"http://www.weather.com.cn/data/sk/101010100.html";
//初始化url
NSURL *url = [NSURL URLWithString:path];
//获取网络单例
NSURLSession *session = [NSURLSession sharedSession];
NSURLRequest *request = [NSURLRequest requestWithURL:url];
//生成请求数据的任务
NSURLSessionDataTask *task = [session dataTaskWithRequest:request
completionHandler:^(NSData * _Nullable data,
NSURLResponse * _Nullable response,
NSError * _Nullable error) {

//解析json数据,跟上一个本地解析的步骤一样,不再赘述

}];
//调用任务
[task resume];

JSONKit解析

先说一个小坑:我是通过cocoaPod导入的JSONKit库,不过引入头文件之后,报出20个错误:

错误

解决方法是:首先选中Xcod左边栏Pods,然后编译设置中做如下设置:

完工开始。
JSONKit的使用也很简单,常用的方法有:

- (id)objectFromJSONString;
- (id)objectFromJSONStringWithParseOptions:(JKParseOptionFlags)parseOptionFlags;
- (id)objectFromJSONData;
- (id)objectFromJSONDataWithParseOptions:(JKParseOptionFlags)parseOptionFlags;

如果数据是“单层”的,即value都是字符串、数字,可以使用objectFromJSONString或者objectFromJSONData
但是如果数据有嵌套,即value里有数组、字典、对象等,最好使用带参数的objectFromJSONStringWithParseOptions或者objectFromJSONDataWithParseOptions
这个例子中,我使用的是和data相关的方法。

//1. 调用JSONKit的方法进行解析,用字典接收,这里边的枚举值我都尝试了,都可以得到正确结果,暂不清楚区别是什么
self.jsonDict = [self.jsonData objectFromJSONDataWithParseOptions:JKSerializeOptionNone];
// NSLog(@"%@====", self.jsonDict);

//2. 用键值取出Result对应的数据,保存在数组中
NSArray *resultArr = [self.jsonDict valueForKey:@"Result"];
//3. 获取包含最终数据的字典
NSDictionary *bookDict = [resultArr firstObject];
//4. 赋值给数据模型,当然用KVC更方便
HXTXMLDataModel *bookModel = [[HXTXMLDataModel alloc]init];
bookModel.bookID = [[[resultArr firstObject] valueForKey:@"id"]integerValue];
bookModel.title = [bookDict valueForKey:@"title"];
bookModel.author = [bookDict valueForKey:@"author"];
bookModel.summary = [bookDict valueForKey:@"summary"];
//5. 根据数据进行更新
self.Label1.text = [NSString stringWithFormat:@"%ld",bookModel.bookID];
self.Label2.text = bookModel.title;
self.Label3.text = bookModel.author;
self.Label4.text = bookModel.summary;

大家也都看出来了,其实只是第一步解析的不同,后边数据处理的方法和之前是一模一样的。
另外再提一点,我在用JSONKit解析的时候,发现它对json数据的格式比较挑剔。可以看到最上边我那个json文档例子,最后一个数据的大括号外边多了一个逗号,用系统进行解析的时候没什么问题,但是换成JSONKit之后,尝试了几次都解析不出来,后来打印错误一看,提示那个逗号不对,删除之后再解析就正确了。希望大家引以为戒!