JSONUtilities

轻松加载 JSON 对象并将其解码为结构体或类。json(atKeyPath:) 函数会根据常量或变量定义推断类型来进行解码，这意味着无需进行类型转换。解码 JSON 时，支持字符串键和键路径（键之间用点 . 分隔）。

查看 JSONUtilities.xcodeproj 中的 Example.playground 以获取可运行的示例

安装

CocoaPods

将 pod 'JSONUtilities' 行添加到您的 Podfile。

Carthage

将 github "lucianomarisi/JSONUtilities" 行添加到您的 Cartfile。

手动

将 Sources 文件夹中的文件添加到您的 Xcode 项目。

Swift Package Manager

将 .Package(url: "https://github.com/lucianomarisi/JSONUtilities", majorVersion: 3) 行添加到您的 Package.swift。

支持的类型

JSON 原始类型

Int
Double
Float
String
Bool
[String: AnyObject]
RawRepresentable 枚举

JSON 原始类型的数组

[Int]
[Double]
[Float]
[String]
[Bool]
[[String: AnyObject]]
[RawRepresentable]

自定义 JSON 对象和自定义 JSON 对象数组

例如，如果 MyClass 和 MyStruct 符合 JSONObjectConvertible 协议

MyClass
[MyClass]
MyStruct
[MyStruct]

具有 `String` 键的类型化字典

[String: JSONRawType]
[String: JSONObjectConvertible]
[String: JSONPrimitiveConvertible]
[String: RawRepresentable]

InvalidItemBehaviour

在解码数组或字典时，可以传递 invalidItemBehaviour 参数，以控制在解码子项时发生错误时应采取的操作

.remove 这只会从数组或字典中删除该项。这是默认设置
.fail 如果任何子项遇到错误，则整个数组或字典解码都会失败。对于可选属性，这意味着数组或字典将返回 nil，对于非可选属性，则会抛出错误
.value(T) 提供一个替代值
.custom((DecodingError) -> InvalidItemBehaviour) 允许您根据特定的 DecodingError 指定行为

JSON 加载示例

从文件

let filename = "myjsonfile"
let dictionary: [String: AnyObject] = try JSONDictionary.from(filename: filename)

从数据

let data: Data = ...
let dictionary: [String: AnyObject] = try JSONDictionary.from(jsonData: data)

JSON 解码示例

考虑一个表示人的 JSON 对象

{
  "name" : "John Doe",
  "age" : 24,
  "weight" : 72.4
}

内联解码 JSON

let jsonDictionary = try JSONDictionary.from(filename: "person.json")
let name: String = try jsonDictionary.json(atKeyPath: "name")
let age: Int = try jsonDictionary.json(atKeyPath: "age")
let weight: Int = try jsonDictionary.json(atKeyPath: "weight")
let profession: String? = jsonDictionary.json(atKeyPath: "profession") // Optional decoding

解码结构体或类

struct Person { //OR class Person {

  let name: String
  let age: Int
  let weight: Double
  let profession: String?

  init(jsonDictionary: JSONDictionary) throws {
    name = try jsonDictionary.json(atKeyPath: "name")
    age = try jsonDictionary.json(atKeyPath: "age")
    weight = try jsonDictionary.json(atKeyPath: "weight")
    profession = jsonDictionary.json(atKeyPath: "profession")
  }

}

通过符合 JSONObjectConvertible 协议解码嵌套的结构体或类

考虑一个公司 JSON 对象

{
    "name" : "Working name LTD.",
    "employees": [
        {
            "name": "John Doe",
            "age": 24,
            "weight": 72.4
        },
        {
            "name": "Jane Doe",
            "age": 22,
            "weight": 70.1
        }
    ]
}

通过使 Person 符合 JSONObjectConvertible 协议，Company 结构体可以解码 Person 结构体/类的数组

struct Company {
  let name: String
  let employees: [Person]

  init(jsonDictionary: JSONDictionary) throws {
    name = try jsonDictionary.json(atKeyPath: "name")
    employees = try jsonDictionary.json(atKeyPath: "employees")
  }
}

通过符合 `JSONPrimitiveConvertible` 来支持自定义原始类型

任何类型都可以扩展 JSONPrimitiveConvertible 协议以允许解码。例如，扩展 URL：请注意，此扩展是开箱即用的

extension URL: JSONPrimitiveConvertible {

  public typealias JSONType = String

  public static func from(jsonValue: String) -> Self? {
    return self.init(string: jsonValue)
  }

}

let urlDictionary = ["url": "www.google.com"]
let url: URL = try! urlDictionary.json(atKeyPath: "url") // www.google.com

也可以拥有 JSONPrimitiveConvertible 值的数组，例如

let urlsDictionary = ["urls": ["www.google.com", "www.yahoo.com"]]
let urls: [URL] = try! urlsDictionary.json(atKeyPath: "urls") // [www.google.com, www.yahoo.com]