为什么 Swift 中范例的 JSON 处理不好?
Swift 对类型非常严格。但是,虽然显式类型有助于我们避免缺点,但在处理 JSON 和其他实质上隐含类型的领域时,它会变得很痛楚。以 Twitter API 为例。假设我们想在 Swift 中检索用户的某些推文的“名称”值(根据Twitter 的 API)。
代码如下所示:
if let statusesArray = try? JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [[String: Any]], let user = statusesArray[0]["user"] as? [String: Any], let username = user["name"] as? String { // Finally we got the username}
纵然我们利用可选链,它也会很混乱:

if let JSONObject = try JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [[String: Any]], let username = (JSONObject[0]["user"] as? [String: Any])?["name"] as? String { // There's our username}
对付一些该当很大略的东西而看起来非常混乱。
利用 SwiftyJSON,您所要做的便是:
let json = JSON(data: dataFromNetworking)if let userName = json[0]["user"]["name"].string { //Now you got your value}
不要担心可选包装的事情,它会自动为您完成。
let json = JSON(data: dataFromNetworking)let result = json[999999]["wrong_key"]["wrong_name"]if let userName = result.string { //Calm down, take it easy, the ".string" property still produces the correct Optional String type with safety} else { //Print the error print(result.error)}
工具哀求iOS 8.0+ | macOS 10.10+ | tvOS 9.0+ | watchOS 2.0+Xcode 8利用
CocoaPods (iOS 8+, OS X 10.9+)
您可以利用CocoaPods来安装,方法SwiftyJSON是将其添加到您的Podfile:
platform :ios, '8.0'use_frameworks!target 'MyApp' do pod 'SwiftyJSON', '~> 4.0'end
Carthage (iOS 8+, OS X 10.9+)
您可以通过将CarthageSwiftyJSON添加到您的Cartfile:
github "SwiftyJSON/SwiftyJSON" ~> 4.0
如果您利用 Carthage 构建依赖项,请确保您已添加SwiftyJSON.framework到目标的“链接框架和库”部分,并将它们包含在您的 Carthage 框架复制构建阶段。
Swift 包管理器
您可以通过在文件中添加精确的描述来利用Swift 包管理器进行安装:SwiftyJSONPackage.swift
// swift-tools-version:4.0import PackageDescriptionlet package = Package( name: "YOUR_PROJECT_NAME", dependencies: [ .package(url: "https://github.com/SwiftyJSON/SwiftyJSON.git", from: "4.0.0"), ])
然后swift build在你准备好的时候。
用法初始化
import SwiftyJSONlet json = JSON(data: dataFromNetworking)
或者
let json = JSON(jsonObject)
再或者
if let dataFromString = jsonString.data(using: .utf8, allowLossyConversion: false) { let json = JSON(data: dataFromString)}
下标
// Getting a double from a JSON Arraylet name = json[0].double
// Getting an array of string from a JSON Arraylet arrayNames = json["users"].arrayValue.map {$0["name"].stringValue}
// Getting a string from a JSON Dictionarylet name = json["name"].stringValue
// Getting a string using a path to the elementlet path: [JSONSubscriptType] = [1,"list",2,"name"]let name = json[path].string// Just the samelet name = json[1]["list"][2]["name"].string// Alternativelylet name = json[1,"list",2,"name"].string
// With a hard waylet name = json[].string
// With a custom waylet keys:[JSONSubscriptType] = [1,"list",2,"name"]let name = json[keys].string
缺点
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"}
合并
可以将一个 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])// representation is "{\"1\":2,\"2\":\"two\",\"3\":null}", which represents {"1":2,"2":"two","3":null}
—END—
开源协议:MIT license
开源地址:https://github.com/SwiftyJSON/SwiftyJSON