为什么我必须添加样板才能使 Codable 工作，即使我只有一个需要自定义的元素？

编程问答 2022-05-28

问题描述

我在 Swift 中使用 Codable，对于超级简单的模型，我不必实现任何自定义解码代码，这很酷。像这样的东西“正常工作”：

struct Foo: Decodable {
  let id: String
  let name: String
  let number: Double
}

但是，一旦发生不完美的事情，我需要实现整个 CodingKeys 结构以及 init(from decoder:)。

例如，API 突然发回一个字符串作为 number，我想将其表示为 Double，这需要我添加所有这些样板。

// boilerplate CodingKeys
enum CodingKeys: String,CodingKey {
  case id,name,number
}

init(from decoder: Decoder) throws {
  // default boilerplate values
  let values = try decoder.container(keyedBy: CodingKeys.self)
  id = try values.decode(String.self,forKey: .id)
  name = try values.decode(String.self,forKey: .name)
  
  // Custom values
  let numberString = try values.decode(String.self,forKey: .number)
  number = Double(numberString) ?? 0
}

这很烦人，原因如下：

  1. 一个自定义项目让我添加所有这些额外的代码
  2. 我无法一眼看出哪些项目实际上是“自定义”的，哪些只是样板文件（当然，除非我以这种方式组织代码）

我只是不明白为什么它是这样构建的。是否存在需要使用此样板的技术限制？

当然，有没有办法避免这些样板文件？我看到的一个解决方案是创建一个不同的变量，如 numberDouble 可以使用字符串编号，但这会使命名有点混乱。

解决方法

您可以使用计算属性来解决您的问题。

只需创建一个“假”变量来保存您的字符串并使用自定义 CodingKey 对其进行解码。然后使用将“假”变量转换为 Double 的计算属性。

还有一些额外的代码行，但没有编写自定义解码器那么复杂。

struct Foo: Decodable {
    let id: String
    let name: String
    private let numberString: String
    
    enum CodingKeys: String,CodingKey {
        case id
        case name
        case numberString = "number"
    }
    
    var number: Double {
        Double(numberString) ?? 0
    }
    
}

let json = """
{
  "id":"1","name":"Mike","number":"12"
}

""".data(using: .utf8)!

let decoder = JSONDecoder()
let result = try! decoder.decode(Foo.self,from: json)
print(result.number)
codablecodabledecodableiosiosswiftswiftswiftswift