Swift - Codable 使用小记

掘金同步更新：https://juejin.cn/user/3378158048121326/posts

Codable 简介

Codable 协议在 Swift4.0 开始被引入，目标是取代现有的 NSCoding 协议，它对结构体，枚举和类都支持。Codable 的引入简化了JSON 和 Swift 类型之间相互转换的难度，能够把 JSON 这种弱类型数据转换成代码中使用的强类型数据。

Codable 是 Encodable 和 Decodable 两个协议的组合：

public typealias Codable = Decodable & Encodable

Encodable 协议定义了一个方法：

public protocol Encodable {
    func encode(to encoder: Encoder) throws
}

如数据遵守这个协议，并且数据中所有成员都是 encodable，编译器会自动生成相关实现。
如不可编码，需自定义，自己实现。

Decodable 协议定义了一个初始化函数：

public protocol Decodable {
    init(from decoder: Decoder) throws
}

跟 Encodable 一样，编译器也会自动为你生成相关的实现，前提是所有成员属性都是 Decodable 的。

由于 Swift 标准库中的类型，比如 String，Int，Double 和 Foundation 框架中 Data，Date，URL 都是默认支持 Codable 协议的，所以只需声明支持协议即可。
我们不必同时遵循 Decodable、Encodable 协议，比如项目中只需获取网络数据解析为 Swift 类型，只需遵循 Decodable 协议就行了。我们要根据需要有选择的遵循 Decodable、Encodable 协议。

解码、编码过程

简单了解 Codable 后，我们先看看怎么使用的，看下面例子：

struct Person: Codable {
    let name: String
    let age: Int
}

//解码 JSON 数据
let json = #" {"name":"Tom", "age": 2} "#
let person = try JSONDecoder().decode(Person.self, from: json.data(using: .utf8)!)
print(person) //Person(name: "Tom", age: 2)

//编码导出为 JSON 数据
let data0 = try? JSONEncoder().encode(person)
let dataObject = try? JSONSerialization.jsonObject(with: data0!, options: [])
print(dataObject ?? "nil") //{ age = 2; name = Tom; }

let data1 = try? JSONSerialization.data(withJSONObject: ["name": person.name, "age": person.age], options: [])
print(String(data: data1!, encoding: .utf8)!) //{"name":"Tom","age":2}

上面的例子实现了从 JSON 数据解码到 Swift 中的数据，以及编码导出 JSON 数据，Person 中成员变量是遵循 Codable 协议的，所以编译器会自动生成相关的代码来实现编码、解码，我们只需调用 decode()、encode() 相关函数即可。

那么 Codable 是怎么实现呢？在编译代码时根据类型的属性，自动生成了一个 CodingKeys 的枚举类型定义，这个枚举需要包含需要编码或解码的属性字段，CodingKeys 枚举的 case 名称应该与类型中对应属性的名称相匹配。然后再给每一个声明实现 Codable 协议的类型自动生成 init(from:) 和 encode(to:) 两个函数的具体实现，最终完成了整个协议的实现。

如果 Swift 类型的结构与其编码形式的结构不同，可以自己实现 Encode、Decode 协议方法，定义自己的编码和解码逻辑。

struct Person: Codable {
    let name: String
    let age: Int
    var additionInfo: String?
    
    enum CodingKeys: String, CodingKey {
        case name, age
    }
    
    init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        name = try values.decode(String.self, forKey: .name)
        age = try values.decode(Int.self, forKey: .age)
    }
    
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(name, forKey: .name)
        try container.encode(age, forKey: .age)
    }
}

JSON 数据解析

了解了编码、解码的过程后，下面来看一下在项目中使用时需要注意的一些问题。

字段匹配问题

有时后端接口返回的数据命名规则和前端不一致，可能后端返回下划线命名法，而一般我们使用驼峰命名法，所以在字段映射的时候就需要修改一下。使用 CodingKeys 指定一个明确的映射。

struct Person: Codable {
    let firstName: String
    let age: Int
    
    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
        case age
    }
}

// {"first_name":"Tom", "age": 2 }

在 Swift4.1 之后 JSONDecoder 添加了 keyDecodingStrategy 属性，如果后端使用带下划线的，蛇形命名法，通过将 keyDecodingStrategy 属性的值设置为 convertFromSnakeCase，这样就不需要写额外的代码处理了。

var decoder = JSONDecoder()
decoder.keyDecodingStrategy = .convertFromSnakeCase

如果数据类型中的属性只有部分需要从 JSON 中解析获取，或者 JSON 中数据字段较多只需解析一部分，这是可以重写 CodingKeys 枚举值中仅列出需要解析的字段即可。

struct Person: Codable {
    let firstName: String
    let age: Int
    var additionalInfo: String?
    var addressInfo: String?
    
    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
        case age
    }
}

//JSON 数据
let json = #" {"first_name":"Tom", "age": 2, "additionalInfo":"123", "info":"abc"} "#
//解码
let person = try JSONDecoder().decode(Person.self, from: json.data(using: .utf8)!)
print(person)
//Person(firstName: "Tom", age: 2, additionalInfo: nil, addressInfo: nil)

嵌套类型

Swift 数据中属性可能是，嵌套的对象类型、数组或者字典类型，只要其中的每个元素都遵循 Codable 协议，那么整体数据类型就遵循 Codable 协议。

{
    "family_name":"101",
    "persons":[
          {
             "name": "小明",
             "age": 1
          },
          {
             "name": "小红",
             "age": 1
          }
    ]
}

struct Person: Codable {
    let name: String
    let age: Int
}

struct Family: Codable {
    let familyName: String
    let persons: [Person]
}

let family = try JSONDecoder().decode(Family.self, from: json.data(using: .utf8)!)
print(family)
//Family(familyName: "101", persons: [__lldb_expr_59.Person(name: "小明", age: 1), __lldb_expr_59.Person(name: "小红", age: 1)])

空值字段问题

有时后端接口返回的数据可能有值，也可能只是返回空值，如何处理？

{
    "familyName":"101",
    "person1": {
        "name": "小明",
        "age": 1
    },
    "person2": {},
    "person3": null
}

这时需要把属性设置为可选的，当返回为空对象或 null 时，解析为 nil。

struct Person: Codable {
    var name: String?
    var age: Int?
}
struct Family: Codable {
    let familyName: String
    var person1: Person?
    var person2: Person?
    var person3: Person?
}

let family = try JSONDecoder().decode(Family.self, from: json.data(using: .utf8)!)
print(family)
//Family(familyName: "101", person1: Optional(__lldb_expr_83.Person(name: Optional("小明"), age: Optional(1))), person2: Optional(__lldb_expr_83.Person(name: nil, age: nil)), person3: nil)

当遇到返回值为 null 时，需要给对应的属性设置一个默认值，这时我们可以重写 init(from decoder: Decoder) 方法，在里面做相应的处理，如下：

init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        familyName = try container.decode(String.self, forKey: .familyName)
        //..
        person3 = try container.decodeIfPresent(Person.self, forKey: .person3) ?? Person(name: "defaultName", age: -1)
    }

上面使用了 decodeIfPresent 方法，当不确定键值是否会存在时，在设置属性时把这个属性设置为可选，然后使用 decodeIfPresent 这个方法会查找该键值是否存在，如果存在就decode，如果不存在就会返回 nil。

枚举值

在后端返回的数据中，有的字段是确定的几种类别，我们希望转换成枚举类型，方便使用。例如性别数据：

{
    "name": "小明",
    "age": 1,
    "gender": "male"
}

enum Gender: String, Codable {
    case male
    case female
}
struct Person: Codable {
    var name: String?
    var age: Int?
    var gender: Gender?
}

枚举类型要默认支持 Codable 协议，需要声明为具有原始值的形式，并且原始值的类型需要支持 Codable 协议。上面例子使用字符串作为枚举类型的原始值，每个枚举成员的隐式原始值为该枚举成员的名称。如果对应的数据为整数的话，枚举可声明为：

enum Gender: Int, Codable {
    case male = 1
    case female = 2
}

日期解析

JSONDecoder 类声明了一个 DateDecodingStrategy 类型的属性，用来制定日期类型的解析策略。可选的格式标准有 secondsSince1970、millisecondsSince1970、iso8601 等

let json = """
{
    "birthday": "2001-04-20T14:15:00-0000"
}
"""

struct Person: Codable {
    var birthday: Date?
}

let decoder = JSONDecoder()
decoder.dateDecodingStrategy = .iso8601

let person = try decoder.decode(Person.self, from: json.data(using: .utf8)!)
print(person)
//Person(birthday: Optional(2001-04-20 14:15:00 +0000))

JSONDecoder 也提供了定制化方式，通过扩展 DateFormatter 定义一个新的格式，把这个作为参数传入 dateDecodingStrategy。

extension DateFormatter {
    static let myDateFormatter: DateFormatter = {
        let formatter = DateFormatter()
        formatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ss.SSSZZZZZ"
        formatter.timeZone = TimeZone(secondsFromGMT: 8)
        formatter.locale = Locale(identifier: "zh_Hans_CN")
        return formatter
    }()
}

let decoder = JSONDecoder()
decoder.dateDecodingStrategy = .formatted(DateFormatter.myDateFormatter)

plist 文件解析

Codable 协议并非只支持 JSON 格式的数据，它同样支持 plist 文件格式。使用方式与 JSON 格式一致，并不需要对已经实现的 Codable 协议作任何修改，只需要将 JSONEncoder 和 JSONDecoder 替换成对应的 PropertyListEncoder 和 PropertyListDecoder 即可。

plist 本质上是特殊格式标准的 XML 文档，所以理论上来说，我们可以参照系统提供的 Decoder/Encoder 自己实现任意格式的数据序列化与反序列化方案。同时苹果也随时可能通过实现新的 Decoder/Encoder 类来扩展其他数据格式的处理能力。Codable 的能力并不止于此，它具有很大的可扩展空间。

References

https://developer.apple.com/documentation/foundation/archives_and_serialization/encoding_and_decoding_custom_types
https://zhuanlan.zhihu.com/p/50043306
https://me.harley-xk.studio/posts/201706281716