我第一次使用Swift 4的Codable
协议,我无法理解来自decodeIfPresent
的{{1}}的使用情况。
Decodable
如果值与关联键不存在,则建议返回/// Decodes a value of the given type for the given key, if present.
///
/// This method returns `nil` if the container does not have a value associated with `key`, or if the value is null. The difference between these states can be distinguished with a `contains(_:)` call.
///
/// - parameter type: The type of value to decode.
/// - parameter key: The key that the decoded value is associated with.
/// - returns: A decoded value of the requested type, or `nil` if the `Decoder` does not have an entry associated with the given key, or if the value is a null value.
/// - throws: `DecodingError.typeMismatch` if the encountered encoded value is not convertible to the requested type.
public func decodeIfPresent(_ type: String.Type, forKey key: KeyedDecodingContainer.Key) throws -> String?
。如果这是唯一的原因,那么它与可选属性的区别如何,因为如果响应中不存在值,则可选变量也会设置为nil
。
答案 0 :(得分:51)
这两行代码之间有一个微妙但重要的区别:
// Exhibit 1
foo = try container.decode(Int?.self, forKey: .foo)
// Exhibit 2
foo = try container.decodeIfPresent(Int.self, forKey: .foo)
图表1将解析:
{
"foo": null,
"bar": "something"
}
但不:
{
"bar": "something"
}
而展览2将愉快地解析两者。因此,在JSON
解析器的正常使用情况下,您需要decodeIfPresent
模型中的每个可选项。
答案 1 :(得分:5)
是的,@ Sweeper的评论是有道理的。
我会根据我的理解尝试解释它。
public class User : Decodable{
public var firstName:String
public var lastName:String
public var middleName:String?
public var address:String
public var contactNumber:String
public enum UserResponseKeys: String, CodingKey{
case firstName = "first_name"
case lastName = "last_name"
case middleName = "middle_name"
case address = "address"
case contactNumber = "contact_number"
}
public required init(from decoder: Decoder) throws {
let container = try decoder.container(keyedBy: UserResponseKeys.self)
self.firstName = try container.decode(String.self, forKey: .firstName)
self.lastName = try container.decode(String.self, forKey: .lastName)
self.middleName = try container.decodeIfPresent(String.self, forKey: .middleName)
self.address = try container.decode(String.self, forKey: .address)
self.contactNumber = try container.decode(String.self, forKey: .contactNumber)
}
}
上面是我的User
类,其中我将middleName
标记为可选参数,因为JSON响应可能无法提供middleName
键值对作为响应,因此我们可以使用decodeIfPresent
。
self.middleName = try container.decodeIfPresent(String.self, forKey: .middleName)
对于其他必需字段的变量,我们确信不需要使用可选字段。我们仅使用decode
,因为该方法不返回可选项。
public func decode(_ type: String.Type, forKey key: KeyedDecodingContainer.Key) throws -> String
以上decode
函数返回String
,而decodeIfPresent
返回String?
,因此我们可以使用可选变量来存储它。
所以最后的结论是,如果您不确定服务响应合同,或者您可能在不知情的情况下处理JSON响应和参数可能发生变化的任何第三方服务,那么您可以使用decodeIfPresent
所以它可以处理响应中缺少特定参数并将值设置为nil
。
答案 2 :(得分:1)
如果您要为JSON中可能缺少的属性使用默认值,我认为使用decodeifPresent
而不是可选属性是很有意义的。
例如,让我们研究3种情况:
1。所有键都存在于JSON中:
假设您必须解码此JSON:
{
"project_names": ["project1", "project2", "project3"],
"is_pro": true
}
您可以使用以下结构:
struct Program: Codable {
let projectNames: [String]
let isPro: Bool
}
,您将获得一个Program
值等于isPro
的{{1}}对象。
(我假设您的解码器true
在本示例的其余部分中是keyDecodingStrategy
)
2。 JSON中缺少某些键,并且可以在Swift中使用可选键:
.convertFromSnakeCase
您现在可以使用此结构:
{
"project_names": ["project1", "project2", "project3"]
}
,您将获得一个struct Program: Codable {
let projectNames: [String]
var isPro: Bool?
}
值等于Program
的{{1}}对象。
如果JSON如下所示:
isPro
然后nil
将是值为{
"project_names": ["project1", "project2", "project3"],
"is_pro": true
}
的{{1}}。
也许这就是您想要的,但是您可能想拥有一个默认值为isPro
的{{1}}。这就是Bool?
有用的地方。
3。 JSON中缺少某些键,因此您需要一个非可选属性,在Swift中具有默认值:
如果您的结构看起来像这样:
true
然后,如果JSON中不存在“ is_pro”属性,则会出现解析错误。 因为Codable期望找到一个值来解析Bool属性。
在这种情况下,一个好主意是使用Bool
进行初始化,就像这样:
false
这可以让您同时拥有两个方面的优势:
decodeIfPresent
,而不是struct Program: Codable {
let projectNames: [String]
var isPro: Bool = false
}
属性decodeIfPresent
。