Swift之Codable⾃定义解析将任意数据类型解析为想要的类型
⼀、前⾔
⼤多数现代应⽤程序的共同点是，它们需要对各种形式的数据进⾏编码或解码。⽆论是通过⽹络下载的 Json 数据，还是存储在本地的模型的某种形式的序列化表⽰形式，对于⼏乎⽆任何 Swift 代码库⽽⾔，能够可靠地编码和解码不同的数据都是必不可少的。
这就是为什么 Swift 的 Codable API 能成为 Swift 4.0 的新功能⼀部分时，具有如此重要的重要原因。从那时起，它已发展成为⼀种标准的、健壮的机制，可以在 Apple 的各种平台中使⽤编码和解码包括服务器端 Swift。
Codable 之所以如此出⾊，是因为它与 Swift ⼯具链紧密集成，从⽽使编译器可以⾃动合成⼤量编码和解码各种值所需的代码。但是，有时需要⾃定义序列化时值的表⽰⽅式，那么该如何调整 Codable 实现来做到这⼀点呢？
⼆、Codable ⾃定义解析 Json
①修改 Key
可以通过修改⽤作序列化表⽰形式⼀部分的键来⾃定义类型的编码和解码⽅式。假设我们正在开发的⼀个核⼼数据模型如下所⽰：
struct Article: Codable {
var url: URL
var title: String
var body: String
}
我们的模型当前使⽤完全⾃动合成的 Codable 实现，这意味着其所有序列化键都将匹配其属性的名称。但是，将从中解码 Article 值的数据（例如，从服务器下载的 Json）可能会使⽤略有不同的命名约定，从⽽导致默认解码失败。幸运的是，这⼀问题很容易解决，要⾃定义 Codable 在解码（或编码）的 Article 类型的实例时将使⽤哪些键，要做的就是在其中定义⼀个 CodingKeys 枚举，并为与希望⾃定义的键匹配的⼤⼩写分配⾃定义原始值。如下所⽰：
extension Article {
enum CodingKeys: String, CodingKey {
case url ="source_link"
case title ="content_name"
case body
}
}
通过上述操作，可以继续利⽤编译器⽣成的默认实现进⾏实际的编码⼯作，同时仍能更改将⽤于序列化的键的名称。虽然上⾯的技术⾮常适合当我们想要使⽤完全⾃定义的键名时，但是如果只希望 Codable 使⽤属性名的 snake_case 版本（例如，将
backgroundColor 转换为 background_color），那么可以简单地更改 Json 解码器的 keyDecodingStrategy：
var decoder =JSONDecoder()
decoder.keyDecodingStrategy =.convertFromSnakeCase
以上两个 API 的优点在于，它们能够解决 Swift 模型与⽤于表⽰它们的数据之间的不匹配问题，⽽⽆需修改属性名称。
②忽略 Key
能够⾃定义编码键的名称确实很有⽤，但有时我们可能希望完全忽略某些键。例如，现在正在开发⼀个记笔记应⽤程序，并且使⽤户能够将各种笔记分组在⼀起以形成⼀个可以包括本地草稿的 NoteCollection：
struct NoteCollection: Codable {
var name: String
var notes:[Note]
var localDrafts =[Note]()
}
但是，虽然将 localDrafts 纳⼊ NoteCollection 模型确实很⽅便，但可以说，我们不希望在序列化或反序列化此类集合时包含这些草稿。这样做的原因可能是每次启动应⽤程序时为⽤户提供整洁的状态，或者是因为服务器不⽀持草稿。幸运的是，这也可以轻松完成，⽽不必更改 NoteCollection 的实际 Codable 实现，如果像以前⼀样定义⼀个 CodingKeys 枚举，⽽只是省略 localDrafts，那么在对 NoteCollection 值进⾏编码或解码时，将不会考虑该属性：
extension NoteCollection {
enum CodingKeys: CodingKey {
case name
case notes
}
}
为了使以上功能正常运⾏，要省略的属性必须具有默认值，在这种情况下，localDrafts 已具有默认值。
③创建匹配的结构
到⽬前为⽌，只是在调整类型的编码键，尽管这样做通常可以受益匪浅，但有时需要对 Codable ⾃定义进⾏进⼀步的调整。假设正在构建⼀个包含货币换算功能的应⽤，并且正在将给定货币的当前汇率下载为 Json 数据，如下所⽰：
{
"currency":"PLN",
"rates":{
"USD":3.76,
"EUR":4.24,
"SEK":0.41
}
}
然后，在 Swift 代码中，想要将此类 Json 响应转换为 CurrencyConversion 实例，每个实例都包含⼀个 ExchangeRate 条⽬数组，每个币种对应⼀个：
json值的类型有哪些struct CurrencyConversion {
var currency: Currency
var exchangeRates:[ExchangeRate]
}
struct ExchangeRate {
let currency: Currency
let rate: Double
}
但是，如果仅仅只是使以上两个模型都符合 Codable，将再次导致 Swift 代码与要解码的 Json 数据不匹配。但是这次，不只是关键字名称的问题，结构上有根本的不同。当然，可以修改 Swift 模型的结
构，使其与 Json 数据的结构完全匹配，但这并不总是可⾏的。
尽管拥有正确的序列化代码很重要，但是拥有适合实际代码库的模型结构也同样重要。
相反，创建⼀个新的专⽤类型，它将在 Json 数据中使⽤的格式与 Swift 代码的结构体之间架起⼀座桥梁。在这种类型中，我们将能够封装将 Json 汇率字典转换为⼀系列 ExchangeRate 模型所需的所有逻辑，如下所⽰：
private extension ExchangeRate {
struct List: Decodable {
let values:[ExchangeRate]
init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
let dictionary = try container.decode([String : Double].self)
values = dictionary.map { key, value in
ExchangeRate(currency:Currency(key), rate: value)
}
}
}
}
使⽤上述类型，现在可以定义⼀个私有属性，该名称与⽤于其数据的 Json 密钥相匹配，并使 exchangeRates 属性仅充当该私有属性的⾯向公众的代理：
struct CurrencyConversion: Decodable {
var currency: Currency
var exchangeRates:[ExchangeRate]{
return rates.values
}
private var rates: ExchangeRate.List
}
上⾯的⽅法起作⽤的原因是，在对值进⾏编码或解码时，永远不会考虑计算属性。当想使我们的 Swift 代码与使⽤⾮常不同的结构的Json API 兼容时，上述技术可能是⼀个很好的⼯具，且⽆需完全从头实现 Codable。
④转换值
在解码时，尤其是在使⽤⽆法控制的外部 Json API 进⾏解码时，⼀个⾮常常见的问题是，以与 Swift 的严格类型系统不兼容的⽅式对类型进⾏编码。例如，要解码的 Json 数据可能使⽤字符串来表⽰整数或其他类型的数字。
来看看⼀种可以处理这些值的⽅法，再次以⼀种⾃包含的⽅式，它不需要我们编写完全⾃定义的 Codable 实现。本质上想要做的是将字符串值转换为另⼀种类型，以 Int 为例，将从定义⼀个协议开始，该协议可以将任何类型都标记为 StringRepresentable，这意味着可以将其转换为字符串表⽰形式，也可以将其从字符串表⽰形式转换为需要的类型：
protocol StringRepresentable: CustomStringConvertible {
init?(_ string: String)
}
extension Int: StringRepresentable {}
接下来，创建另⼀个专⽤类型，这是为任何可以由字符串⽀持的值，并让它包含解码和编码⼀个值到字符串和从字符串编码所需的所有代码：
struct StringBacked<Value: StringRepresentable>: Codable {
var value: Value
init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
let string = try container.decode(String.self)
guard let value =Value(string)else{
throw DecodingError.dataCorruptedError(
in: container,
debugDescription:"Failed to convert an instance of \(Value.self) from '\(string)'"
)
}
self.value = value
}
func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
de(value.description)
}
}
就像以前为兼容 Json 的基础存储创建私有属性的⽅式⼀样，现在可以对编码后由字符串后端的任何属性执⾏相同的操作，同时仍将数据适当地公开给其它 Swift 代码类型，这是⼀个针对视频类型的 numberOfLikes 属性执⾏此操作的⽰例：
struct Video: Codable {
var title: String
var description: String
var url: URL
var thumbnailImageURL: URL
var numberOfLikes: Int {
get {return likes.value }
set { likes.value = newValue }
}
private var likes: StringBacked<Int>
}
在必须⼿动为属性定义 setter 和 getter 的复杂性与必须回退到完全⾃定义的 Codable 实现的复杂性之间，这⾥肯定有⼀个折中，但是对于上述 Video 结构体这样的类型，它在其中仅具有⼀个属性需要⾃定义，使⽤私有⽀持属性可能是⼀个不错的选择。
三、Codable 将任意类型解析为想要的类型
①常规解析
默认情况下，使⽤ Swift 内置的 Codable API 解析 Json 时，属性类型需要和 Json 中的类型保持⼀致，否则就会解析失败。
例如，现有如下 Json：
{
"name":"ydw",
"age":18
}
开发中常⽤的模型如下：
struct User: Codable {
var name: String
var age: Int
}
这个时候，正常解析则没有任何问题，但是：
当出现服务器将 age 中的 18 采⽤ String ⽅式 “18” 返回时，则⽆法解析，这是⾮常难遇见的情况；
另⼀种常见的是返回 “18.1”, 这是⼀个 Double 类型，这时候⼀样⽆法成功解析。
在使⽤ OC 的时候，常⽤的⽅法将其解析为 NSString 类型，使⽤的时候再进⾏转换，可是当使⽤ Swift 的 Codabel 时，就不能直接做到这样。
②如果服务器只会以 String ⽅式返回 Age，同时能确认⾥⾯是 Int 还是 Double
可以使⽤上⽂中的“值转换”来完成：
protocol StringRepresentable: CustomStringConvertible {
init?(_ string: String)
}
extension Int: StringRepresentable {}
struct StringBacked<Value: StringRepresentable>: Codable {
var value: Value
init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
let string = try container.decode(String.self)
guard let value =Value(string)else{
throw DecodingError.dataCorruptedError(
in: container,
debugDescription:"Failed to convert an instance of \(Value.self) from '\(string)'"
)
}
self.value = value
}
func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
de(value.description)
}
}
这个时候，模型如下：
{
"name":"zhy",
"age":"18"
}
struct User: Codable {
var name: String
var ageInt: Int {
get {return age.value }
set { age.value = newValue}
}
private var age: StringBacked<Int>
}
③不能确认是什么类型

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。