自定义Decodable属性包装器自动合成缺键解码报错问题求解
问题根源
Swift 编译器在为遵循Decodable的结构体自动合成解码逻辑时,会直接将属性包装器的实际存储类型作为解码目标处理:
- 对于你定义的
@OptionalDecodable var string: String?,实际在结构体中存储的成员类型是非可选的OptionalDecodable<String>,而不是可选类型 - 按照编译器合成规则,非可选的存储属性会调用
KeyedDecodingContainer的通用decode(_:forKey:)方法,该方法在JSON不存在对应键时会直接抛出keyNotFound解码错误 - 整个抛错流程发生在容器层,根本不会进入你定义的
OptionalDecodable的初始化逻辑,因此仅在包装器内部实现容错解码是不够的。
解决方案
通过两层适配实现无需手写Model解码逻辑的容错能力:
- 为
OptionalDecodable补充通用初始化入口,内部实现值解码的容错处理 - 为
KeyedDecodingContainer增加针对OptionalDecodable类型的专用解码重载,替换默认的抛错逻辑
完整实现代码如下:
@propertyWrapper struct OptionalDecodable<Value: Decodable>: Decodable { // 对外暴露的可选包装值 var wrappedValue: Value? // 提供不带解码上下文的初始化方法,用于键缺失时创建默认实例 init(wrappedValue: Value?) { self.wrappedValue = wrappedValue } // 自定义解码逻辑:值缺失、类型不匹配时统一返回nil,不向上抛错 init(from decoder: Decoder) throws { let container = try decoder.singleValueContainer() wrappedValue = try? container.decode(Value.self) } } // 为解码容器增加专用的解码重载,匹配OptionalDecodable类型 extension KeyedDecodingContainer { func decode<Value: Decodable>(_ type: OptionalDecodable<Value>.Type, forKey key: Key) throws -> OptionalDecodable<Value> { // 用decodeIfPresent替代默认的decode逻辑,键不存在时返回默认空包装器 try decodeIfPresent(type, forKey: key) ?? OptionalDecodable(wrappedValue: nil) } }
效果验证
使用上述实现后,你原有的Model结构体不需要手写任何额外解码代码,直接解码空JSON"{}"时:
- 不会抛出键不存在的错误
string属性会自动解析为nil- 就算JSON中存在对应键,但值为
null、或类型不匹配,也不会中断解码流程,自动将属性值设为nil
内容的提问来源于stack exchange,提问作者Ihar
相关产品推荐
相关产品推荐

