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

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

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

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

基礎(chǔ)

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

下面是一個(gè) JSON 格式的啤酒說(shuō)明：

{

“name”： “Endeavor”，

“abv”： 8.9，

“brewery”： “Saint Arnold”，

“style”： “ipa”

}

對(duì)應(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 類(lèi)型的實(shí)例，我們需要將 Beer 類(lèi)型標(biāo)記為 Codable。

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

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

enum BeerStyle ： String， Codable {

// 。。.

}

struct Beer ： Codable {

// 。。.

}

下面只需要?jiǎng)?chuàng)建一個(gè)解碼器：

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

let decoder = JSONDecoder（）

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

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

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

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

自定義鍵值名

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

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

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

為了解決上面的風(fēng)格差異需要對(duì)其進(jìn)行自定義，實(shí)現(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 實(shí)例轉(zhuǎn)化為 JSON ，看看自定義之后的 JSON 數(shù)據(jù)格式：

let encoder = JSONEncoder（）

let data = try！ encoder.encode（beer）

print（String（data： data， encoding： .utf8）?。?/p>

輸出如下：

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

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

outputFormatting 屬性來(lái)定義輸出格式。

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

encoder.outputFormatting = .prettyPrinted

相關(guān)電子資料下載

• iOS17.1可能明天發(fā)布，iOS17.1主要修復(fù)哪些問(wèn)題？ 377
• systemverilog讀取json文件？ 60
• C結(jié)構(gòu)體與JSON快速互轉(zhuǎn)庫(kù)介紹 86
• 華為全新鴻蒙蓄勢(shì)待發(fā) 僅支持鴻蒙內(nèi)核和鴻蒙系統(tǒng)應(yīng)用 719
• 蘋(píng)果手機(jī)系統(tǒng)iOS 17遭用戶(hù)質(zhì)疑 731
• iPhone12輻射超標(biāo)？蘋(píng)果推送iOS 17.1解決此事 750
• RT-Thread使用cjson軟件包發(fā)送64位長(zhǎng)整型數(shù)據(jù) 100
• 傳華為囤積零部件 目標(biāo)明年智能手機(jī)出貨7000萬(wàn)部；消息稱(chēng) MiOS 僅限國(guó)內(nèi)，小米 28208
• Spring Boot時(shí)配置JSON序列化選項(xiàng)的幾種方法 142
• 蘋(píng)果推送iOS17.0.3，解決iPhone15Pro系列存在機(jī)身過(guò)熱 216