概述
上文已经分析了SwiftyJSON的数据处理流程,此时已经可以通过一个Any
类型的参数构造一个解包后拥有类型信息和相关rawValue
的JSON结构体,接下来要做的就是设计一个统一的、便捷的接口供用户获取结构体内部数据。
在此之前我们先来更清晰的梳理一下,假如输入为二进制流数据data
,其内容为:
{ "imageName": "Lina", "urls": ["www.anExample.com", "www.anotherExample.com"] }
经过JSON结构体的构造方法let json = JSON(data)
后,生成的json实例的type
为.dictionary
,解包后的数据实际储存在rawDictionary
属性中。要获取其中的具体数据,以下标的形式json["imageName"]
无疑是最方便的,而且与原生的风格一致。
面向协议编程
在Swift中有一个名为subscript
特性,用于提供下标形式的访问方式。因为对于JSON来说,最外层要么是Dictionary
,要么是Array
,也就是说是必定是集合类型,所以我们先把JSON结构体扩展为Swift的集合类型,即实现Swift.Collection
协议。因为JSON结构体的内部数据可能为多种类型,要扩展为集合,就要先定义一种统一的索引方式。而作为索引,其本身必须是可比较的,也就是必须实现Comparable
协议。
关于索引Index
和Comparable
协议
对于JSON结构体来说,我们定义了7种类型,但是作为索引,只需要针对.array
、.dictionary
和.null
,其他类型本身就是一个实体,没有索引的概念(.string
本身是有索引的,不过我们不需要把字符串给拆成字符)。所以声明一个枚举,把上述三种情况统一为一个Index
,并实现Comparable
协议。
Comparable
协议实际就是重载比较运算符,如==
、<
等,让两个同类型的实例可以进行比较,协议的概念和实现的逻辑都比较简单:
关于Collection
协议
Collection
协议可以为实现该协议的类型提供几乎全部集合常用的特性,如通过下标获取集合元素,for...in
遍历集合元素,count
isEmpty
indices
等常用属性,元素操作、距离、切片、迭代器等常用方法。
遵守Collection
协议至少必须满足以下三点:
-
startIndex
和endIndex
属性用来定义元素的起始 -
subscript
特性用来通过下标获取集合内部元素 -
index(after:)
方法用来确定元素的排列顺序
理解起来也很清晰明了,一个集合通过subscript
特性把索引和内部的元素绑定,并且确定了起始位置的索引和其他索引的后继,那么这个集合内部的元素就已经全部确定且可知的了。
而由于Array
和Dictionary
都已经是集合类型了,我们定义的Index
只是通过枚举对几种情况进行了统一,那么实现协议的时候也只需要对Index
类型进行判断,然后调用Array
和Dictionary
本身的相关实现即可:
关于下标的更优设计
此时我们就可以通过下标来访问JSON结构体了,还以文章开头的json
为例,要获取imageName
可以这样json[.dictionary("imageName")]
。这可能和想像中的不太一样,下标还必须是枚举且明确其类型,用起来是相当的不方便,所以我们需要设计一种更方便的方法来确定下标。
经过观察可以发现,Array
的下标是Int
类型,而Dictionary
的下标是String
类型,那么我们可以实现新的subscript
,通过参数的类型来调用相对应的实现。
那么首先分别实现Int
和String
类型参数的subscript
,逻辑比较简单,判断类型后,如果索引是合法的则返回索引相对应元素的JSON结构体实例,否则生成相应的错误并赋值到空JSON结构然后返回。
困难在于如何把两者整合起来,SwiftyJSON的解决方案是,定义一个协议JSONSubscriptType
,让Int
和String
都去实现该协议,这样参数的类型就统一了。然后再进行判断、调用相应的subscript
实现
这样我们终于可以开心的以json["imageName"]
这么愉快的方式来获取JSON内部数据了,但是如果我们来取一下第一个url
,问题又来了,这种复杂结构的数据又应该怎么获取呢?
SwiftyJSON提供了两种方案,一种是以数组参数的形式,一种是不定参数列表的形式,两种方式除了参数表现形式不同,其实现逻辑是相同的。在get
逻辑中,通过依次调用上面的subscript
来获取最终的结果,在set
逻辑中,如果下标个数是0直接返回,是1个通过上面的subscript
去设置,如果多于1个,以递归的方式,逐层获取内部数据,直到剩下最后一层下标,赋值,然后返回。