iOS开发 – Swift Codable协议实战：快速、简单、高效地完成JSON和Model转换！-六虎

前语

Codable 是 Swift 4.0 引入的一种协议，它是一个组合协议，由 Decodable 和 Encodable 两个协议组成。它的作用是将模型目标转化为 JSON 或者是其它的数据格式，也能够反过来将 JSON 数据转化为模型目标。

Encodable 和 Decodable 别离界说了 encode(to:) 和 init(from:) 两个协议函数，别离用来完成数据模型的归档和外部数据的解析和实例化。最常用的场景便是刚说到的 JSON 数据与模型的彼此转化，可是 Codable 的才能并不止于此。

简略运用

在实践开发中，Codable 的运用十分便利，只需求让模型遵从 Codable 协议即可：

struct GCPerson: Codable {
    var name: String
    var age: Int
    var height: Float // cm
    var isGoodGrades: Bool
}

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

func encodePerson() {
	let person = GCPerson(name: "XiaoMing", age: 16, height: 160.5, isGoodGrades: true)
	let encoder = JSONEncoder()
	encoder.outputFormatting = .prettyPrinted // 高雅永不过期，json会好亮点哟
	do {
		let data = try encoder.encode(person)
		let jsonStr = String(data: data, encoding: .utf8)
		textView.text = jsonStr
		print(jsonStr as Any)
	} catch let err {
		print("err", err)
	}
}
func decodePerson() {
	let jsonStr = "{\"age\":16,\"isGoodGrades\":1,\"name\":\"XiaoMing\",\"height\":160.5}"
	guard let data = jsonStr.data(using: .utf8) else {
		print("get data fail")
		return
	}
	let decoder = JSONDecoder()
	do {
		let person = try decoder.decode(GCPerson.self, from: data)
		print(person)
	} catch let err {
		print("err", err)
	}
}

上面比方的输出：

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

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

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

CodingKeys 字段映射

假如特点称号与 JSON 数据中的键名不一致，需求运用 Swift 语言中的 CodingKeys 枚举来映射特点称号和键名。CodingKeys 是一个遵从了 CodingKey 协议的枚举，它能够用来描绘 Swift 目标的特点与 JSON 数据中的键名之间的映射关系。

struct Address: Codable {
    var zipCode: Int
    var fullAddress: String
    enum CodingKeys: String, CodingKey {
        case zipCode = "zip_code"
        case fullAddress = "full_address"
    }
}

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

func encodeAddress() {
	let address = Address(zipCode: 528000, fullAddress: "don't tell you")
	let encoder = JSONEncoder()
	encoder.outputFormatting = .prettyPrinted // 高雅永不过期，json会好亮点哟
	do {
		let data = try encoder.encode(address)
		let jsonStr = String(data: data, encoding: .utf8)
		textView.text.append("\n\n")
		textView.text = textView.text.appending(jsonStr ?? "")
		print(jsonStr as Any)
	} catch let err {
		print("err", err)
	}
}
func decodeAddress() {
	let jsonStr = "{\"zip_code\":528000,\"full_address\":\"don't tell you\"}"
	guard let data = jsonStr.data(using: .utf8) else {
		print("get data fail")
		return
	}
	let decoder = JSONDecoder()
	do {
		let address = try decoder.decode(Address.self, from: data)
		print(address)
	} catch let err {
		print("err", err)
	}
}

此时的输出为：

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

从控制台日志能够看出，Address 模型中的的 zipCode 和 fullAddress 特点字段已被替换为 zip_code 和 full_address，值得留意的是，运用 CodingKeys 映射后就只能运用映射后的字段称号。

数据类型匹配

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

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

在上面的比方中，将 isGoodGrades 的值改为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。

struct Activity: Codable {
    var time: Date
    var url: URL?
}

编码解码的作业：

func encodeActivity() {
	let activity = Activity(time: Date(), url: URL(string: "https://www.baidu.com"))
	let encoder = JSONEncoder()
	encoder.outputFormatting = .prettyPrinted // 高雅永不过期，json会好亮点哟
	encoder.dateEncodingStrategy = .secondsSince1970 // 秒
	do {
		let data = try encoder.encode(activity)
		let jsonStr = String(data: data, encoding: .utf8)
		textView.text.append("\n\n")
		textView.text = textView.text.appending(jsonStr ?? "")
		print(jsonStr as Any)
	} catch let err {
		print("err", err)
	}
}
func decodeActivity() {
//        let jsonStr = "{\"time\":528000,\"url\":111}" // 即便是 Optional 的特点也要对应的数据类型，不然仍是会解析失利
	let jsonStr = "{\"time\":1681055185}" // Optional类型的特点字段，直接不传也是nil
	//        let jsonStr = "{\"time\":528000,\"url\":null}" // 以下三种也能被解析为nil，\"null\" / \"nil\" / null
	guard let data = jsonStr.data(using: .utf8) else {
		print("get data fail")
		return
	}
	let decoder = JSONDecoder()
	decoder.dateDecodingStrategy = .secondsSince1970 // 秒
	do {
		let activity = try decoder.decode(Activity.self, from: data)
		print(activity)
	} catch let err {
		print("err", err)
	}
}

此时的输出为：

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

自界说编解码

有时分前后端界说的模型不同时，有可能会需求用到自界说编解码，以此来达成“统一”。

比方咱们现在有一个 Dog 模型，sex 字段为 Bool 型，在后端的界说为 0 和 1，此时咱们需求将它们给转化起来，能够是 false 为 0，true 为 1。

struct Dog: Codable {
    var name: String
    var sex: Bool // 0/false女 1/true男
    init(name: String, sex: Bool) {
        self.name = name
        self.sex = sex
    }
    // 必须完成此枚举，在编码解码办法中需求用到
    enum CodingKeys: CodingKey {
        case name
        case sex
    }
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.name = try container.decode(String.self, forKey: .name)
        // 取出来int后再转化为Bool
        let sexInt = try container.decode(Int.self, forKey: .sex)
        sex = sexInt == 1
    }
    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(self.name, forKey: .name)
        // 将sex特点以int类型编码
        try container.encode(sex ? 1 : 0, forKey: .sex)
    }
}

在编码的时分将 sex 从 Bool 型转化为 Int 型，解码时则反过来。编解码的作业仍旧与前面的大致一样：

func encodeDog() {
	let dog = Dog(name: "Max", sex: true)
	let encoder = JSONEncoder()
	encoder.outputFormatting = .prettyPrinted // 高雅永不过期，json会好亮点哟
	do {
		let data = try encoder.encode(dog)
		let jsonStr = String(data: data, encoding: .utf8)
		textView.text.append("\n\n")
		textView.text = textView.text.appending(jsonStr ?? "")
		print(jsonStr as Any)
	} catch let err {
		print("err", err)
	}
}
func decodeDog() {
	let jsonStr = "{\"name\":\"Max\",\"sex\":1}"
	guard let data = jsonStr.data(using: .utf8) else {
		print("get data fail")
		return
	}
	let decoder = JSONDecoder()
	do {
		let dog = try decoder.decode(Dog.self, from: data)
		print(dog)
	} catch let err {
		print("err", err)
	}
}

此时的日志输出为：

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

总结

Codable 是 Swift 中十分便利的一个协议，能够协助咱们快速进行数据的编码和解码，提高了开发效率和代码可读性。当然运用不当也会形成严峻的灾难，所以我为我们整理了以下几点运用时的留意事项，希望能对我们有所协助：

嵌套的数据结构也需求遵从 Codable 协议。
Bool 型只支撑 true 或 false。
Optional 类型修饰的特点字段，直接不传是 nil，或将值设定为以下三种也能被解析为 nil，\"null\" / \"nil\" / null。
能够运用自界说的编码器和解码器来进行转化。

Demo

我把代码放在了 github 上面，能够到这儿下载：GarveyCalvin/iOS-Travel。

谢谢你这么好看还重视我，我们一起进步吧。

关于作者

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

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

前语

简略运用

CodingKeys 字段映射

数据类型匹配

Date 和 Optional 可选类型

自界说编解码

总结

Demo

关于作者

相关文章

移动端APP组件化架构实践

拒绝叠叠乐！我用设计模式重构核心项目

Databend 开源周报 第 83 期

玩转Midjourney系列三: 使用golang调用Midjourney Bot

作者信息

Databend 开源周报第 83 期