Codable 的遷移方案

四娘發表於2019-03-04

最近剛換工作，在遷移 Swift 4.0，其實我感覺 Swift 3.0 的時候遷移工作更容易一點，因為所有庫都很積極地升級版本，而現在反而都在做 Swift 3.2 的相容方案，每個庫的相容狀況不同讓遷移工作變得更難。

但今天想說的是另一個問題，Codable 的遷移，我們專案裡是用了 Moya + ObjectMapper 的方案，使用 Swift 的話，大家使用的 JSON 解析方案應該都一樣，都是定義協議，模型遵守協議提供 JSON 解析的方法。

如果 JSON 格式標準，而且命名方式一致的話，把 Mappable 全域性替換成 Codable 就完成了 99% 的遷移工作了。但現實並不總是那麼理想，那就只能保留 Mappable，然後新的 Model 使用 Codable 來處理了，後面有空再來逐步替換。

理想的做法是不去動網路層的實現，通過修改解析 JSON 的函式的實現來達到相容。先來看看 Moya-ObjectMapper 的實現：

extension Response {

    func mapObject<T: BaseMappable>(_ type: T.Type, context: MapContext? = nil) throws -> T {
        guard let object = Mapper<T>(context: context).map(JSONObject: try mapJSON()) else {
            throw MoyaError.jsonMapping(self)
        }
        return object
    }

    func mapArray<T: BaseMappable>(_ type: T.Type, context: MapContext? = nil) throws -> [T] {
        guard let array = try mapJSON() as? [[String : Any]] else {
            throw MoyaError.jsonMapping(self)
        }
        return Mapper<T>(context: context).mapArray(JSONArray: array)
    }
}複製程式碼

加入 Codable 的相容其實也挺簡單的，過載這兩個方法就行了，而一般專案裡基本不怎麼使用 context，所以可以這麼定義：

// 這裡其實應該轉成 MoyaError 再 throw 的
extension Response {

    func mapObject<T>(_ type: T.Type, using decoder: JSONDecoder = .init()) throws -> T where T: Decodable {
        return try decoder.decode(T.self, from: data)
    }

    func mapArray<T>(_ type: T.Type, using decoder: JSONDecoder = .init()) throws -> [T] where T: Decodable {
        return try decoder.decode(Array<T>.self, from: data)
    }
}複製程式碼

但我們後端的介面一般會在資料的外部再封裝一層，外部存放一些 status 或者 count 的資訊，於是我們就寫了一個 BaseResponse 建模：

struct BaseResponse<T: Mappable>: Mappable {

    var statusCode: Int
    var message: String
    var totalCount: Int
    var result: T?

    required init?(map: Map) { }

    func mapping(map: Map) {
        statusCode <- map["statusCode"]
        message    <- map["message"]
        totalCount <- map["totalCount"]
        result     <- map["result"]
    }
}複製程式碼

如果想要相容 Codable，那必然要讓 BaseResponse 也相容 Codable，T 也必須遵守 Codable 才行，但讓 T 同時遵守 Codable 和 Mappable 會背離我們的初衷（雖然工作量不大）。

最理想的情況應該是如果 T 遵守 Codable 的話，那 BaseResponse 也能遵守 Codable。同樣的，T 遵守 Mappable，BaseResponse 就遵守 Mappable：

struct BaseResponse<T> {

    var statusCode: Int
    var message: String
    var totalCount: Int
    var data: T?
}

extension BaseResponse: Mappable where T: Mappable {

    required init?(map: Map) { }

    func mapping(map: Map) {
        statusCode <- map["statusCode"]
        message    <- map["message"]
        totalCount <- map["totalCount"]
        data       <- map["data"]
    }
}

extension BaseResponse: Codable where T: Codable {}複製程式碼

這樣的功能叫做 Conditional Conformance，直譯過來是“有條件地遵守”，也就是說只要滿足了某個條件，就可以遵守協議。這個功能還有各種各樣的用法，例如 Array 裡的元素是 Equtable 的話，那 Array 也會遵守 Equtable，好好利用的話可以去掉很多抽象意義上相同的程式碼，Twitter 上甚至有人說使用這個功能就能將他專案裡的程式碼減少 20%。

但目前這個功能暫時還沒有在 Swift 4.0 裡實現，但前兩天已經將對應的 Pull Request 合併到了主分支裡了，很有可能在下個版本 Swift 4.1 裡我們就能使用了✌️。

Note：

其實這種寫法還有另一個障礙，由於某些實現的原因，目前 Codable 在 extension 裡宣告的話，是沒辦法自動生成解析程式碼的，不過也可以手動實現。Swift 團隊已經開了一個 Pull Request 去實現這個功能了，但由於暫時沒有好的實現方式，所以把 PR 關了，這個功能的實現可能還需要一段時間。

覺得文章還不錯的話可以關注一下我的部落格

相關文章