对于将从JSON解析的对象模型的属性，我应该使用optional吗？

Question

我的 iOS 应用程序有一个非常常见的设置：它对使用JSON对象响应的API服务器进行HTTP查询。然后将这些JSON对象解析为适当的Swift对象。

最初，我将属性分为必需属性和可选属性，主要基于我的API服务器的数据库需求。例如，< code>id、< code>email和< code>name是必填字段，因此它们使用非可选类型。其他类型在数据库中可以是< code>NULL，因此它们是可选类型。

class User {
  let id: Int
  let email: String
  let profile: String?
  let name: String
  let motive: String?
  let address: String?
  let profilePhotoUrl: String?
}

最近，我开始怀疑这是否是一个好的设置。我发现，尽管一些财产可能始终存在于数据库中，但这并不意味着这些财产将始终包含在JSON响应中。

例如，在用户配置文件页面中，需要所有这些字段才能正确显示视图。因此，JSON响应将包含所有这些字段。然而，对于列出用户姓名的视图，我不需要email或id，JSON响应可能也不应该包含这些属性。不幸的是，这将导致错误并在将JSON响应解析为Swift对象时使应用程序崩溃，因为应用程序期望id、email、name始终不是-nil。

我正在考虑将Swift对象的所有财产更改为可选的，但这感觉就像是放弃了这种特定于语言的特性的所有好处。此外，无论如何，我将不得不在应用程序的其他地方编写更多的代码行来展开所有这些选项。

另一方面，JSON对象本质上不太能与Swift的严格静态类型和零检查进行互操作，因此接受这种烦恼可能更好。

我是否应该过渡到将每个属性都作为选项的模型？还是有更好的方法？如有任何意见，我将不胜感激。

Answer 1

前提：

部分表示是 REST 中的常见模式。这是否意味着 Swift 中的所有属性都需要是可选的？例如，客户端可能只需要视图的用户 ID 列表。这是否意味着所有其他属性（名称、电子邮件等）都需要标记为可选？这在 Swift 中是好的做法吗？

在模型中标记可选属性只能表明密钥可能会或可能不会出现。它允许读者在第一眼就知道模型的某些事情。
如果您只为不同的API响应结构维护一个通用模型并使所有属性可选，这是否是一个好的做法是非常有争议的。
我已经这样做了，它咬人。有时很好，有时只是不够清楚。

为多个API保留一个模型就像设计一个具有多个UI元素的ViewController，并根据具体情况确定应显示或不显示哪个UI元素
这增加了新开发人员的学习曲线，因为他们更了解所涉及的系统。

假设我们继续使用Swift的编码/解码模型的Codable，我会将其分解为单独的模型，而不是维护一个具有所有选项的通用模型

我做出决定的原因是：

> < li>

分离的清晰度

• 每个模型都有特定的用途
• 更干净的自定义解码器的范围
  • 当 json 结构需要一些预处理时很有用

  考虑稍后可能出现的API特定附加密钥。

  < li >如果这个用户列表API是唯一一个需要更多关键字的API，比如朋友数量或其他统计数据，该怎么办？ < ul > < li >我是否应该继续加载单个模型以支持不同的情况，其中附加键只出现在一个API响应中，而不出现在另一个API响应中？ < li >如果第三方API旨在获取用户信息，但这次的目的略有不同，该怎么办？我应该用更多的键重载同一个模型吗？

  但是，如果我很懒惰，并且我有一种强烈的感觉，疯狂的变化不会出现，我会继续将所有密钥设置为可选并承担相关费用。

Answer 2

首先要做的是问：“列出用户名称的视图”的元素

struct UserList: Decodable {

    struct Item: Decodable {
        var id: Int
        var name: String
    }

    var items: [Item]

}

（虽然问题说 JSON 响应可能不包含 id，但似乎没有 id 的用户列表并不是特别有用，所以我在这里要求它。

如果您真的希望它们是相同类型的对象，那么您可能希望将用户建模为具有服务器始终发送的核心财产和可能为零的“详细信息”字段：

class User: Decodable {
    let id: Int
    let name: String
    let details: Details?

    struct Details: Decodable {
        var email: String
        var profile: String?
        var motive: String?
        var address: String?
        var profilePhotoUrl: String?
    }

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decode(Int.self, forKey: .id)
        name = try container.decode(String.self, forKey: .name)
        details = container.contains(.email) ? try Details(from: decoder) : nil
    }

    enum CodingKeys: String, CodingKey {
        case id
        case name

        case email // Used to detect presence of Details
    }
}

注意，我使用< code > Details(from:decoder)而不是通常的< code > container . decode(Details . self，forKey:。详情)。我使用< code > Details(from:decoder)来实现这一点，以便< code>Details的属性与< code>User的属性来自同一个JSON对象，而不需要嵌套对象。

Answer 3

有三种方法可以做到这一点：

>

始终发送所有JSON数据，并将您的属性设为非可选。

将所有属性设为可选。

使所有属性都非可选，并编写自己的 init（from：） 方法将默认值分配给缺失值，如本答案中所述。

所有这些都应该有效;哪一个是“最好的”是基于意见的，因此超出了堆栈溢出答案的范围。根据您的特定需求选择最方便的一种。