iOS开发 - Swift Codable协议实战：快速、简单、高效地完成JSON和Model转换！
<p><img src="https://img2023.cnblogs.com/blog/684349/202304/684349-20230424205622934-2141751684.png"></p><h2 id="前言">前言</h2>
<p><code>Codable</code> 是 <code>Swift 4.0</code> 引入的一种协议，它是一个组合协议，由 <code>Decodable</code> 和 <code>Encodable</code> 两个协议组成。它的作用是将模型对象转换为 JSON 或者是其它的数据格式，也可以反过来将 JSON 数据转换为模型对象。</p>
<p><code>Encodable</code> 和 <code>Decodable</code> 分别定义了 <code>encode(to:)</code> 和 <code>init(from:)</code> 两个协议函数，分别用来实现数据模型的归档和外部数据的解析和实例化。最常用的场景就是刚提到的 JSON 数据与模型的相互转换，但是 Codable 的能力并不止于此。</p>
<h2 id="简单应用">简单应用</h2>
<p>在实际开发中，<code>Codable</code> 的使用非常方便，只需要让模型遵循 <code>Codable</code> 协议即可：</p>
<pre><code class="language-swift">struct GCPerson: Codable {
var name: String
var age: Int
var height: Float // cm
var isGoodGrades: Bool
}
</code></pre>
<p>接下来编写数据编码和解码的方法：</p>
<pre><code class="language-swift">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)
}
}
</code></pre>
<p>上面例子的输出：</p>
<pre><code>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)
</code></pre>
<p>应该有眼尖的童鞋是发现了，我将 <code>JSONEncoder</code> 的 <code>outputFormatting</code> 设置为了 <code>prettyPrinted</code>，这会让它输出的时候会美观一下，比如将它们放置在 <code>UITextView</code> 视图中作对比：</p>
<p><img src="https://img2023.cnblogs.com/blog/684349/202304/684349-20230424205721395-1074930491.png"></p>
<blockquote>
<p>这里指的 <code>default</code> 是在没有设置 <code>outputFormatting</code> 的默认情况</p>
</blockquote>
<h2 id="codingkeys-字段映射">CodingKeys 字段映射</h2>
<p>如果属性名称与 JSON 数据中的键名不一致，需要使用 <code>Swift</code> 语言中的 <code>CodingKeys</code> 枚举来映射属性名称和键名。<code>CodingKeys</code> 是一个遵循了 <code>CodingKey</code> 协议的枚举，它可以用来描述 <code>Swift</code> 对象的属性与 JSON 数据中的键名之间的映射关系。</p>
<pre><code class="language-swift">struct Address: Codable {
var zipCode: Int
var fullAddress: String
enum CodingKeys: String, CodingKey {
case zipCode = "zip_code"
case fullAddress = "full_address"
}
}
</code></pre>
<p>数据编码和解码的方法与前面的大同小异：</p>
<pre><code class="language-swift">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)
}
}
</code></pre>
<p>此时的输出为：</p>
<pre><code>Optional("{\n\"zip_code\" : 528000,\n\"full_address\" : \"don\'t tell you\"\n}")
Address(zipCode: 528000, fullAddress: "don\'t tell you")
</code></pre>
<p>从控制台日志可以看出，<code>Address</code> 模型中的的 <code>zipCode</code> 和 <code>fullAddress</code> 属性字段已被替换为 <code>zip_code</code> 和 <code>full_address</code>，值得注意的是，使用 <code>CodingKeys</code> 映射后就只能使用映射后的字段名称。</p>
<h2 id="数据类型匹配">数据类型匹配</h2>
<p><code>Swift</code> 中的数据类型需要与 JSON 数据中的数据类型匹配，否则将无法正确地进行解码。如果数据类型不匹配，则会进入到 <code>catch</code> 代码块，意味着解码失败。</p>
<pre><code class="language-swift">let jsonStr = "{\"age\":16,\"isGoodGrades\":1,\"name\":\"XiaoMing\",\"height\":160.5}"
</code></pre>
<p>在上面的例子中，将 isGoodGrades 的值改为1，此时输出的错误内容为：</p>
<pre><code>err typeMismatch(Swift.Bool, Swift.DecodingError.Context(codingPath: , debugDescription: "Expected to decode Bool but found a number instead.", underlyingError: nil))
</code></pre>
<p>由此引出，<code>Bool</code> 型只支持 <code>true</code> 和 <code>false</code>，其它一概不认。</p>
<blockquote>
<p>注意：只要是其中一个数据字段不能解析，则整条解析失败。</p>
</blockquote>
<h2 id="date-和-optional-可选类型">Date 和 Optional 可选类型</h2>
<p>在使用 <code>Codable</code> 对 Date 和 Optional 属性进行编解码时，有些细节是需要了解的。</p>
<p><code>Codable</code> 默认启用的时间策略是 <code>deferredToDate</code>，即从 <code>UTC时间2001年1月1日0时0分0秒</code> 开始的秒数，对应 <code>Date</code> 类型中 <code>timeIntervalSinceReferenceDate</code> 这个属性。比如 <code>702804983.44863105</code> 这个数字解析后的结果是 <code>2023-04-10 07:34:17 +0000</code>。</p>
<p>在这儿把时间策略设置为 <code>secondsSince1970</code>，因为这个会比上面的要常用。我们需将 <code>JSONEncoder</code> 的 <code>dateEncodingStrategy</code> 设置为 <code>secondsSince1970</code>，<code>JSONDecoder</code> 也是相同的设置。</p>
<p>在设置 <code>Optional</code> 可选类型时，在编码时，为空的属性不会包含在 JSON 数据中。在解码时，直接不传或将值设定为 <code>\"null\"</code> / <code>\"nil\"</code> / <code>null</code> 这三种值也能被解析为 <code>nil</code>。</p>
<pre><code class="language-swift">struct Activity: Codable {
var time: Date
var url: URL?
}
</code></pre>
<p>编码解码的工作：</p>
<pre><code class="language-swift">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)
}
}
</code></pre>
<p>此时的输出为：</p>
<pre><code>Optional("{\n\"url\" : \"https:\\/\\/www.baidu.com\",\n\"time\" : 1681057020.835813\n}")
Activity(time: 2023-04-09 15:46:25 +0000, url: nil)
</code></pre>
<h2 id="自定义编解码">自定义编解码</h2>
<p>有时候前后端定义的模型不同时，有可能会需要用到自定义编解码，以此来达成“统一”。</p>
<p>比如我们现在有一个 Dog 模型，sex 字段为 Bool 型，在后端的定义为 0 和 1，此时我们需要将它们给转换起来，可以是 false 为 0，true 为 1。</p>
<pre><code class="language-swift">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)
}
}
</code></pre>
<p>在编码的时候将 sex 从 Bool 型转换为 Int 型，解码时则反过来。编解码的工作依旧与前面的大致一样：</p>
<pre><code class="language-swift">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)
}
}
</code></pre>
<p>此时的日志输出为：</p>
<pre><code>Optional("{\n\"name\" : \"Max\",\n\"sex\" : 1\n}")
Dog(name: "Max", sex: true)
</code></pre>
<h2 id="总结">总结</h2>
<p><code>Codable</code> 是 <code>Swift</code> 中非常方便的一个协议，可以帮助我们快速进行数据的编码和解码，提高了开发效率和代码可读性。当然使用不当也会造成严重的灾难，所以我为大家整理了以下几点使用时的注意事项，希望能对大家有所帮助：</p>
<ol>
<li>嵌套的数据结构也需要遵循 <code>Codable</code> 协议。</li>
<li><code>Bool</code> 型只支持 <code>true</code> 或 <code>false</code>。</li>
<li><code>Optional</code> 类型修饰的属性字段，直接不传是 <code>nil</code>，或将值设定为以下三种也能被解析为 <code>nil</code>，<code>\"null\"</code> / <code>\"nil\"</code> / <code>null</code>。</li>
<li>可以使用自定义的编码器和解码器来进行转换。</li>
</ol>
<h2 id="demo">Demo</h2>
<p>我把代码放在了 github 上面，可以到这儿下载：GarveyCalvin/iOS-Travel。</p>
<p>谢谢你这么好看还关注我，大家一起进步吧。</p>
<h2 id="关于作者">关于作者</h2>
<p>博文作者：GarveyCalvin<br>
公众号：凡人程序猿<br>
本文版权归作者所有，欢迎转载，但必须保留此段声明，并给出原文链接，谢谢合作！</p>
</div>
<div id="MySignature" role="contentinfo">
活着，就是为了改变世界！<br><br>
来源：https://www.cnblogs.com/GarveyCalvin/p/swift-codable-json-model.html
頁:
[1]