iOS開發 - Swift Codable協議實戰：快速、簡單、高效地完成JSON和Model轉換！

Codable 是 Swift 4.0 引入的一種協議，它是一個組合協議，由 Decodable 和 Encodable 兩個協議組成。它的作用是將模型對象轉換為 JSON 或者是其它的數據格式，也可以反過來將 JSON 數據轉換為模型對象。 ...

前言

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
公眾號：凡人程式猿
本文版權歸作者所有，歡迎轉載，但必須保留此段聲明，並給出原文鏈接，謝謝合作！

活著，就是為了改變世界！