手动自定义编码键
在您的示例中,Codable
由于所有属性也都符合,因此您将获得自动生成的符合Codable
。这种一致性会自动创建一个仅与属性名称相对应的密钥类型,然后将其用于对单个密钥容器进行编码/解码。
但是,这种自动生成的一致性的一个真正巧妙的功能是,如果您enum
在称为“ CodingKeys
” 的类型中定义嵌套(或使用typealias
具有此名称的a)来符合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
所有属性都相同的类型也是如此Decodable
属于(1)的类型CodingKey
enum
CodingKeys
typealias
Encodable
Decodable
- 以及手动提供类型(名称直接或通过a )将其案例按名称一对一映射到/ 属性的类型 - 使用这些属性和键自动合成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_case
JSON键camelCase
在雨燕4.1,如果您重命名zip
属性zipCode
,你可以利用关键的编码/解码上的策略JSONEncoder
,并JSONDecoder
以自动转换之间的编码键camelCase
和snake_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
将使用键进行编码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密钥映射
在雨燕4.1,您可以利用自定义按键编码/解码上的策略JSONEncoder
和JSONDecoder
,使您可以提供一个自定义函数映射的编码键。
您提供的函数采用[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")
CodingKeys
枚举下;我可以只列出要更改的一个键吗?