Codable 的迁移方案

最近刚换工作,在迁移 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` 再抛出
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 也兼容 CodableT 也必须遵守 Codable 才行,但让 T 同时遵守 CodableMappable 会背离我们的初衷(虽然工作量不大)。

最理想的情况应该是如果 T 遵守 Codable 的话,那 BaseResponse 也能遵守 Codable。同样的,T 遵守 MappableBaseResponse 就遵守 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 关了,这个功能的实现可能还需要一段时间。

觉得文章还不错的话可以关注一下我的博客

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,551评论 4 58
  • 常常很多人认为评判别人是不好的,我怎么能评判他/她呢,干嘛用他人的无聊浪费我享受当下的美好时光呢! 感觉告诉我此刻...
    央金拉姆阅读 244评论 0 0
  • 人都会做错事,说错话,关键是要能及时意识到自己的错误,有些无法挽回的事情,我们就尽力去弥补,最重要的是要承...
    瑶小妹阅读 269评论 0 0
  • 读朋友写的《走进东岸:探访岭南古建筑》时,心突然颤抖了一下,首先是因为看到了以下照片: 作为一个从小跟着父母迁到广...
    某只维子阅读 478评论 0 4