Swift Json解析與model互轉

本文轉載自查看原文 2019-07-17 18:55 3424 IOS開發/ swift

Json的解碼與編碼操作，這里使用swift自帶的類JSONDecoder 和 JSONEncoder

1、基礎處理

如果你的 JSON 數據結構和你使用的 Model 對象結構一致的話，那么解析過程將會非常簡單

2、自定義鍵值名

默認情形下 Keys 是由編譯器自動生成的枚舉類型。該枚舉遵守 CodingKey 協議並建立了屬性和編碼后格式之間的關系

struct Beer : Codable {
// ...
private enum CodingKeys : String, CodingKey {
case name
case abv = "alcohol_by_volume"
case brewery = "brewery_name"
case style
}
}

3、時間格式處理

4、浮點類型處理

5、Data 處理

有時候服務端 API 返回的數據是 base64 編碼過的字符串。

對此，我們可以在 JSONEncoder 使用以下策略：

.base64
.custom( (Data, Encoder) throws -> Void)

反之，編碼時可以使用：

.base64
.custom( (Decoder) throws -> Data)

顯然，.base64 時最常見的選項，但如果需要自定義的話可以采用 block 方式。

6、Wrapper Keys

通常 API 會對數據進行封裝，這樣頂級的 JSON 實體始終是一個對象。

例如：

{
  "beers": [ {...} ] }

在 Swift 中我們可以進行對應處理：

struct BeerList : Codable { let beers: [Beer] }

因為鍵值與屬性名一致，所有上面代碼已經足夠了。

7、Root Level Arrays

如果 API 作為根元素返回數組，對應解析如下所示：

let decoder = JSONDecoder() let beers = try decoder.decode([Beer].self, from: data)

需要注意的是，我們在這里使用Array作為類型。只要 T 可解碼，Array <T> 就可解碼。

8、Dealing with Object Wrapping Keys

另一個常見的場景是，返回的數組對象里的每一個元素都被包裝為字典類型對象。

[
  {
    "beer" : { "id": "uuid12459078214", "name": "Endeavor", "abv": 8.9, "brewery": "Saint Arnold", "style": "ipa" } } ]

你可以使用上面的方法來捕獲此 Key 值，但最簡單的方式就是認識到該結構的可編碼的實現形式。

如下：

[[String:Beer]]

或者更易於閱讀的形式：

Array<Dictionary<String, Beer>>

與上面的 Array<T> 類似，如果 K 和 T 是可解碼 Dictionary<K,T> 就能解碼。

let decoder = JSONDecoder()
let beers = try decoder.decode([[String:Beer]].self, from: data) dump(beers)

 1 element ▿ 1 key/value pair ▿ (2 elements) - key: "beer" ▿ value: __lldb_expr_37.Beer - name: "Endeavor" - brewery: "Saint Arnold" - abv: 8.89999962 - style: __lldb_expr_37.BeerStyle.ipa

9、更復雜的嵌套

有時候 API 的響應數據並不是那么簡單。頂層元素不一定只是一個對象，而且通常情況下是多個字典結構。

例如：

{
    "meta": { "page": 1, "total_pages": 4, "per_page": 10, "total_records": 38 }, "breweries": [ { "id": 1234, "name": "Saint Arnold" }, { "id": 52892, "name": "Buffalo Bayou" } ] }

在 Swift 中我們可以進行對應的嵌套定義處理：

struct PagedBreweries : Codable { struct Meta : Codable { let page: Int let totalPages: Int let perPage: Int let totalRecords: Int enum CodingKeys : String, CodingKey { case page case totalPages = "total_pages" case perPage = "per_page" case totalRecords = "total_records" } } struct Brewery : Codable { let id: Int let name: String } let meta: Meta let breweries: [Brewery] }

該方法的最大優點就是對同一類型的對象做出不同的響應（可能在這種情況下，“brewery” 列表響應中只需要 id 和 name 屬性，但是如果查看詳細內容的話則需要更多屬性內容）。因為該情形下 Brewery 類型是嵌套的，我們依舊可以在其他地方進行不同的 Brewery 類型實現。

10、無法覆蓋繼承的問題，自定義解碼和編碼

============================================代碼示例============================================

model代碼如下

//為了將 JSON 字符串轉化為 Beer 類型的實例，我們需要將 Beer 類型標記為 Codable。

enum BeerStyle: String, Codable {
    case ipa
    case stout
    case kolsch
}

struct Beer: Codable {
    let name: String
    let abv: Float
    let brewery: String
    let style: BeerStyle
}

/// json 的key與結構體屬性不是對應的，需要自定義鍵值名
struct Beer2: Codable {
    let name: String
    let abv: Float
    let brewery: String
    let style: BeerStyle

    private enum CodingKeys: String, CodingKey {
        case name
        case abv = "alcohol_by_volume"
        case brewery = "brewery_name"
        case style
    }

    init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        name = try values.decode(String.self, forKey: Beer2.CodingKeys.name)
        abv = try values.decode(Float.self, forKey: Beer2.CodingKeys.abv)
        brewery = try values.decode(String.self, forKey: Beer2.CodingKeys.brewery)
        style = try values.decode(BeerStyle.self, forKey: Beer2.CodingKeys.style)
    }
}

class Wine: NSObject, Codable {
    var abv: Float?
}

class Beer3: Wine {
    var name: String?
    var brewery: String?
    var style: BeerStyle?
}

class Beer4: Wine {
    var name: String?
    var brewery: String?
    var style: BeerStyle?

    private enum CodingKeys: String, CodingKey {
        case name
        case abv = "alcohol_by_volume"
        case brewery = "brewery_name"
        case style
    }

    /// 自定義編碼
    override func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)

        try container.encode(name, forKey: .name)
        try container.encode(abv, forKey: .abv)
        try container.encode(brewery, forKey: .brewery)
        try container.encode(style, forKey: .style)
    }
    
    /// 自定義解碼
    required init(from decoder: Decoder) throws {
        super.init()
        let values = try decoder.container(keyedBy: CodingKeys.self)
        name = try values.decode(String.self, forKey: Beer4.CodingKeys.name)
        abv = try values.decode(Float.self, forKey: Beer4.CodingKeys.abv)
        brewery = try values.decode(String.self, forKey: Beer4.CodingKeys.brewery)
        style = try values.decode(BeerStyle.self, forKey: Beer4.CodingKeys.style)
    }
}

/// 時間格式處理
struct Foo: Encodable {
    let date: Date
}

/// 浮點類型處理
struct Numbers: Decodable {
    let a: Float
    let b: Float
    let c: Float
}

編碼與解碼

import UIKit

class jsonViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        
        jsonFunc1()
        jsonFunc2()
        jsonFunc3()
        jsonFunc4()
        jsonFunc7()
        jsonFunc8()
    }
}

// MARK: https://segmentfault.com/a/1190000009929819#articleHeader9

extension jsonViewController {
    /// JSON 數據結構和Model 對象結構一致
    func jsonFunc1() {
        let jsonString: String = "{\"name\":\"Endeavor\",\"abv\":8.9,\"brewery\":\"Saint Arnold\",\"style\":\"ipa\"}"
        let jsonData = jsonString.data(using: String.Encoding.utf8)
        let decoder = JSONDecoder()
        // JSON 數據解析為 Beer 實例對象
        let beer = try! decoder.decode(Beer.self, from: jsonData!)
        
        print("name=\(beer.name),abv=\(beer.abv),brewery=\(beer.brewery),style=\(beer.style)")
        /* 打印
         name=Endeavor,abv=8.9,brewery=Saint Arnold,style=ipa
         */
        
        let encoder = JSONEncoder()
        // 默認 outputFormatting 屬性值為 .compact，輸出效果如上。如果將其改為 .prettyPrinted 后就能獲得更好的閱讀體檢
        encoder.outputFormatting = .prettyPrinted
        // 將 Beer 實例轉化為 JSON
        let jsonData2 = try! encoder.encode(beer)
        
        print(String(bytes: jsonData2, encoding: String.Encoding.utf8) ?? "")
        
        /* 打印
         {
         "style" : "ipa",
         "brewery" : "Saint Arnold",
         "name" : "Endeavor",
         "abv" : 8.8999996185302734
         }
         */
    }
    
    /// JSON 數據結構和Model 對象結構不一致,自定義鍵值名
    func jsonFunc2() {
        let jsonString: String = "{\"name\":\"Endeavor\",\"alcohol_by_volume\":8.9,\"brewery_name\":\"Saint Arnold\",\"style\":\"ipa\"}"
        let jsonData = jsonString.data(using: String.Encoding.utf8)
        let decoder = JSONDecoder()
        // JSON 數據解析為 Beer 實例對象
        let beer = try! decoder.decode(Beer2.self, from: jsonData!)
        
        print("name=\(beer.name),abv=\(beer.abv),brewery=\(beer.brewery),style=\(beer.style)")
        /* 打印
         name=Endeavor,abv=8.9,brewery=Saint Arnold,style=ipa
         */
        
        let encoder = JSONEncoder()
        // 默認 outputFormatting 屬性值為 .compact，輸出效果如上。如果將其改為 .prettyPrinted 后就能獲得更好的閱讀體檢
        encoder.outputFormatting = .prettyPrinted
        // 將 Beer 實例轉化為 JSON
        let jsonData2 = try! encoder.encode(beer)
        
        print(String(bytes: jsonData2, encoding: String.Encoding.utf8) ?? "")
        /* 打印
         {
         "style" : "ipa",
         "name" : "Endeavor",
         "brewery_name" : "Saint Arnold",
         "alcohol_by_volume" : 8.8999996185302734
         }
         */
    }
    
    /// Codable 默認實現無法覆蓋繼承這種情況
    func jsonFunc3() {
        let jsonDic: [String: Any] = ["name": "Endeavor", "abv": 8.9, "brewery": "Saint Arnold", "style": "ipa"]
        let jsonData = JSONToData(obj: jsonDic)
        
        let decoder = JSONDecoder()
        // JSON 數據解析為 Beer 實例對象
        let beer = try! decoder.decode(Beer3.self, from: jsonData)
        
        print("name=\(String(describing: beer.name)),abv=\(String(describing: beer.abv)),brewery=\(String(describing: beer.brewery)),style=\(String(describing: beer.style))")
        /* 打印
         name=nil,abv=Optional(8.9),brewery=nil,style=nil
         */
        
        //解析成功但是 name、brewery、style 三個屬性全部為 nil,顯然，這不是我們想要的結果。Codable 默認實現無法覆蓋繼承這種情況
    }
    
    /// 解決 無法覆蓋繼承的問題，自定義解碼和編碼
    func jsonFunc4() {
        let jsonString: String = "{\"name\":\"Endeavor\",\"alcohol_by_volume\":8.9,\"brewery_name\":\"Saint Arnold\",\"style\":\"ipa\"}"
        let jsonData = jsonString.data(using: String.Encoding.utf8)
        let decoder = JSONDecoder()
        // JSON 數據解析為 Beer 實例對象
        let beer = try! decoder.decode(Beer4.self, from: jsonData!)

        print("name=\(String(describing: beer.name)),abv=\(String(describing: beer.abv)),brewery=\(String(describing: beer.brewery)),style=\(String(describing: beer.style))")
        /* 打印
         name=Optional("Endeavor"),abv=Optional(8.9),brewery=Optional("Saint Arnold"),style=Optional(abcProject.BeerStyle.ipa)
         */
        
        let encoder = JSONEncoder()
        // 默認 outputFormatting 屬性值為 .compact，輸出效果如上。如果將其改為 .prettyPrinted 后就能獲得更好的閱讀體檢
        encoder.outputFormatting = .prettyPrinted
        // 將 Beer 實例轉化為 JSON
        let jsonData2 = try! encoder.encode(beer)
        
        print(String(bytes: jsonData2, encoding: String.Encoding.utf8) ?? "")
        /* 打印
         {
         "style" : "ipa",
         "name" : "Endeavor",
         "brewery_name" : "Saint Arnold",
         "alcohol_by_volume" : 8.8999996185302734
         }
         */
    }
    
    /// 時間格式處理
    func jsonFunc7() {
        let encoder = JSONEncoder()
        encoder.dateEncodingStrategy = .iso8601
        let foo = Foo(date: Date())
        let jsonData2 = try! encoder.encode(foo)
        
        print(String(bytes: jsonData2, encoding: String.Encoding.utf8) ?? "")
        
        /*
         其他日期編碼格式選擇如下：
         
         .formatted(DateFormatter) - 當你的日期字符串是非標准格式時使用。需要提供你自己的日期格式化器實例。
         .custom( (Date, Encoder) throws -> Void ) - 當你需要真正意義上的自定義時，使用一個閉包進行實現。
         .millisecondsSince1970、 .secondsSince1970 - 這在 API 設計中不是很常見。 由於時區信息完全不在編碼表示中，所以不建議使用這樣的格式，這使得人們更容易做出錯誤的假設。
         對日期進行 Decoding 時基本上是相同的選項，但是 .custom 形式是 .custom( (Decoder) throws -> Date )，所以我們給了一個解碼器並將任意類型轉換為日期格式。
         
         */
    }
    
    /// 浮點類型處理
    func jsonFunc8() {
        let jsonString: String = "{\"a\": \"NaN\",    \"b\": \"+Infinity\",    \"c\": \"-Infinity\" }"
        let jsonData = jsonString.data(using: String.Encoding.utf8)
        let decoder = JSONDecoder()
        
        decoder.nonConformingFloatDecodingStrategy =
            .convertFromString(
                positiveInfinity: "+Infinity",
                negativeInfinity: "-Infinity",
                nan: "NaN")
        
        let numbers = try! decoder.decode(Numbers.self, from: jsonData!)
        dump(numbers)
        
        /* 打印
         
         ▿ abcProject.Numbers
         - a: nan
         - b: inf
         - c: -inf
         
         */
    }
}

參考鏈接

Swift 4 JSON 解析指南

Swift 4 JSON 解析進階

JSONDecoder的使用

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 [Swift]Swift原生：JSON轉換Model Swift Json解析 SWIFT解析天氣JSON格式 Swift JSON字符串和字典以及數組的互轉 JSON轉Model內部實現解析 Swift 字典模型互轉總結 Knockout中ViewModel與Model的互轉 Swift 與 JSON 數據【JSON解析】JSON解析 MVC之Model轉Json