使用 Swift 4 的 Codable 进行类型转换

Question

我正在 Swift 4 中使用新的Codable协议。我正在通过URLSession从 Web API 中提取 JSON 数据。下面是一些示例数据：

{
"image_id": 1,
"resolutions": ["1920x1200", "1920x1080"]
}

我想将其解码为这样的结构：

struct Resolution: Codable {
let x: Int
let y: Int
}
struct Image: Codable {
let image_id: Int
let resolutions: Array<Resolution>
}

但我不确定如何将原始数据中的分辨率字符串转换为Resolution结构中的单独Int属性。我已经阅读了官方文档和一两个很好的教程，但这些教程侧重于可以直接解码数据的情况，而无需任何中间处理(而我需要在x处拆分字符串，将结果转换为Ints 并将它们分配给Resolution.x和.y(。这个问题似乎也很相关，但提问者希望避免手动解码，而我对这种策略持开放态度(尽管我自己不确定如何去做(。

我的解码步骤如下所示：

let image = try JSONDecoder().decode(Image.self, from data)

data由URLSession.shared.dataTask(with: URL, completionHandler: Data?, URLResponse?, Error?) -> Void)提供的地方

Answer 1

对于每个Resolution，您希望解码单个字符串，然后将其解析为两个Int组件。要解码单个值，您需要从init(from:)实现中的decoder获取singleValueContainer()，然后对其调用.decode(String.self)。

然后，您可以使用components(separatedBy:)来获取组件，然后Int的字符串初始化器将它们转换为整数，如果遇到格式不正确的字符串，则会抛出DecodingError.dataCorruptedError。

编码更简单，因为您只需使用字符串插值即可将字符串编码为单个值容器。

例如：

import Foundation
struct Resolution {
let width: Int
let height: Int
}
extension Resolution : Codable {
init(from decoder: Decoder) throws {
let container = try decoder.singleValueContainer()
let resolutionString = try container.decode(String.self)
let resolutionComponents = resolutionString.components(separatedBy: "x")
guard resolutionComponents.count == 2,
let width = Int(resolutionComponents[0]),
let height = Int(resolutionComponents[1])
else {
throw DecodingError.dataCorruptedError(in: container, debugDescription:
"""
Incorrectly formatted resolution string "(resolutionString)". 
It must be in the form <width>x<height>, where width and height are 
representable as Ints
"""
)
}
self.width = width
self.height = height
}
func encode(to encoder: Encoder) throws {
var container = encoder.singleValueContainer()
try container.encode("(width)x(height)")
}
}

然后，您可以像这样使用它：

struct Image : Codable {
let imageID: Int
let resolutions: [Resolution]
private enum CodingKeys : String, CodingKey {
case imageID = "image_id", resolutions
}
}
let jsonData = """
{
"image_id": 1,
"resolutions": ["1920x1200", "1920x1080"]
}
""".data(using: .utf8)!
do {
let image = try JSONDecoder().decode(Image.self, from: jsonData)
print(image)
} catch {
print(error)
}
// Image(imageID: 1, resolutions: [
//                                  Resolution(width: 1920, height: 1200),
//                                  Resolution(width: 1920, height: 1080)
//                                ]
// )

请注意，我们在Image中定义了一个自定义嵌套CodingKeys类型，因此我们可以为imageID提供一个 camelCase 属性名称，但指定 JSON 对象键为image_id。