使用 Decodable 进行 JSON 解析时 optional 和 decodeIfPresent 有啥区别？

Posted 2023-02-15

【中文标题】使用 Decodable 进行 JSON 解析时 optional 和 decodeIfPresent 有啥区别？

【英文标题】：What is difference between optional and decodeIfPresent when using Decodable for JSON Parsing?使用 Decodable 进行 JSON 解析时 optional 和 decodeIfPresent 有什么区别？

【发布时间】：2018-02-27 18:14:25

【问题描述】：

我第一次使用来自 Swift 4 的Codable 协议，我无法理解来自Decodable 的decodeIfPresent 的使用。

/// 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，如果关联键不存在值。如果这是唯一的原因，那么它与可选属性有何不同，因为如果响应中不存在值，可选变量也设置为 nil。

【问题讨论】：

您是否知道该方法返回一个String?，这是一个可选的？所以基本上你是对的。 使用了可选参数。

【参考方案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 值等于true。 （我想你的解码器keyDecodingStrategy 在这个例子的其余部分是.convertFromSnakeCase）

---

2。 JSON 中缺少一些键，您可以在 Swift 中使用可选键：

    "project_names": ["project1", "project2", "project3"]

你现在可以使用这个结构了：

struct Program: Codable 
    let projectNames: [String]
    var isPro: Bool?

您将获得一个Program 对象，其isPro 值等于nil。

如果 JSON 看起来像这样：

    "project_names": ["project1", "project2", "project3"],
    "is_pro": true

那么isPro 将是一个Bool?，其值为true。 也许这就是你想要的，但也许你想要一个默认值为false 的Bool。这就是decodeIfPresent 可能有用的地方。

---

3。 JSON 中缺少一些键，您需要在 Swift 中具有默认值的非可选属性：

如果你的结构看起来像这样：

struct Program: Codable 
    let projectNames: [String]
    var isPro: Bool = false

如果您的 JSON 中不存在“is_pro”属性，您将收到解析错误。 因为 Codable 期望找到一个值来解析 Bool 属性。

在这种情况下，一个好主意是使用 decodeIfPresent 的初始化程序，如下所示：

struct Program: Codable 
    let projectNames: [String]
    let isPro: Bool

    init(from decoder: Decoder) throws 
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.projectNames = try container.decode([String].self, forKey: .projectNames)
        self.isPro = try container.decodeIfPresent(Bool.self, forKey: .isPro) ?? false
    

这让您可以两全其美：

您的结构具有Bool，而不是Bool? 属性 您仍然能够解析不包含“is_pro”字段的 JSON 如果 JSON 中不存在该字段，您可以获得默认值 false。

【参考方案2】：

是的，@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。

【参考方案3】：

这两行代码之间有一个微妙但重要的区别：

// Exhibit 1
foo = try container.decode(Int?.self, forKey: .foo)
// Exhibit 2
foo = try container.decodeIfPresent(Int.self, forKey: .foo)

Exhibit 1 将解析：

  "foo": null,
  "bar": "something"

但不是：

  "bar": "something"

虽然展览 2 会很高兴地解析两者。因此，在 JSON 解析器的正常用例中，您需要 decodeIfPresent 用于模型中的每个可选项。

【讨论】：

找到答案：虽然文档here 中没有提到。 comments of the API 本身也提到了它，也可以在问题中找到：D。如果遇到的编码值不能转换为请求的类型，它将抛出 DecodingError.typeMismatch。 decode 还可以抛出三个不同的错误。见here

第一个响应可以被foo = try container.decode(Int.self, forKey: .foo)解析吗？

不，它不能用foo = try container.decode(Int.self, forKey: .foo) 解析，因为Int 不能保存null 值（即nil）。

foo = try container.decodeIfPresent(Int.self, forKey: .foo) 和 foo = try? container.decode(Int.self, forKey: .foo) 有区别吗？

是的，因为foo = try? container.decode(Int.self, forKey: .foo) 将解码所有出现"foo" 包含值但无法转换为Int 的情况。例如："foo": "something" 将导致 foo 包含 nil。您绝对应该抓住错误，而不是用try? 忽略它。