手动自定义编码键
在您的示例中，您将获得自动生成的符合性，Codable因为您的所有属性也符合Codable. 这种一致性会自动创建一个与属性名称相对应的键类型——然后使用它来对单个键容器进行编码/解码。
然而，这种自动生成的一致性的一个非常巧妙的特性是，如果你enum在你的类型中定义一个嵌套的名为 " CodingKeys" （或使用typealias这个名称），它符合CodingKey协议——Swift 将自动使用它作为键类型。因此，这允许您轻松自定义您的属性编码/解码的密钥。
所以这意味着你可以说：
struct Address : Codable {
var street: String
var zip: String
var city: String
var state: String
private enum CodingKeys : String, CodingKey {
case street, zip = "zip_code", city, state
}
}
枚举案例名称需要与属性名称匹配，并且这些案例的原始值需要与您编码/解码的键匹配（除非另有说明，否则String枚举的原始值将与案例名称相同）。因此，该zip属性现在将使用 key 进行编码/解码"zip_code"。
进化提案（强调我的）详细说明了自动生成Encodable/一致性的确切规则：Decodable
除了 的自动CodingKey需求合成
之外enums，还可以为某些类型自动合成Encodable&Decodable需求：
符合Encodable其属性的类型都Encodable获得一个自动生成的String支持CodingKey枚举，将属性映射到案例名称。类似地，对于Decodable属性为 all 的类型Decodable
属于 (1)的类型 - 以及手动提供 a CodingKey enum（命名CodingKeys、直接或通过 a typealias）的类型，其情况按名称一对一映射到Encodable/Decodable属性-使用这些属性和键获得自动合成init(from:)并酌情encode(to:)
如果需要，既不属于 (1) 也不属于 (2) 的类型必须提供自定义键类型，并酌情提供它们自己的init(from:)和
encode(to:)
示例编码：
import Foundation
let address = Address(street: "Apple Bay Street", zip: "94608",
city: "Emeryville", state: "California")
do {
let encoded = try JSONEncoder().encode(address)
print(String(decoding: encoded, as: UTF8.self))
} catch {
print(error)
}
//{"state":"California","street":"Apple Bay Street","zip_code":"94608","city":"Emeryville"}
示例解码：
// using the """ multi-line string literal here, as introduced in SE-0168,
// to avoid escaping the quotation marks
let jsonString = """
{"state":"California","street":"Apple Bay Street","zip_code":"94608","city":"Emeryville"}
"""
do {
let decoded = try JSONDecoder().decode(Address.self, from: Data(jsonString.utf8))
print(decoded)
} catch {
print(error)
}
// Address(street: "Apple Bay Street", zip: "94608",
// city: "Emeryville", state: "California")
属性名称的自动snake_caseJSON 键camelCase
在 Swift 4.1 中，如果将zip属性重命名为zipCode，则可以利用 和 上的键编码/解码策略，以便在 和 之间自动转换JSONEncoder编码键。JSONDecodercamelCasesnake_case
示例编码：
import Foundation
struct Address : Codable {
var street: String
var zipCode: String
var city: String
var state: String
}
let address = Address(street: "Apple Bay Street", zipCode: "94608",
city: "Emeryville", state: "California")
do {
let encoder = JSONEncoder()
encoder.keyEncodingStrategy = .convertToSnakeCase
let encoded = try encoder.encode(address)
print(String(decoding: encoded, as: UTF8.self))
} catch {
print(error)
}
//{"state":"California","street":"Apple Bay Street","zip_code":"94608","city":"Emeryville"}
示例解码：
let jsonString = """
{"state":"California","street":"Apple Bay Street","zip_code":"94608","city":"Emeryville"}
"""
do {
let decoder = JSONDecoder()
decoder.keyDecodingStrategy = .convertFromSnakeCase
let decoded = try decoder.decode(Address.self, from: Data(jsonString.utf8))
print(decoded)
} catch {
print(error)
}
// Address(street: "Apple Bay Street", zipCode: "94608",
// city: "Emeryville", state: "California")
然而，关于此策略需要注意的一件重要事情是，它无法使用首字母缩略词或首字母缩写来往返某些属性名称，根据Swift API 设计指南，这些属性名称应统一为大写或小写（取决于位置）。
例如，一个名为的属性someURL将使用 key 进行编码some_url，但在解码时，它将转换为someUrl。
要解决此问题，您必须手动将该属性的编码键指定为解码器期望的字符串，例如someUrl在这种情况下（仍将some_url由编码器转换为）：
struct S : Codable {
private enum CodingKeys : String, CodingKey {
case someURL = "someUrl", someOtherProperty
}
var someURL: String
var someOtherProperty: String
}
（这并没有严格回答您的具体问题，但鉴于此问答的规范性质，我觉得值得包括在内）
自定义自动 JSON 键映射
在 Swift 4.1 中，您可以利用 和 上的自定义键编码/解码策略JSONEncoder，JSONDecoder允许您提供自定义函数来映射编码键。
您提供的函数采用 a [CodingKey]，它表示编码/解码中当前点的编码路径（在大多数情况下，您只需要考虑最后一个元素；即当前键）。该函数返回一个CodingKey将替换此数组中的最后一个键的值。
例如，属性名称UpperCamelCase的 JSON 键：lowerCamelCase
import Foundation
// wrapper to allow us to substitute our mapped string keys.
struct AnyCodingKey : CodingKey {
var stringValue: String
var intValue: Int?
init(_ base: CodingKey) {
self.init(stringValue: base.stringValue, intValue: base.intValue)
}
init(stringValue: String) {
self.stringValue = stringValue
}
init(intValue: Int) {
self.stringValue = "\(intValue)"
self.intValue = intValue
}
init(stringValue: String, intValue: Int?) {
self.stringValue = stringValue
self.intValue = intValue
}
}
extension JSONEncoder.KeyEncodingStrategy {
static var convertToUpperCamelCase: JSONEncoder.KeyEncodingStrategy {
return .custom { codingKeys in
var key = AnyCodingKey(codingKeys.last!)
// uppercase first letter
if let firstChar = key.stringValue.first {
let i = key.stringValue.startIndex
key.stringValue.replaceSubrange(
i ... i, with: String(firstChar).uppercased()
)
}
return key
}
}
}
extension JSONDecoder.KeyDecodingStrategy {
static var convertFromUpperCamelCase: JSONDecoder.KeyDecodingStrategy {
return .custom { codingKeys in
var key = AnyCodingKey(codingKeys.last!)
// lowercase first letter
if let firstChar = key.stringValue.first {
let i = key.stringValue.startIndex
key.stringValue.replaceSubrange(
i ... i, with: String(firstChar).lowercased()
)
}
return key
}
}
}
您现在可以使用.convertToUpperCamelCase关键策略进行编码：
let address = Address(street: "Apple Bay Street", zipCode: "94608",
city: "Emeryville", state: "California")
do {
let encoder = JSONEncoder()
encoder.keyEncodingStrategy = .convertToUpperCamelCase
let encoded = try encoder.encode(address)
print(String(decoding: encoded, as: UTF8.self))
} catch {
print(error)
}
//{"Street":"Apple Bay Street","City":"Emeryville","State":"California","ZipCode":"94608"}
.convertFromUpperCamelCase并使用关键策略进行解码：
let jsonString = """
{"Street":"Apple Bay Street","City":"Emeryville","State":"California","ZipCode":"94608"}
"""
do {
let decoder = JSONDecoder()
decoder.keyDecodingStrategy = .convertFromUpperCamelCase
let decoded = try decoder.decode(Address.self, from: Data(jsonString.utf8))
print(decoded)
} catch {
print(error)
}
// Address(street: "Apple Bay Street", zipCode: "94608",
// city: "Emeryville", state: "California")