iOS系統(tǒng)中Swift 4 JSON解析過程指南

Swift 4 JSON 解析指南2017-07-07 11:08程序設(shè)計

Apple 終于在 Swift 4 的 Foundation 的模塊中添加了對 JSON 解析的原生支持。

雖然已經(jīng)有很多第三方類庫實現(xiàn)了 JSON 解析，但是能夠看到這樣一個功能強(qiáng)大、易于使用的官方實現(xiàn)還是不免有些興奮。

值得注意的是，官方的實現(xiàn)方式適用于任何 Encoder/Decoder ，例如 PropertyListEncoder 。當(dāng)然如果你需要 XML 格式的內(nèi)容，可以進(jìn)行自定義實現(xiàn)。在接下來的內(nèi)容中，我們將專注于 JSON 格式的解析，因為這是 iOS 開發(fā)中最常見的數(shù)據(jù)格式。

基礎(chǔ)

如果你的 JSON 數(shù)據(jù)結(jié)構(gòu)和你使用的 Model 對象結(jié)構(gòu)一致的話，那么解析過程將會非常簡單。

下面是一個 JSON 格式的啤酒說明：

{

“name”： “Endeavor”，

“abv”： 8.9，

“brewery”： “Saint Arnold”，

“style”： “ipa”

}

對應(yīng)的 Swift 數(shù)據(jù)結(jié)構(gòu)如下：

enum BeerStyle ： String {

case ipa

case stout

case kolsch

// 。。.

}

struct Beer {

let name： String

let brewery： String

let style： BeerStyle

}

為了將 JSON 字符串轉(zhuǎn)化為 Beer 類型的實例，我們需要將 Beer 類型標(biāo)記為 Codable。

Codable 實際上是 Encodable & Decodable 兩個協(xié)議的組合類型，所以如果你只需要單向轉(zhuǎn)換的話，你可以只選用其中一個。該功能也是 Swift 4 中引入的最重要新特性之一。

Codable 帶有默認(rèn)實現(xiàn)，所以在大多數(shù)情形下，你可以直接使用該默認(rèn)實現(xiàn)進(jìn)行數(shù)據(jù)轉(zhuǎn)換。

enum BeerStyle ： String， Codable {

// 。。.

}

struct Beer ： Codable {

// 。。.

}

下面只需要創(chuàng)建一個解碼器：

let jsonData = jsonString.data（encoding： .utf8）！

let decoder = JSONDecoder（）

let beer = try！ decoder.decode（Beer.self， for： jsonData）

這樣我們就將 JSON 數(shù)據(jù)成功解析為了 Beer 實例對象。因為 JSON 數(shù)據(jù)的 Key 與 Beer 中的屬性名一致，所以這里不需要進(jìn)行自定義操作。

需要注意的是，這里直接使用了 try！ 操作。因為這里只是簡單示例，所以在真實程序中你應(yīng)該對錯誤進(jìn)行捕獲并作出對應(yīng)的處理。

但是，現(xiàn)實中不可能一直都是完美情形，很大幾率存在 Key 值與屬性名不匹配的情形。

自定義鍵值名

通常情形下，API 接口設(shè)計時會采用 snake-case 的命名風(fēng)格，但是這與 Swift 中的編程風(fēng)格有著明顯的差異。

為了實現(xiàn)自定義解析，我們需要先去看下 Codable 的默認(rèn)實現(xiàn)機(jī)制。

默認(rèn)情形下 Keys 是由編譯器自動生成的枚舉類型。該枚舉遵守 CodingKey 協(xié)議并建立了屬性和編碼后格式之間的關(guān)系。

為了解決上面的風(fēng)格差異需要對其進(jìn)行自定義，實現(xiàn)代碼：

struct Beer ： Codable {

// 。。.

enum CodingKeys ： String， CodingKey {

case name

case abv = “alcohol_by_volume”

case brewery = “brewery_name”

case style

}

}

現(xiàn)在我們將 Beer 實例轉(zhuǎn)化為 JSON ，看看自定義之后的 JSON 數(shù)據(jù)格式：

let encoder = JSONEncoder（）

let data = try！ encoder.encode（beer）

print（String（data： data， encoding： .utf8）！）

輸出如下：

{“style”：“ipa”，“name”：“Endeavor”，“alcohol_by_volume”：8.8999996185302734，“brewery_name”：“Saint Arnold”}

上面的輸出格式對閱讀起來并不是太友好。不過我們可以設(shè)置 JSONEncoder 的

outputFormatting 屬性來定義輸出格式。

默認(rèn) outputFormatting 屬性值為 .compact，輸出效果如上。如果將其改為 .prettyPrinted 后就能獲得更好的閱讀體檢。

encoder.outputFormatting = .prettyPrinted