[Swift]Swift原生：JSON轉換Model

★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★
➤微信公眾號：山青詠芝（let_us_code）
➤博客園地址：山青詠芝（https://www.cnblogs.com/strengthen/）
➤GitHub地址：https://github.com/strengthen/LeetCode
➤原文地址： https:////www.cnblogs.com/strengthen/p/12381682.html
➤原文已修改更新！強烈建議點擊原文地址閱讀！支持作者！支持原創！
★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★★

熱烈歡迎，請直接點擊！！！

進入博主App Store主頁，下載使用各個作品！！！

注：博主將堅持每月上線一個新app！！！

Apple 在 Swift  的 Foundation 的模塊中添加了對 JSON 解析成Model的原生支持。

雖然之前也有ObjectMapper和SwiftyJSON這樣的解決方案，但是Swift 中添加了原生支持還是不免讓人興奮，使用起來也相對方便了許多。

簡單使用

如果你的 JSON 數據結構和你使用的 Model 對象結構一致的話，那么解析過程將會非常簡單。只需要讓Model聲明 Codable 協議即可。

JSON數據：

{
    "userInfos": [
        {
            "userName": "小名",
            "age": 18,
            "height": 178.56,
            "sex": true
        },
        {
            "userName": "小方",
            "age": 18,
            "height": 162.56,
            "sex": false
        }
    ]
}

Model對象：

struct UserList: Codable {

    let userInfos: [UserInfo]

    struct UserInfo: Codable {

        let userName: String
        let age: Int
        let height: Float
        let sex: Bool
    }
}

JSON轉Model：

    let jsonDecoder = JSONDecoder()
    let modelObject = try? jsonDecoder.decode(UserList.self, from: jsonData)

Model轉JSON：

    let jsonEncoder = JSONEncoder()
    let jsonData = try? jsonEncoder.encode(modelObject)

關於 Codable

/// A type that can convert itself into and out of an external representation.
public typealias Codable = Decodable & Encodable

Codable 同時聲明了 Decodable 和 Encodable 兩個協議，只需要單向處理的話可以只聲明其中一個協議。

需要注意的是，使用時必須保證 JSON 數據結構和你使用的 Model 對象結構一致，任何不一致都會導致解析失敗。

但是實際開發過程中，往往不會總是這樣滿足我們的需要，有時也需要我們對解析過程做一些改變。

自定義鍵值名

為了保持風格一致，我們有時候不得不改變key成為我們需要的key值。

仍然使用上面的例子，現在我們把Model中的key height 改為 bodyHeight

struct UserList: Codable {

    let userInfos: [UserInfo]
    
    struct UserInfo: Codable {
        
        let userName: String
        let age: Int
        let bodyHeight: Float
        let sex: Bool
        
        private enum CodingKeys: String, CodingKey {
            case userName
            case age
            case bodyHeight = "height"
            case sex
        }
    }
}

格式處理

JSONEncoder 和 JSONDecoder 本身也提供了對時間格式的處理，Data的處理，浮點不匹配的處理。可以根據自己的需要設置自己想要的格式。

    /// The strategy to use in decoding dates. Defaults to `.deferredToDate`.
    open var dateDecodingStrategy: JSONDecoder.DateDecodingStrategy

    /// The strategy to use in decoding binary data. Defaults to `.base64`.
    open var dataDecodingStrategy: JSONDecoder.DataDecodingStrategy

    /// The strategy to use in decoding non-conforming numbers. Defaults to `.throw`.
    open var nonConformingFloatDecodingStrategy: JSONDecoder.NonConformingFloatDecodingStrategy

JSONEncoder 在生成 JSON 的時候默認的格式是

{"userInfos":[{"age":18,"sex":true,"height":178.55999755859375,"userName":"小名"},{"age":18,"sex":false,"height":162.55999755859375,"userName":"小方"}]}

如果想要提高閱讀體驗, 可以設置屬性 outputFormatting

open var outputFormatting: JSONEncoder.OutputFormatting

let jsonEncoder = JSONEncoder()
jsonEncoder.outputFormatting = .prettyPrinted

然后生成的JSON格式就會變成這樣

{
  "userInfos" : [
    {
      "age" : 18,
      "sex" : true,
      "height" : 178.55999755859375,
      "userName" : "小名"
    },
    {
      "age" : 18,
      "sex" : false,
      "height" : 162.55999755859375,
      "userName" : "小方"
    }
  ]
}

JSON中 沒有 Model 所需要的 Key

如果JSON的數據結構中，有些 Key - Value 不一定出現，Model中對應的要實用可選類型

JSON數據：

{
    "userInfos": [
        {
            "userName": "小名",
            "age": 18,
            "sex": true
        },
        {
            "userName": "小方",
            "age": 18,
            "height": 162.56,
            "sex": false
        }
    ]
}

Model對象：

struct UserList: Codable {

    let userInfos: [UserInfo]

    struct UserInfo: Codable {

        let userName: String
        let age: Int
        let height: Float?
        let sex: Bool
    }
}