[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)

或者

let json = JSON(jsonObject)

或者

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

下标Subscript

//从JSON数组中获取Double
let name = json[0].double
//从JSON数组中获取字符串数组
let arrayNames =  json["users"].arrayValue.map {$0["name"].stringValue}
//从JSON字典中获取字符串
let name = json["name"].stringValue
//使用元素的路径获取字符串
let path: [JSONSubscriptType] = [1,"list",2,"name"]
let name = json[path].string
// 相同
let name = json[1]["list"][2]["name"].string
// 或者
let name = json[1,"list",2,"name"].string
//使用困难的方式
let name = json[].string
//使用自定义方式
let keys:[JSONSubscriptType] = [1,"list",2,"name"]
let name = json[keys].string

循环Loop

//如果json是.Dictionary
for (key,subJson):(String, JSON) in json {
   // Do something you want
}

即使JSON是一个数组，第一个元素也总是一个String

//如果json是.Array 
// `index`是0 .. <json.count的字符串值
for (index,subJson):(String, JSON) in json {
    // Do something you want
}

错误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中永远不会发生。

let json = JSON(["name", "age"])
if let name = json[999].string {
    // Do something you want
} else {
    print(json[999].error!) // "Array[999] is out of bounds"
}

let json = JSON(["name":"Jack", "age": 25])
if let name = json["address"].string {
    // Do something you want
} else {
    print(json["address"].error!) // "Dictionary["address"] does not exist"
}

let json = JSON(12345)
if let age = json[0].string {
    // Do something you want
} else {
    print(json[0])       // "Array[0] failure, It is not an array"
    print(json[0].error!) // "Array[0] failure, It is not an array"
}

if let name = json["name"].string {
    // Do something you want
} else {
    print(json["name"])       // "Dictionary["name"] failure, It is not an dictionary"
    print(json["name"].error!) // "Dictionary["name"] failure, It is not an dictionary"
}

可选的getter

// NSNumber
if let id = json["user"]["favourites_count"].number {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["favourites_count"].error!)
}

// String
if let id = json["user"]["name"].string {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["name"].error!)
}

// Bool
if let id = json["user"]["is_translator"].bool {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["is_translator"].error!)
}

// Int
if let id = json["user"]["id"].int {
   // Do something you want
} else {
   // Print the error
   print(json["user"]["id"].error!)
}
...

非可选的getter

非可选的getter被命名 xxxValue

//如果不是Number或nil，则返回0
let id: Int = json["id"].intValue
//如果不是String或nil，则返回“”
let name: String = json["name"].stringValue
//如果不是数组或者为nil，则返回[]
let list: Array<JSON> = json["list"].arrayValue
//如果不是Dictionary或nil，返回[:]
let user: Dictionary<String, JSON> = json["user"].dictionaryValue

Setter

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

原始对象Raw object

let rawObject: Any = json.object
let rawValue: Any = json.rawValue
//将JSON转换为原始NSData
do {
    let rawData = try json.rawData()
  //Do something you want
} catch {
    print("Error (error)")
}
//将JSON转换为原始String
if let rawString = json.rawString() {
  //Do something you want
} else {
    print("json.rawString is nil")
}

存在Existence

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

文字敞篷车

有关文字敞篷车的更多信息：Swift Literal Convertibles

// StringLiteralConvertible
let json: JSON = "I'm a json"
// IntegerLiteralConvertible 
let json: JSON =  12345
// BooleanLiteralConvertible
let json: JSON =  true
// FloatLiteralConvertible
let json: JSON =  2.8765
// DictionaryLiteralConvertible
let json: JSON =  ["I":"am", "a":"json"]
// ArrayLiteralConvertible
let json: JSON =  ["I", "am", "a", "json"]
//使用数组中的下标
var json: JSON =  [1,2,3]
json[0] = 100
json[1] = 200
json[2] = 300
json[999] = 300  //别担心，什么都不会发生
//使用字典中的下标
var json: JSON =  ["name": "Jack", "age": 25]
json["name"] = "Mike"
json["age"] = "25" // It's OK to set String
json["address"] = "L.A." // Add the "address": "L.A." in json
//数组和字典
var json: JSON =  ["name": "Jack", "age": 25, "list": ["a", "b", "c", ["what": "this"]]]
json["list"][3]["what"] = "that"
json["list",3,"what"] = "that"
let path: [JSONSubscriptType] = ["list",3,"what"]
json[path] = "that"
//使用其他JSON对象
let user: JSON = ["username" : "Steve", "password": "supersecurepassword"]
let auth: JSON = [
  "user": user.object, // use user.object instead of just user
  "apikey": "supersecretapitoken"
]

合并Merging

可以将一个JSON合并到另一个JSON中。将JSON合并到另一个JSON中会将所有非现有值添加到仅存在于otherJSON中的原始JSON。

如果两个JSON都包含相同键的值，则大多数此值会被原始JSON覆盖，但有两种情况会提供一些特殊处理：

• 如果两个值都是值，那么JSON.Type.array在otherJSON中找到的数组会附加到原始JSON的数组值。
• 如果两个值都是JSON.Type.dictionary两个JSON值，那么合并的方式与封装JSON的合并方式相同。

如果JSON中的两个字段具有不同的类型，则该值将始终被覆盖。

合并有两种不同的方式：merge修改原始JSON，而merged在副本上非破坏性地工作。

let original: JSON = [
    "first_name": "John",
    "age": 20,
    "skills": ["Coding", "Reading"],
    "address": [
        "street": "Front St",
        "zip": "12345",
    ]
]

let update: JSON = [
    "last_name": "Doe",
    "age": 21,
    "skills": ["Writing"],
    "address": [
        "zip": "12342",
        "city": "New York City"
    ]
]

let updated = original.merge(with: update)
// [
//     "first_name": "John",
//     "last_name": "Doe",
//     "age": 21,
//     "skills": ["Coding", "Reading", "Writing"],
//     "address": [
//         "street": "Front St",
//         "zip": "12342",
//         "city": "New York City"
//     ]
// ]

字符串表示

有两种选择：

• 使用默认的Swift
• 使用一个可以很好地处理选项的自定义表示nil为"null"：

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

与Alamofire合作

SwiftyJSON很好地包装了Alamofire JSON响应处理程序的结果：

Alamofire.request(url, method: .get).validate().responseJSON { response in
    switch response.result {
    case .success(let value):
        let json = JSON(value)
        print("JSON: (json)")
    case .failure(let error):
        print(error)
    }
}

我们还提供了Alamofire的扩展，用于将NSData序列化为SwiftyJSON的JSON。

请参阅：Alamofire-SwiftyJSON

与Moya合作

SwiftyJSON将数据解析为JSON：

let provider = MoyaProvider<Backend>()
provider.request(.showProducts) { result in
    switch result {
    case let .success(moyaResponse):
        let data = moyaResponse.data
        let json = JSON(data: data) //将网络数据转换为json
        print(json)
    case let .failure(error):
        print("error: (error)")
    }
}