Foundation 中提供的 JSONSerialization 类也可以实现 JSON 和Swift 类型的双向转换, 但提供的功能有限, 如果只是简单的需求, 也可以使用它: JSONSerialization
下面介绍如何利用 Codable 协议实现 JSON 的编解码.
参考链接:
- 官方文档.
1 简介
Swift 标准库中有两个协议 Encodable 和 Decodable, 作用分别是:
- Encodable:
Encodable的实现类型可以进行从 Swift 类型到 JSON 等外部表示的转换. - Decodable:
Decodable的实现类型可以进行从 JSON 等外部表示到 Swift 类型的转换.
在开发中, 通过 Encoder(编码器) 和 Decoder(解码器) 的实现类来进行编解码操作, 实现类包括 JSONEncoder 和 JSONDecoder, 另外还有针对 plist 进行编码的 PropertyListEncoder 等.
Codable 协议是 Encodable 和 Decodable 协议的组合, 如果实现了 Codable, 就表明实现了 Encodable 和 Decodable. 如果一个类型需要实现和外部表示的双向转换, 就需要实现 Codable 协议.
2 自动实现 Encodable 和 Decodable
**如果某类型的所有属性都是 Codable 的, 则其就自动实现 Codable **.
Swift 标准库类型都实现了 Codable, 比如 String, Double, Int 等, Foundation 库中也有许多类型实现了 Codable, 比如 Date, Data, 以及 URL.
来看下面的代码:
struct Landmark {
var name: String
var foundingYear: Int
}
等价于如下代码:
struct Landmark: Codable {
var name: String
var foundingYear: Int
}
多个 Codable 的组合也是 Codable :
struct Coordinate: Codable {
var latitude: Double
var longitude: Double
}
struct Landmark: Codable {
var name: String
var foundingYear: Int
var location: Coordinate
}
其他的一些内置类型, 比如 Array, Dictionary 以及 Optional 的也已实现 Codable 协议:
struct Landmark: Codable {
var name: String
var foundingYear: Int
var location: Coordinate
// 如下是一些内置类型
var vantagePoints: [Coordinate]
var metadata: [String: String]
var website: URL?
}
3 单独实现 Encodable 或 Decodable
如果一个类型只需要进行单独的编码或解码操作, 则可以只实现 Encodable 或 Decodable:
如果某类型只需要进行编码操作:
struct Landmark: Encodable {// 遵守 Encodable 协议
var name: String
var foundingYear: Int
}
又如某个类型只会进行 JSON 解码操作, 则它可以只实现 Decodable:
struct Landmark: Decodable {// 遵守 Decodable 协议
var name: String
var foundingYear: Int
}
4 JSON 编解码操作实例
有了上面的铺垫, 就可以看看在实际编程中如何进行操作了, 如下例子中都使用 JSON作为外部类型.
4.1 Codable 协议实现类的编码操作
定义 Coordinate 类型:
struct Coordinate: Codable {
var latitude: Double
var longitude: Double
}
下面的代码将 Coordinate 编码为 JSON:
let coordinate = Coordinate(latitude: 11.2, longitude: 12.3)
let encoder = JSONEncoder()
encoder.outputFormatting = .sortedKeys
let data = try encoder.encode(pear)
print(String(data: data, encoding: .utf8)!)
// 输出为 {"latitude":11.199999999999999,"longitude":12.300000000000001}
从 JSON 中解码 Coordinate 对象:
let jsonstr = """
{"latitude":11.199999999999999,"longitude":12.300000000000001}
"""
let coordinateData = jsonstr.data(using: .utf8)!
let decoder = JSONDecoder()
let coordinate = try decoder.decode(Coordinate.self, from: jsonstr)
print(coordinate.latitude) //11.2
print(coordinate.longitude) //12.3
4.2 自定义 JSON Key
在实际开发中, 经常希望在编解码 JSON 时指定实体属性名对应的 JSON key, 这时可以在实体类型中声明一个 enum, 命名为 CodingKeys, 这个 enum 遵守 CodingKey 协议:
struct Coordinate: Codable {
var latitude: Double
var longitude: Double
enum CodingKeys: String, CodingKey {// 在这里指定属性和 JSON key 的对应关系
case latitude = "latitude_value"
// 如果属性名和 JSON key 一致, 则直接添加进来即可, 如下所示:
case longitude
}
}
4.3 忽略属性
如果要在编码或解码时忽略某个属性, 可以像下面这样操作.
比如要忽略 longitude 属性, 可以直接在上述代码中的 CodingKeys 枚举中将其移除:
struct Coordinate: Codable {
var latitude: Double
// 被忽略的属性如果不是可选的, 则必须具有默认值, 否则整个实体都无法被解析出来
var longitude: Double = 0
enum CodingKeys: String, CodingKey {// 在这里指定属性和 JSON key 的对应关系
case latitude = "latitude_value"
// 要忽略某个属性, 则不将该属性添加到这个 enum 中
// case longitude
}
}
要注意, 如果该类型需要被解码, 则被忽略的属性必须具有默认值, 否则整个实体都无法被解码出来.
比如进行编码操作, 上述实体对象的输出为:
// {"latitude_value":11.199999999999999}
4.4 手动实现编解码
若自动编解码的默认规则无法满足要求, 还可以手动设置编解码规则, 以获得更大的灵活性.
重新定义 Coordinate 类型如下:
struct Coordinate {
var latitude: Double
var longitude: Double
var elevation: Double
enum CodingKeys: String, CodingKey {
case latitude = "latitude_value"
case longitude = "longitude_value"
case additionalInfo
}
enum AdditionalInfoKeys: String, CodingKey {
case elevation
}
}
假设 JSON 数据结构和这个实体结构稍有不同, 就永远无法将该实体解析出来的. 这个时候就需要手动设置编解码规则了.
要手动对这个类型设置编解码规则, 需要将编解码协议放到扩展中去实现:
extension Coordinate: Decodable {
init(from decoder: Decoder) throws {
let values = try decoder.container(keyedBy: CodingKeys.self)
latitude = try values.decode(Double.self, forKey: .latitude)
longitude = try values.decode(Double.self, forKey: .longitude)
let additionalInfo = try values.nestedContainer(keyedBy: AdditionalInfoKeys.self, forKey: .additionalInfo)
elevation = try additionalInfo.decode(Double.self, forKey: .elevation)
}
}
extension Coordinate: Encodable {
func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(latitude, forKey: .latitude)
try container.encode(longitude, forKey: .longitude)
var additionalInfo = container.nestedContainer(keyedBy: AdditionalInfoKeys.self, forKey: .additionalInfo)
try additionalInfo.encode(elevation, forKey: .elevation)
}
}
5 一些实践做法
在实践中, 常将 Decodable 类型中的所有属性都定义为 optional, 这样服务端的 JSON 细微改变不会影响到整个实体的解析.
如下定义了一个实体:
struct DataRootClass: Decodable {
var status: String
var message: String
var code: Int
}
如果当前响应 JSON 中的 message 字段变成了 msg, 则整个实体都无法解析出来, 这样的情况在实际开发中很常见( - _ -||), 一个解决方案就是把属性都变为可选, 这样尽最大可能不影响到实际解析结果.
struct DataRootClass: Decodable {
var status: String?
var message: String?
var code: Int?
}
另外针对一些复杂的 JSON 结构, 更好的办法是先使用 SwiftyJSON 将内部数据剥离开, 然后单独进行解析, 这样避免写复杂的自定义解析规则代码.