使用OptionSet优化Codable的enmu解析

在swift 4.0之后,官方提供了Codable来解析json为对应的Model,这比一些第三方框架简单优雅了许多,并且由于它是官方的,稳定性也有了很好的保障。

具体如何使用Codable来映射解析json并不是本文的重点,相信大家也都知道如何使用,本文主要讨论在解析枚举数据的时候遇到的问题,特别是可变枚举的情况。

常规enum

对于后端接口数据中有一些确定值范围的字段,比如性别这种,我们会使用枚举来解析这个字段。假如我们有如下这样的一个json数据,下文增加修改字段都是在该json的基础上进行的:

 {
     "name": "rocky",
     "sex": "male"
 }

我们和后端约定sex字段只能传递字符串malefemale(当然,为了减少数据量,也会使用Int类型来表示对应的值),因此我们可以很容易的写出来对应的Person模型:

struct Person: Codable {
    let name: String
    let sex: Sex

    enum Sex: String, Codable {
        case male
        case female
    }
}

借助于JSONDecoder我们可以将json转化为对应的Person:

let person_json_data = JSONSerialization.data(withJSONObject: person_json, options: [.fragmentsAllowed])
let person = JSONDecoder().decode(Person.self, from: person_json_data)

但是在这个过程中,如果后端增加了一个sex字段的值:unknown,而且我们解析json的代码已经发版上线了,只要后端修改过后的接口一上线,就会解析失败。

除了后端对该值做版本控制之外,我们别无他法,虽然版本控制修补丁还可以,如果涉及到大面积的字段有变动,那就会割裂后端同学的代码逻辑。

如果一开始不使用枚举,而是直接使用String、Int来保存数据就不会有这样的问题了,既然我们这里讨论的是Codable下对enum的解析,那么这种case就不用考虑了。

使用OptionSet

上面的情况一般的发生主要在于业务变动,业务变动是无法预期的,但是我们可以使用OptionSet来提前预防这种情况。

OptionSet一般用来可以组合的枚举,通过操作来达到对枚举的组合,比如UIKit中设置圆角的UIRectCorner就是他的一个应用:

struct UIRectCorner : OptionSet {
    
    static var topLeft: UIRectCorner { get }
    static var topRight: UIRectCorner { get }
    static var bottomLeft: UIRectCorner { get }
    static var bottomRight: UIRectCorner { get }
    static var allCorners: UIRectCorner { get }
}

虽然看起来不是枚举,但是却可以达到枚举的效果,我们可以使用OptionSet来实现一个具有兼容性的枚举。

假如现在json中新增一个level的字段,这个字段我们使用Int类存储:

{
   ...
   "level": 2,
   ...
}

对应的,Person中也需要新增一个Level的struct来解析这个字段:

struct Person: Codable {
    
   ...

   let level: Level

   struct Level: Codable, OptionSet {

       typealias RawValue = Int
       var rawValue: Int
       init(rawValue: Int) {
           self.rawValue = rawValue
       }

       static let low = Level(rawValue: 1 << 0) // 1

       static let middle = Level(rawValue: 2 << 0) // 2

       static let high = Level(rawValue: 3 << 0) // 3
   }
}

这个时候,通过JSONDecoder我们解析得到的level为middle

如果接口中新增了level相关的字段,比如:higher,值为4,使用以前的代码解析出来的level.rawValue就为4,而不是已经设置好的静态对象,最主要的是不会解析失败。

使用OptionSet之后,依然可以使用if-else、switch来判断具体的case,以switch为例:

 switch person.level {
    case .low:
        print("level low \(person.level.rawValue)")
    case .middle:
        print("level middle \(person.level.rawValue)")
    case .high:
        print("level high \(person.level.rawValue)")
    default:
        print("level unknow \(person.level.rawValue)")
}

既兼顾了enum的特性又具备了可拓展的特点。

问题

虽然使用OptionSet之后我们的数据解析代码逻辑更健壮了,同时也会带来一些问题。

首先就是代码量增加了很多。针对这一点,我认为是值得的。特别是业务变动频繁带来的线上hot-fix等高成本的操作,多写这一部分代码显得没有那么重,另外可以在业务稳定之后,将struct替换为enum即可,几乎是无缝切换。

另外一个问题就是switch-case这样的判断逻辑上。我们知道enum中如果每个case都进行了区分,再新增一个case,编译器就会直接报错,提示我们有新增的case,记得在switch中进行区分。

而使用OptionSet之后,新增一个case,编译器并不会为我们进行提示,这就需要我们按照业务来主动添加了,这也无可厚非,毕竟有新业务变动了,肯定是要涉及到的地方都要修改了。

使用OptionSet实现enum的逻辑所带来的问题目前看来都是可以接受的,OptionSet也只是一种用于预防Codable解析失败的方式,具体业务中最好还是使用enum来实现枚举功能。

当然,如果业务变动很频繁,还是推荐使用OptionSet来提升代码的健壮性的。

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

推荐阅读更多精彩内容