準(zhǔn)備工作

起因

在我動(dòng)手搞這個(gè) JSON 解析庫(kù)之前，我一直在用 SwiftyJSON 這個(gè)庫(kù)，這個(gè)庫(kù)是國(guó)人開源的***的 Swift 項(xiàng)目，沒有之一，也是全球***的 Swift 庫(kù)第二名，***名是網(wǎng)絡(luò)庫(kù) Alamofire。由于要實(shí)現(xiàn) ["key"]["key1"] 這樣的遞歸查找，我一直覺得 JSON 解析庫(kù)非常復(fù)雜難搞。

過程

最近比較閑，我打算把之前用過的開源庫(kù)都自己實(shí)現(xiàn)一下，提升一下自己。而且我在實(shí)際使用 SwiftyJSON 的過程中，遇到過非合法長(zhǎng)字符串導(dǎo)致奔潰的情況，我打算先從 JSON 解析庫(kù)下手，于是中秋節(jié)的前一天，吃完午飯我就開搞了，到了下午六七點(diǎn)，解析的功能就全部搞定了，十分出乎預(yù)料。中秋節(jié)這天我又把生成的功能做了，整理下代碼，收拾收拾就給開源了。

API 統(tǒng)計(jì)

言歸正傳，我們的準(zhǔn)備工作還是要做的：統(tǒng)計(jì) SwiftyJSON 的主要 API。經(jīng)過簡(jiǎn)單統(tǒng)計(jì)，我找到了所有我在項(xiàng)目中使用過的 SwiftyJSON 的 API，主要分為四類：

通過特定路徑取出特定類型的值，如：json["key"]["key1"].stringValue

取出某個(gè)數(shù)組類型的子 JSON，循環(huán)拿到里面的值

將某個(gè) JSON 對(duì)象格式化成字符串

使用 Dictionary 生成 JSON 對(duì)象

遞歸取值

設(shè)計(jì)基本結(jié)構(gòu)

既然要兼容 SwiftyJSON 的主要 API，那調(diào)用方式跟它一樣就行了：先使用 NSData、Array 或者 Dictionary 生成 JSON 對(duì)象，再對(duì)這個(gè)對(duì)象進(jìn)行操作，拿到我們想要的值、數(shù)組、完整的 JSON 字符串等。

為了對(duì)比 API 的執(zhí)行結(jié)果，我們?nèi)匀灰?SwiftyJSON 庫(kù)，所以我們需要一個(gè)其他的類名，在這里我們就暫定為 JSONND，是 JSON Never Die 的縮寫，含義是永不奔潰的 JSON 解析庫(kù)。

我們先從網(wǎng)絡(luò)數(shù)據(jù)下手。網(wǎng)絡(luò)數(shù)據(jù)的來源一般為 NSData，經(jīng)過簡(jiǎn)單查詢我們知道系統(tǒng)提供了一個(gè) JSON 解析方法，可以把 NSData 格式的解析為 AnyObject，構(gòu)造出 JSONND 類：

public struct JSONND { 
public var jsonObject: AnyObject! 
public static func initWithData(data: NSData) -> JSONND! { 
do { 
return JSONND(jsonObject: try NSJSONSerialization.JSONObjectWithData(data, options: NSJSONReadingOptions.AllowFragments)) 
} catch let error as NSError { 
let e = NSError(domain: "JSONNeverDie.JSONParseError", code: error.code, userInfo: error.userInfo) 
NSLog(e.localizedDescription) 
return JSONND() 
} 
} 
} 

需要注意的是，我們給 JSON 類使用的是 struct 結(jié)構(gòu)體，為了它能夠具備自動(dòng)初始化函數(shù)，值類型等優(yōu)良特性。JSON 直觀上感覺是 String 的衍生，故使用值類型也起到降低學(xué)習(xí)成本的作用。

我們使用下面的代碼來檢驗(yàn)成果：

let data = NSData(contentsOfURL: NSURL(string: "http://httpbin.org/get?hello=world")!)! 
let json = JSONND.initWithData(data) 

運(yùn)行，正常，初始化代碼完成。

支持 ["key"]["key1"] 形式的遞歸取值

為了支持遞歸取值，同時(shí)不讓我們的 JSONND 結(jié)構(gòu)體變的過于臃腫，我們考慮將遞歸取值的任務(wù)交給第二個(gè)結(jié)構(gòu)體：

public struct JSONNDElement { 
public var data: AnyObject! 
public init(data: AnyObject!) { 
self.data = data 
} 
public subscript (index: String) -> JSONNDElement { 
if let jsonDictionary = self.data as? Dictionary { 
if let value = jsonDictionary[index] { 
return JSONNDElement(data: value) 
} else { 
NSLog("JSONNeverDie: No such key '\(index)'") 
} 
} 
return JSONNDElement(data: nil) 
} 
} 

同時(shí)，我們需要在 JSONND 結(jié)構(gòu)體中觸發(fā)遞歸取值的***次：

public subscript (index: String) -> JSONNDElement { 
let jsonNDElement = JSONNDElement(data: self.jsonObject) 
return jsonNDElement[index] 
} 

檢驗(yàn)成果：

let data = NSData(contentsOfURL: NSURL(string: "http://httpbin.org/get?hello=world")!)! 
let json = JSONND.initWithData(data) 
let args = json["args"] 
let hello = args["hello"] 

運(yùn)行，正常，遞歸取值完成。

取出 Int、Float、String、Array、Bool 類型的值

在我們通過 ["key"]["key1"] 的形式拿到最終的 JSONNDElement 對(duì)象之后，我們就需要把他的 data 轉(zhuǎn)換成我們想要的類型輸出了。介紹 JSON 數(shù)據(jù)類型的文檔：http://www.yiibai.com/json/json_data_types.html

SwiftyJSON 采用兩級(jí)函數(shù)來取值，即 .int 為 Int? 類型， .intValue 為 Int 類型，這顯然是為了適應(yīng)不同的 API 設(shè)計(jì)作出的兼容，我們也要實(shí)現(xiàn)這樣的兩級(jí)取值。要實(shí)現(xiàn)取值，其實(shí)是非常簡(jiǎn)單的，if let 轉(zhuǎn)換一下類型，基本就 OK 了：

public var int: Int? { 
get { 
if let _ = self.data { 
return self.data.integerValue 
} else { 
return nil 
} 
} 
} 
public var intValue: Int { 
get { 
if let i = self.int { 
return i 
} else { 
return 0 
} 
} 
} 

由于代碼比較繁瑣無趣，這里只用 Int 展示一下，更多代碼請(qǐng)見 Github。

Array 類型的處理要單獨(dú)拿出來處理，因?yàn)?Array 有子級(jí)，所以我們得到的將是 JSONNDElement 數(shù)組。Array 處理代碼如下：

public var array: [JSONNDElement]? { 
get { 
if let _ = self.data { 
if let arr = self.data as? Array { 
var result = Array() 
for i in arr { 
result.append(JSONNDElement(data: i)) 
} 
return result 
} else { 
return nil 
} 
} else { 
return nil 
} 
} 
} 
public var arrayValue: [JSONNDElement] { 
get { 
if let i = self.array { 
return i 
} else { 
return [] 
} 
} 
} 

將 JSONND 對(duì)象格式化成字符串

通過在 JSONND 和 JSONNDElement 中添加兩個(gè)函數(shù)，將成員變量 data 轉(zhuǎn)換成 String 就可以加上這個(gè)功能了：

JSONND 中：

public var jsonString: String? { 
let jsonNDElement = JSONNDElement(data: self.jsonObject) 
return jsonNDElement.jsonString 
} 
public var jsonStringValue: String { 
let jsonNDElement = JSONNDElement(data: self.jsonObject) 
return jsonNDElement.jsonStringValue 
} 

JSONNDElement 中：

public var jsonString: String? { 
get { 
do { 
if let _ = self.data { 
return NSString(data: try NSJSONSerialization.dataWithJSONObject(self.data, options: .PrettyPrinted), encoding: NSUTF8StringEncoding) as? String 
} else { 
return nil 
} 
} catch { 
return nil 
} 
} 
} 
public var jsonStringValue: String { 
get { 
if let i = self.jsonString { 
return i 
} else { 
return "" 
} 
} 
} 

使用 Array、Dictionary 生成 JSON 對(duì)象

這一步操作我們將使用從 SwiftyJSON 中偷來的函數(shù)，稍加改裝就可以利用了：

// stolen from SwiftyJSON 
extension JSONND: DictionaryLiteralConvertible { 
public init(dictionaryLiteral elements: (String, AnyObject)...) { 
self.init(jsonObject: elements.reduce([String : AnyObject]()){(dictionary: [String : AnyObject], element:(String, AnyObject)) -> [String : AnyObject] in 
var d = dictionary 
d[element.0] = element.1 
return d 
}) 
} 
} 
// stolen from SwiftyJSON 
extension JSONND: ArrayLiteralConvertible { 
public init(arrayLiteral elements: AnyObject...) { 
self.init(jsonObject: elements) 
} 
} 

代碼的原理也很簡(jiǎn)單，利用系統(tǒng)的自動(dòng)轉(zhuǎn)換 protocol：DictionaryLiteralConvertible 和 ArrayLiteralConvertible，讓 Array 和 Dictionary 自動(dòng)轉(zhuǎn)換為 JSONND 類型?，F(xiàn)在我們可以采用這種方式定義 JSONND 對(duì)象了：

let dictionaryJSON: JSONND = ["a": 1, "b": [1, 2, 3]] 
let arrayJSON: JSONND = [0, 1, 2] 

搞定！

檢驗(yàn)成果

我已經(jīng)給 JSONNeverDie 項(xiàng)目寫了完整的單元測(cè)試來測(cè)試每一項(xiàng)功能，感興趣的同學(xué)可以去 Github 查看測(cè)試代碼。