使用 Swift 4 JSONDecoder.DataDecodingStrategy.custom(_:) 自定义 JSON 数据解码

Question

我正在寻找 JSON 自定义策略数据解码的示例：

JSONDecoder.DataDecodingStrategy.custom(_:)

有人有相关示例或链接吗？苹果文档并没有解释太多。

非常感谢！

弗朗西斯科

Answer 1

这是自定义数据编码和解码策略的更全面的示例。让我们从一个非常简单的数据模型开始：

struct Model: Codable {
    var data: Data
}

编码

Data在 Swift 中被编码成 JSON 中的字符串。默认编码使用 Base64，因此如果您分配data给组成字符串“Hello world”的字节，您将获得以下数据：

let m = Model(data: "Hello world".data(using: .utf8)!)
let json = try JSONEncoder().encode(m)
let jsonString = String(data: json, encoding: .utf8)!

print(jsonString) // {"data":"SGVsbG8gd29ybGQ="}

但假设您想使用十六进制代码而不是 Base64。您可以编写自定义数据编码函数：

func customDataEncoder(data: Data, encoder: Encoder) throws {
    let str = (0..<data.count).map {
        String(data[$0], radix: 16, uppercase: true)
    }.joined(separator: " ")

    var container = encoder.singleValueContainer()
    try container.encode(str)
}

let encoder = JSONEncoder()
encoder.dataEncodingStrategy = .custom(customDataEncoder)

let m = Model(data: "Hello world".data(using: .utf8)!)
let json = try JSONEncoder().encode(m)
let jsonString = String(data: json, encoding: .utf8)!

print(jsonString) // {"data":"48 65 6C 6C 6F 20 77 6F 72 6C 64"}

解码

解码是在 Swift 中将 JSON 字符串转换为 JSON 字符串的过程Data。如果字符串是 Base64 编码的，则无需执行任何其他操作。但由于我们以Data十六进制编码，因此您需要提供自定义数据解码器：

func customDataDecoder(decoder: Decoder) throws -> Data {
    let container = try decoder.singleValueContainer()
    let str = try container.decode(String.self)

    let bytes = str.components(separatedBy: " ").map {
        UInt8($0, radix: 16)!
    }
    return Data(bytes)
}

let decoder = JSONDecoder()
decoder.dataDecodingStrategy = .custom(customDataDecoder)

let decodedM = try decoder.decode(Model.self, from: json)
print(m.data == decodedM.data) // true

注意：当我说“Data在 Swift 中被编码为 JSON 中的字符串”时，大多数情况下都是如此，但不必每次都如此。没有什么可以阻止您将属性编码data为如下内容：

{
    "data": {
        "count": 11,
        "string": "Hello world",
        "hex": "48 65 6C 6C 6F 20 77 6F 72 6C 64"
    }
}

当然，您必须更新自定义解码器以匹配 JSON 格式。