Swift Codable协议实战：快速、简单、高效地完成JSON和Model转换！ ...

前言

Codable 是 Swift 4.0 引入的一种协议，它是一个组合协议，由 Decodable 和 Encodable 两个协议组成。它的作用是将模型对象转换为 JSON 或者是其它的数据格式，也可以反过来将 JSON 数据转换为模型对象。
Encodable 和 Decodable 分别定义了 encode(to:) 和 init(from:) 两个协议函数，分别用来实现数据模型的归档和外部数据的解析和实例化。最常用的场景就是刚提到的 JSON 数据与模型的相互转换，但是 Codable 的能力并不止于此。
简单应用

在实际开发中，Codable 的使用非常方便，只需要让模型遵循 Codable 协议即可：

1. struct GCPerson: Codable {
2.     var name: String
3.     var age: Int
4.     var height: Float // cm
5.     var isGoodGrades: Bool
6. }

复制代码

接下来编写数据编码和解码的方法：

1. func encodePerson() {
2.         let person = GCPerson(name: "XiaoMing", age: 16, height: 160.5, isGoodGrades: true)
3.         let encoder = JSONEncoder()
4.         encoder.outputFormatting = .prettyPrinted // 优雅永不过时，json会好看点哟
5.         do {
6.                 let data = try encoder.encode(person)
7.                 let jsonStr = String(data: data, encoding: .utf8)
8.                 textView.text = jsonStr
9.                 print(jsonStr as Any)
10.         } catch let err {
11.                 print("err", err)
12.         }
13. }
15. func decodePerson() {
16.         let jsonStr = "{"age":16,"isGoodGrades":1,"name":"XiaoMing","height":160.5}"
17.         guard let data = jsonStr.data(using: .utf8) else {
18.                 print("get data fail")
19.                 return
20.         }
21.         let decoder = JSONDecoder()
22.         do {
23.                 let person = try decoder.decode(GCPerson.self, from: data)
24.                 print(person)
25.         } catch let err {
26.                 print("err", err)
27.         }
28. }

复制代码

上面例子的输出：

1. Optional("{\n  "age" : 16,\n  "isGoodGrades" : true,\n  "name" : "XiaoMing",\n  "height" : 160.5\n}")
2. GCPerson(name: "XiaoMing", age: 16, height: 160.5, isGoodGrades: false)

复制代码

应该有眼尖的童鞋是发现了，我将 JSONEncoder 的 outputFormatting 设置为了 prettyPrinted，这会让它输出的时候会美观一下，比如将它们放置在 UITextView 视图中作对比：

这里指的 default 是在没有设置 outputFormatting 的默认情况

CodingKeys 字段映射

如果属性名称与 JSON 数据中的键名不一致，需要使用 Swift 语言中的 CodingKeys 枚举来映射属性名称和键名。CodingKeys 是一个遵循了 CodingKey 协议的枚举，它可以用来描述 Swift 对象的属性与 JSON 数据中的键名之间的映射关系。

1. struct Address: Codable {
2.     var zipCode: Int
3.     var fullAddress: String
4.    
5.     enum CodingKeys: String, CodingKey {
6.         case zipCode = "zip_code"
7.         case fullAddress = "full_address"
8.     }
9. }

复制代码

数据编码和解码的方法与前面的大同小异：

1. func encodeAddress() {
2.         let address = Address(zipCode: 528000, fullAddress: "don't tell you")
3.         let encoder = JSONEncoder()
4.         encoder.outputFormatting = .prettyPrinted // 优雅永不过时，json会好看点哟
5.         do {
6.                 let data = try encoder.encode(address)
7.                 let jsonStr = String(data: data, encoding: .utf8)
8.                 textView.text.append("\n\n")
9.                 textView.text = textView.text.appending(jsonStr ?? "")
10.                 print(jsonStr as Any)
11.         } catch let err {
12.                 print("err", err)
13.         }
14. }
16. func decodeAddress() {
17.         let jsonStr = "{"zip_code":528000,"full_address":"don't tell you"}"
18.         guard let data = jsonStr.data(using: .utf8) else {
19.                 print("get data fail")
20.                 return
21.         }
22.         let decoder = JSONDecoder()
23.         do {
24.                 let address = try decoder.decode(Address.self, from: data)
25.                 print(address)
26.         } catch let err {
27.                 print("err", err)
28.         }
29. }

复制代码

此时的输出为：

1. Optional("{\n  "zip_code" : 528000,\n  "full_address" : "don\'t tell you"\n}")
2. Address(zipCode: 528000, fullAddress: "don\'t tell you")

复制代码

从控制台日志可以看出，Address 模型中的的 zipCode 和 fullAddress 属性字段已被替换为 zip_code 和 full_address，值得注意的是，使用 CodingKeys 映射后就只能使用映射后的字段名称。
数据类型匹配

Swift 中的数据类型需要与 JSON 数据中的数据类型匹配，否则将无法正确地进行解码。如果数据类型不匹配，则会进入到 catch 代码块，意味着解码失败。

1. let jsonStr = "{"age":16,"isGoodGrades":1,"name":"XiaoMing","height":160.5}"

复制代码

在上面的例子中，将 isGoodGrades 的值改为1，此时输出的错误内容为：

1. err typeMismatch(Swift.Bool, Swift.DecodingError.Context(codingPath: [CodingKeys(stringValue: "isGoodGrades", intValue: nil)], debugDescription: "Expected to decode Bool but found a number instead.", underlyingError: nil))

复制代码

由此引出，Bool 型只支持 true 和 false，其它一概不认。

注意：只要是其中一个数据字段不能解析，则整条解析失败。

Date 和 Optional 可选类型

在使用 Codable 对 Date 和 Optional 属性进行编解码时，有些细节是需要了解的。
Codable 默认启用的时间策略是 deferredToDate，即从 UTC时间2001年1月1日0时0分0秒 开始的秒数，对应 Date 类型中 timeIntervalSinceReferenceDate 这个属性。比如 702804983.44863105 这个数字解析后的结果是 2023-04-10 07:34:17 +0000。
在这儿把时间策略设置为 secondsSince1970，因为这个会比上面的要常用。我们需将 JSONEncoder 的 dateEncodingStrategy 设置为 secondsSince1970，JSONDecoder 也是相同的设置。
在设置 Optional 可选类型时，在编码时，为空的属性不会包含在 JSON 数据中。在解码时，直接不传或将值设定为 \"null\" / \"nil\" / null 这三种值也能被解析为 nil。

1. struct Activity: Codable {
2.     var time: Date
3.     var url: URL?
4. }

复制代码

编码解码的工作：

1. func encodeActivity() {
2.         let activity = Activity(time: Date(), url: URL(string: "https://www.baidu.com"))
3.         let encoder = JSONEncoder()
4.         encoder.outputFormatting = .prettyPrinted // 优雅永不过时，json会好看点哟
5.         encoder.dateEncodingStrategy = .secondsSince1970 // 秒
6.         do {
7.                 let data = try encoder.encode(activity)
8.                 let jsonStr = String(data: data, encoding: .utf8)
9.                 textView.text.append("\n\n")
10.                 textView.text = textView.text.appending(jsonStr ?? "")
11.                 print(jsonStr as Any)
12.         } catch let err {
13.                 print("err", err)
14.         }
15. }
17. func decodeActivity() {
18. //        let jsonStr = "{"time":528000,"url":111}" // 即便是 Optional 的属性也要对应的数据类型，否则还是会解析失败
19.         let jsonStr = "{"time":1681055185}" // Optional类型的属性字段，直接不传也是nil
20.         //        let jsonStr = "{"time":528000,"url":null}" // 以下三种也能被解析为nil，"null" / "nil" / null
21.         guard let data = jsonStr.data(using: .utf8) else {
22.                 print("get data fail")
23.                 return
24.         }
25.         let decoder = JSONDecoder()
26.         decoder.dateDecodingStrategy = .secondsSince1970 // 秒
27.         do {
28.                 let activity = try decoder.decode(Activity.self, from: data)
29.                 print(activity)
30.         } catch let err {
31.                 print("err", err)
32.         }
33. }

复制代码

此时的输出为：

1. Optional("{\n  "url" : "https:\\/\\/www.baidu.com",\n  "time" : 1681057020.835813\n}")
2. Activity(time: 2023-04-09 15:46:25 +0000, url: nil)

复制代码

自定义编解码

有时候前后端定义的模型不同时，有可能会需要用到自定义编解码，以此来达成“统一”。
比如我们现在有一个 Dog 模型，sex 字段为 Bool 型，在后端的定义为 0 和 1，此时我们需要将它们给转换起来，可以是 false 为 0，true 为 1。

1. struct Dog: Codable {
2.     var name: String
3.     var sex: Bool // 0/false女 1/true男
4.    
5.     init(name: String, sex: Bool) {
6.         self.name = name
7.         self.sex = sex
8.     }
9.    
10.     // 必须实现此枚举，在编码解码方法中需要用到
11.     enum CodingKeys: CodingKey {
12.         case name
13.         case sex
14.     }
16.     init(from decoder: Decoder) throws {
17.         let container = try decoder.container(keyedBy: CodingKeys.self)
18.         self.name = try container.decode(String.self, forKey: .name)
19.         // 取出来int后再转换为Bool
20.         let sexInt = try container.decode(Int.self, forKey: .sex)
21.         sex = sexInt == 1
22.     }
23.    
24.     func encode(to encoder: Encoder) throws {
25.         var container = encoder.container(keyedBy: CodingKeys.self)
26.         try container.encode(self.name, forKey: .name)
27.         // 将sex属性以int类型编码
28.         try container.encode(sex ? 1 : 0, forKey: .sex)
29.     }
30. }

复制代码

在编码的时候将 sex 从 Bool 型转换为 Int 型，解码时则反过来。编解码的工作依旧与前面的大致一样：

1. func encodeDog() {
2.         let dog = Dog(name: "Max", sex: true)
3.         let encoder = JSONEncoder()
4.         encoder.outputFormatting = .prettyPrinted // 优雅永不过时，json会好看点哟
5.         do {
6.                 let data = try encoder.encode(dog)
7.                 let jsonStr = String(data: data, encoding: .utf8)
8.                 textView.text.append("\n\n")
9.                 textView.text = textView.text.appending(jsonStr ?? "")
10.                 print(jsonStr as Any)
11.         } catch let err {
12.                 print("err", err)
13.         }
14. }
16. func decodeDog() {
17.         let jsonStr = "{"name":"Max","sex":1}"
18.         guard let data = jsonStr.data(using: .utf8) else {
19.                 print("get data fail")
20.                 return
21.         }
22.         let decoder = JSONDecoder()
23.         do {
24.                 let dog = try decoder.decode(Dog.self, from: data)
25.                 print(dog)
26.         } catch let err {
27.                 print("err", err)
28.         }
29. }

复制代码

此时的日志输出为：

1. Optional("{\n  "name" : "Max",\n  "sex" : 1\n}")
2. Dog(name: "Max", sex: true)

复制代码

总结

Codable 是 Swift 中非常方便的一个协议，可以帮助我们快速进行数据的编码和解码，提高了开发效率和代码可读性。当然使用不当也会造成严重的灾难，所以我为大家整理了以下几点使用时的注意事项，希望能对大家有所帮助：

• 嵌套的数据结构也需要遵循 Codable 协议。
  
• Bool 型只支持 true 或 false。
  
• Optional 类型修饰的属性字段，直接不传是 nil，或将值设定为以下三种也能被解析为 nil，\"null\" / \"nil\" / null。
  
• 可以使用自定义的编码器和解码器来进行转换。
  

Demo

我把代码放在了 github 上面，可以到这儿下载：GarveyCalvin/iOS-Travel。
谢谢你这么好看还关注我，大家一起进步吧。
关于作者

博文作者：GarveyCalvin
公众号：凡人程序猿
本文版权归作者所有，欢迎转载，但必须保留此段声明，并给出原文链接，谢谢合作！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！