[Swift]SwiftyJSON的使用：解析JSON

★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★
➤微信公衆號：山青詠芝（shanqingyongzhi）
➤博客園地址：山青詠芝（https://www.cnblogs.com/strengthen/ ）
➤GitHub地址：https://github.com/strengthen/LeetCode
➤原文地址：https://www.cnblogs.com/strengthen/p/10709048.html 
➤若是連接不是山青詠芝的博客園地址，則多是爬取做者的文章。
➤原文已修改更新！強烈建議點擊原文地址閱讀！支持做者！支持原創！
★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

用法

初始化Initialization

import SwiftyJSON

let json = JSON(data: dataFromNetworking)

或者

1 let json = JSON(jsonObject)

或者

1 if let dataFromString = jsonString.data(using: .utf8, allowLossyConversion: false) { 2     let json = JSON(data: dataFromString) 3 }

下標Subscript

 1 //從JSON數組中獲取Double
 2 let name = json[0].double
 3 //從JSON數組中獲取字符串數組
 4 let arrayNames =  json["users"].arrayValue.map {$0["name"].stringValue}  5 //從JSON字典中獲取字符串
 6 let name = json["name"].stringValue  7 //使用元素的路徑獲取字符串
 8 let path: [JSONSubscriptType] = [1,"list",2,"name"]  9 let name = json[path].string
10 // 相同
11 let name = json[1]["list"][2]["name"].string
12 // 或者
13 let name = json[1,"list",2,"name"].string
14 //使用困難的方式
15 let name = json[].string
16 //使用自定義方式
17 let keys:[JSONSubscriptType] = [1,"list",2,"name"] 18 let name = json[keys].string

循環Loop

1 //若是json是.Dictionary
2 for (key,subJson):(String, JSON) in json { 3    // Do something you want
4 }

即便JSON是一個數組，第一個元素也老是一個String

1 //若是json是.Array 2 // `index`是0 .. <json.count的字符串值
3 for (index,subJson):(String, JSON) in json { 4     // Do something you want
5 }

錯誤Error

SwiftyJSON 4.x

SwiftyJSON 4.x的引入稱爲枚舉類型SwiftyJSONError，其中包括unsupportedType，indexOutOfBounds，elementTooDeep，wrongType，notExist和invalidJSON，在同一時間，ErrorDomain正在被更換SwiftyJSONError.errorDomain。注意：這些舊的錯誤類型在SwiftyJSON 4.x中已棄用，將在之後的版本中刪除。

SwiftyJSON 3.x

使用下標來獲取/設置數組或字典中的值

若是JSON是：

• 一個數組，應用程序可能會崩潰「索引越界」。
• 一本字典，它將被nil無端分配。
• 不是數組或字典，應用程序可能會崩潰「沒法識別的選擇器」異常。

這在SwiftyJSON中永遠不會發生。

 1 let json = JSON(["name", "age"])  2 if let name = json[999].string {  3     // Do something you want
 4 } else {  5     print(json[999].error!) // "Array[999] is out of bounds"
 6 }  7 
 8 let json = JSON(["name":"Jack", "age": 25])  9 if let name = json["address"].string { 10     // Do something you want
11 } else { 12     print(json["address"].error!) // "Dictionary["address"] does not exist"
13 } 14 
15 let json = JSON(12345) 16 if let age = json[0].string { 17     // Do something you want
18 } else { 19     print(json[0])       // "Array[0] failure, It is not an array"
20     print(json[0].error!) // "Array[0] failure, It is not an array"
21 } 22 
23 if let name = json["name"].string { 24     // Do something you want
25 } else { 26     print(json["name"])       // "Dictionary[\"name"] failure, It is not an dictionary"
27     print(json["name"].error!) // "Dictionary[\"name"] failure, It is not an dictionary"
28 }

可選的getter

 1 // NSNumber
 2 if let id = json["user"]["favourites_count"].number {  3    // Do something you want
 4 } else {  5    // Print the error
 6    print(json["user"]["favourites_count"].error!)  7 }  8 
 9 // String
10 if let id = json["user"]["name"].string { 11    // Do something you want
12 } else { 13    // Print the error
14    print(json["user"]["name"].error!) 15 } 16 
17 // Bool
18 if let id = json["user"]["is_translator"].bool { 19    // Do something you want
20 } else { 21    // Print the error
22    print(json["user"]["is_translator"].error!) 23 } 24 
25 // Int
26 if let id = json["user"]["id"].int { 27    // Do something you want
28 } else { 29    // Print the error
30    print(json["user"]["id"].error!) 31 } 32 ...

非可選的getter

非可選的getter被命名 xxxValue

1 //若是不是Number或nil，則返回0
2 let id: Int = json["id"].intValue 3 //若是不是String或nil，則返回「」
4 let name: String = json["name"].stringValue 5 //若是不是數組或者爲nil，則返回[]
6 let list: Array<JSON> = json["list"].arrayValue 7 //若是不是Dictionary或nil，返回[:]
8 let user: Dictionary<String, JSON> = json["user"].dictionaryValue

Setter

1 json["name"] = JSON("new-name") 2 json[0] = JSON(1) 3 json["id"].int =  1234567890
4 json["coordinate"].double =  8766.766
5 json["name"].string =  "Jack"
6 json.arrayObject = [1,2,3,4] 7 json.dictionaryObject = ["name":"Jack", "age":25]

原始對象Raw object

 1 let rawObject: Any = json.object
 2 let rawValue: Any = json.rawValue  3 //將JSON轉換爲原始NSData
 4 do {  5     let rawData = try json.rawData()  6   //Do something you want
 7 } catch {  8     print("Error \(error)")  9 } 10 //將JSON轉換爲原始String
11 if let rawString = json.rawString() { 12   //Do something you want
13 } else { 14     print("json.rawString is nil") 15 }

存在Existence

1 //顯示是否在JSON中指定了值
2 if json["name"].exists()

文字敞篷車

有關文字敞篷車的更多信息：Swift Literal Convertibles

 1 // StringLiteralConvertible
 2 let json: JSON = "I'm a json"
 3 // IntegerLiteralConvertible 
 4 let json: JSON =  12345
 5 // BooleanLiteralConvertible
 6 let json: JSON =  true
 7 // FloatLiteralConvertible
 8 let json: JSON =  2.8765
 9 // DictionaryLiteralConvertible
10 let json: JSON =  ["I":"am", "a":"json"] 11 // ArrayLiteralConvertible
12 let json: JSON =  ["I", "am", "a", "json"] 13 //使用數組中的下標
14 var json: JSON =  [1,2,3] 15 json[0] = 100
16 json[1] = 200
17 json[2] = 300
18 json[999] = 300  //別擔憂，什麼都不會發生 19 //使用字典中的下標
20 var json: JSON =  ["name": "Jack", "age": 25] 21 json["name"] = "Mike"
22 json["age"] = "25" // It's OK to set String
23 json["address"] = "L.A." // Add the "address": "L.A." in json 24 //數組和字典
25 var json: JSON =  ["name": "Jack", "age": 25, "list": ["a", "b", "c", ["what": "this"]]] 26 json["list"][3]["what"] = "that"
27 json["list",3,"what"] = "that"
28 let path: [JSONSubscriptType] = ["list",3,"what"] 29 json[path] = "that"
30 //使用其餘JSON對象
31 let user: JSON = ["username" : "Steve", "password": "supersecurepassword"] 32 let auth: JSON = [ 33   "user": user.object, // use user.object instead of just user
34   "apikey": "supersecretapitoken"
35 ]

合併Merging

能夠將一個JSON合併到另外一個JSON中。將JSON合併到另外一個JSON中會將全部非現有值添加到僅存在於otherJSON中的原始JSON。

若是兩個JSON都包含相同鍵的值，則大多數此值會被原始JSON覆蓋，但有兩種狀況會提供一些特殊處理：

• 若是兩個值都是值，那麼JSON.Type.array在otherJSON中找到的數組會附加到原始JSON的數組值。
• 若是兩個值都是JSON.Type.dictionary兩個JSON值，那麼合併的方式與封裝JSON的合併方式相同。

若是JSON中的兩個字段具備不一樣的類型，則該值將始終被覆蓋。

合併有兩種不一樣的方式：merge修改原始JSON，而merged在副本上非破壞性地工做。

 1 let original: JSON = [  2     "first_name": "John",  3     "age": 20,  4     "skills": ["Coding", "Reading"],  5     "address": [  6         "street": "Front St",  7         "zip": "12345",  8  ]  9 ] 10 
11 let update: JSON = [ 12     "last_name": "Doe", 13     "age": 21, 14     "skills": ["Writing"], 15     "address": [ 16         "zip": "12342", 17         "city": "New York City"
18  ] 19 ] 20 
21 let updated = original.merge(with: update) 22 // [ 23 // "first_name": "John", 24 // "last_name": "Doe", 25 // "age": 21, 26 // "skills": ["Coding", "Reading", "Writing"], 27 // "address": [ 28 // "street": "Front St", 29 // "zip": "12342", 30 // "city": "New York City" 31 // ] 32 // ]

字符串表示

有兩種選擇：

• 使用默認的Swift
• 使用一個能夠很好地處理選項的自定義表示nil爲"null"：

1 let dict = ["1":2, "2":"two", "3": nil] as [String: Any?] 2 let json = JSON(dict) 3 let representation = json.rawString(options: [.castNilToNSNull: true]) 4  // 表示爲「{\」1 \「：2，\」2 \「：\」two \「，\」3 \「：null}」，表示{「1」：2，「2」：「two」 「3」：空}

與Alamofire合做

SwiftyJSON很好地包裝了Alamofire JSON響應處理程序的結果：

1 Alamofire.request(url, method: .get).validate().responseJSON { response in
2     switch response.result { 3     case .success(let value): 4         let json = JSON(value) 5         print("JSON: \(json)") 6     case .failure(let error): 7  print(error) 8  } 9 }

咱們還提供了Alamofire的擴展，用於將NSData序列化爲SwiftyJSON的JSON。

請參閱：Alamofire-SwiftyJSON

與Moya合做

SwiftyJSON將數據解析爲JSON：

 1 let provider = MoyaProvider<Backend>()  2 provider.request(.showProducts) { result in
 3     switch result {  4     case let .success(moyaResponse):  5         let data = moyaResponse.data  6         let json = JSON(data: data) //將網絡數據轉換爲json
 7  print(json)  8     case let .failure(error):  9         print("error: \(error)") 10  } 11 }