Swift5 不要编码来自第三方的类型

通常我们都用Codable处理App中和model这类概念有关的类型。如果这个类型的属性都兼容Codable,用起来就不会有什么问题。但情况并不总是如此,如果model使用了一些不属于我们自己的类型,这时的编码和解码过程就需要额外注意了。

为了演示这种场景,我们可以用SPM创建两个modules:LibsSPM

let package = Package(
  name: "SPM",
  dependencies: [
  ],
  targets: [
    .target(
      name: "Libs",
      dependencies: []
    ),
    .target(
      name: "SPM",
      dependencies: ["Libs"]),
    .testTarget(
      name: "SPMTests",
      dependencies: ["SPM"]),
  ]
)

然后,在Libs中创建一个lib.swift,并在其中添加下面的代码:

import Darwin.C

public struct Point {
  public var x: Double
  public var y: Double

  public init(x: Double, y: Double) {
    self.x = x
    self.y = y
  }
}

现在,假设这个Point就是个来自第三方的类型,我们无法直接修改它的代码。然后,在main.swift里,定义一个使用了Point的类型User

struct User {
  var name: String
  var pos: Point

  init(name: String, pos: Point) {
    self.name = name
    self.pos = pos
  }
}

接下来,如果我们希望让User支持Codable该怎么办呢?如果直接通过extension完成这件事,编译器会阻止你这么干:

extension User: Codable {}

因为User中的Point并不支持Codable,那如果在main.swift里,也通过extensionPoint也遵从Codable呢?答案是,编译器也会阻止你这么干:

extension Point: Codable {}

image

就像图中说的那样,尽管Point的两个属性都支持Codable,但编译器只能在定义Point的文件里,通过extension自动合成Codable方法。

那该怎么办呢?一个最直接的想法就是自己动手写呗。但这时,先来回答一个问题:究竟应该手工实现Point还是UserCodable支持呢?

尽管两种方法事实上都可行。但作为一条最佳实践,最好避免给不属于自己的类型添加Codable支持。因为我们无法预知这个类型的原始作者是否会在未来让它支持Codable,也无法确定这个类型官方的Codable方案会和我们使用的相同。在升级依赖库的时候,这些问题对已有的codebase都是潜在的破坏性风险。因此,我们应该直接手工实现UserCodable支持。

接下来,编码User的时候,也有两种不同的方案。一种是“扁平化编码”:

extension User: Codable {
  private enum CodingKeys: String, CodingKey {
    case name
    case x
    case y
  }

  func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    try container.encode(name, forKey: .name)
    try container.encode(pos.x, forKey: .x)
    try container.encode(pos.y, forKey: .y)
  }

  init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    self.name = try container.decode(String.self, forKey: .name)
    self.pos = Point(
      x: try container.decode(Double.self, forKey: .x),
      y: try container.decode(Double.self, forKey: .y)
    )
  }
}

这样一来,编码的结果里,就会隐藏掉Point的存在,变成类似{"name":"11","x":11,"y":10}的形式。

或者,也可以用嵌套容器的方式,把Point编码进来:

extension User: Codable {
  private enum CodingKeys: CodingKey {
    case name
    case pos
  }

  private enum PosCodingKeys: CodingKey {
    case x
    case y
  }

  func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    try container.encode(name, forKey: .name)

    var posContainer = container.nestedContainer(
      keyedBy: PosCodingKeys.self, forKey: .pos)
    try posContainer.encode(pos.x, forKey: .x)
    try posContainer.encode(pos.y, forKey: .y)
  }

  init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    self.name = try container.decode(String.self, forKey: .name)

    let posContainer = try container.nestedContainer(
      keyedBy: PosCodingKeys.self, forKey: .pos)
    self.pos = Point(
      x: try posContainer.decode(Double.self, forKey: .x),
      y: try posContainer.decode(Double.self, forKey: .y)
    )
  }
}

这样,User对象的编码结果就会变成类似{"name":"11","pos":{"x":11,"y":10}}的形式。虽然问题是解决了,但是回头看看为了支持Codable,我们写的代码可着实不少。更重要的是,这些代码其实没什么“营养”。类的属性少还好,多了之后,这样一个个的去编码和解码的确很麻烦。于是,这样的话就有点儿尴尬了。既不能直接给Point扩展Codable,扩展User又太麻烦,还能怎么办呢?

一个思路就是,给Point单独创建一个支持Codable的包装类。并把这个包装类放到User里,这样编译器就可以自动给User合成Codable了。

首先,仿照着Point里我们需要的属性,创建一个包装类:

struct User: Codable {
  private struct _Point: Codable {
    var x: Double
    var y: Double
  }
}

其次,给User添加一个_Point属性,并修改对应的init方法:

struct User: Codable {
  var name: String
  private var _point: _Point
  var pos: Point

  init(name: String, pos: Point) {
    self.name = name
    self._point = _Point(x: pos.x, y: pos.y)
    self.pos = pos
  }
}

第三,接管pos属性的赋值和读取,读取的时候,用_point属性生成一个新的Point对象;赋值的时候,把Point的值保存回_point。这样就实现了编码数据的时候,使用内部类型_Point,访问API的时候,仍旧使用Point的效果:

struct User: Codable {
  var pos: Point {
    get {
      return Point(x: _point.x, y: _point.y)
    }
    set {
      _point = _Point(x: newValue.x, y: newValue.y)
    }
  }
}

第四,定义编码User时使用的CodingKey,让它使用_point的值,以及pos的名字作为key:

private enum CodingKeys: String, CodingKey {
  case name
  case _point = "pos"
}

这样,Swift就可以自动为User生成Codable方法了。最终,User的定义是这样的:

struct User: Codable {
  var name: String

  private var _point: _Point
  var pos: Point {
    get {
      return Point(x: _point.x, y: _point.y)
    }
    set {
      _point = _Point(x: newValue.x, y: newValue.y)
    }
  }

  private enum CodingKeys: String, CodingKey {
    case name
    case _point = "pos"
  }

  init(name: String, pos: Point) {
    self.name = name
    self._point = _Point(x: pos.x, y: pos.y)
    self.pos = pos
  }

  private struct _Point: Codable {
    var x: Double
    var y: Double
  }
}

但相比之前手工实现Codable的方式,代码量明显要少一些。

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

推荐阅读更多精彩内容