我正在尝试为一个对象采用 Codable
协议(protocol),该对象必须从我的 Web 服务返回的 JSON 实例化以响应其中一个 API 调用。
其中一个属性是enumeration类型,可选:nil
表示没有选择enum
定义的选项.
enum
常量是基于Int
的,从1
开始,不是 0
:
class MyClass: Codable {
enum Company: Int {
case toyota = 1
case ford
case gm
}
var company: Company?
这是因为相应的 JSON 条目上的值 0
是为“未设置”保留的;即,在设置从它初始化 company
属性时,它应该映射到 nil
。
Swift 的枚举初始化器 init?(rawValue:)
提供了这个开箱即用的功能:一个 Int
参数,它不匹配任何情况下的原始值将导致初始化失败并返回 nil。此外,只需在类型定义中声明它,即可使基于 Int
(和 String)的枚举符合 Codable
:
enum Company: Int, Codable {
case toyota = 1
case ford
case gm
}
问题 是,我的自定义类有超过 20 个属性,所以我真的很想避免必须实现 init(from:)
和 encode (to:)
,而是依赖于通过提供 CondingKeys
自定义枚举类型获得的自动行为。
这会导致整个类实例的初始化失败,因为“合成”初始化程序似乎无法推断出枚举类型的不受支持的原始值应被视为nil
(即使目标属性明确标记为可选,即Company?
)。
我认为这是因为 Decodable
提供的初始化器可以抛出,但不能返回 nil:
// This is what we have:
init(from decoder: Decoder) throws
// This is what I would want:
init?(from decoder: Decoder)
作为解决方法,我按如下方式实现了我的类:将 JSON 的整数属性映射到我的 private、stored Int
属性仅用作存储的类,并引入一个强类型的 computed 属性,该属性充当存储和我的应用程序其余部分之间的桥梁:
class MyClass {
// (enum definition skipped, see above)
private var companyRawValue: Int = 0
public var company: Company? {
set {
self.companyRawValue = newValue?.rawValue ?? 0
// (sets to 0 if passed nil)
}
get {
return Company(rawValue: companyRawValue)
// (returns nil if raw value is 0)
}
}
enum CodingKeys: String, CodingKey {
case companyRawValue = "company"
}
// etc...
我的问题是:是否有更好(更简单/更优雅)的方式,即:
- 是否不像我的解决方法一样需要重复的属性,并且
- 不是否需要完全实现
init(from:)
和/或encode(with:)
,或许实现这些的简化版本大部分委托(delegate)给默认行为(即不需要手动初始化/编码每个属性的整个样板)?
附录:还有第三种同样不优雅的解决方案,我在第一次发布问题时并没有想到。它涉及为了自动解码而使用人工基类。我不会使用它,只是为了完整起见在这里描述一下:
// Groups all straight-forward decodable properties
//
class BaseClass: Codable {
/*
(Properties go here)
*/
enum CodingKeys: String, CodingKey {
/*
(Coding keys for above properties go here)
*/
}
// (init(from decoder: Decoder) and encode(to:) are
// automatically provided by Swift)
}
// Actually used by the app
//
class MyClass: BaseClass {
enum CodingKeys: String, CodingKey {
case company
}
var company: Company? = nil
override init(from decoder: Decoder) throws {
super.init(from: decoder)
let values = try decoder.container(keyedBy: CodingKeys.self)
if let company = try? values.decode(Company.self, forKey: .company) {
self.company = company
}
}
}
...但这是一个非常丑陋的 hack。类继承层次结构不应由此类缺点决定。
最佳答案
如果我没有理解错的话,我认为我遇到了与您类似的问题。在我的例子中,我为每个有问题的枚举写了一个包装器:
struct NilOnFail<T>: Decodable where T: Decodable {
let value: T?
init(from decoder: Decoder) throws {
self.value = try? T(from: decoder) // Fail silently
}
// TODO: implement Encodable
}
然后像这样使用它:
class MyClass: Codable {
enum Company: Int {
case toyota = 1
case ford
case gm
}
var company: NilOnFail<Company>
...
当然,需要注意的是,无论您需要访问 company
的值,都需要使用 myClassInstance.company.value
关于Swift Codable - 如何以失败的方式初始化可选的枚举属性,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/53165279/