如何在 Swift 中精准解码 JSON 数据？

2024-08-08 13:11:38

在 Swift 中精准解码 JSON 数据

在 Swift 开发中，处理 JSON 数据是家常便饭。我们常常需要从服务器获取 JSON 格式的数据，然后将其解析成 App 可以使用的 Swift 对象。JSONDecoder 是 Apple 提供的强大工具，可以轻松地将 JSON 数据转换为 Swift 对象。但是，当我们只需要解码 JSON 数据的特定部分时，传统的完整解码方式就显得笨拙，甚至会降低应用性能。

本文将深入探讨如何在 Swift 中使用 JSONDecoder 精准地解码 JSON 数据的特定部分，避免不必要的资源浪费，提高解码效率。

直击痛点：传统方法的弊端

试想一下，你需要从一个庞大的 JSON 对象中提取一个简单的数组。传统的做法是定义一个与整个 JSON 结构完全匹配的 Swift 结构体，然后使用 JSONDecoder 将整个 JSON 数据解码成该结构体。这种方法在处理小型 JSON 数据时或许还算便捷，但一旦面对大型复杂的 JSON 数据，就会暴露出以下问题：

代码冗余 : 你需要为大量不需要的字段定义属性，即使你根本不关心它们。
性能损耗 : 解码整个 JSON 数据会消耗更多的时间和内存，尤其是在处理嵌套层级较深的 JSON 数据时。
维护困难 : 当 JSON 结构发生变化时，你需要修改大量的代码，以确保结构体与 JSON 数据保持一致。

精准打击：嵌套结构体和 CodingKeys

为了解决这些问题，我们可以采用更灵活的方式——利用 Swift 的嵌套结构体和 CodingKeys 来精准控制解码过程。

1. 定义目标结构体:

首先，我们需要明确自己需要解码 JSON 数据的哪一部分，并为其定义一个 Swift 结构体。例如，如果我们只需要解码 JSON 数据中的一个名为 "results" 的数组，并且该数组中的每个元素都包含 "id" 和 "type" 两个字段，那么我们可以定义如下结构体：

struct Item: Codable {
    let id: Int
    let type: String
}

2. 创建外部结构体:

接下来，我们需要创建一个外部结构体，用于容纳目标结构体以及 JSON 数据中与目标结构体相对应的键。在本例中，我们需要将 "results" 数组封装到一个名为 "ResultData" 的外部结构体中：

struct ResultData: Codable {
    let results: [Item]
}

3. 使用解码器精准解码:

现在，我们可以使用 JSONDecoder 将 JSON 数据解码为 ResultData 类型的实例，然后通过访问其 results 属性来获取我们需要的数组：

let jsonData = """
{
  "game": {
     "friends": 10,
      "worlds": 50,
  },
  "results": [
  {
    "id": 1,
    "type": "Infantry",
  },
  {
    "id": 2,
    "type": "Cavalry",

  }
]
}
""".data(using: .utf8)!

let decoder = JSONDecoder()
let resultData = try decoder.decode(ResultData.self, from: jsonData)

let items = resultData.results

// 现在你可以自由使用 items 数组了
for item in items {
    print("Item ID: \(item.id), Type: \(item.type)")
}

通过以上步骤，我们成功地将 JSON 数据中的 "results" 数组解码成 [Item] 类型的 Swift 数组，而无需定义冗余的结构体来映射整个 JSON 数据。

举一反三：应对复杂场景

嵌套结构体和 CodingKeys 的强大之处在于其灵活性，可以应对各种复杂的 JSON 数据结构。

场景一：嵌套的 JSON 对象

假设我们需要解码 JSON 数据中一个名为 "user" 的对象，该对象包含 "id"、"name" 和 "address" 三个字段，其中 "address" 字段本身又是一个包含 "street"、"city" 和 "country" 三个字段的对象。

{
  "user": {
    "id": 123,
    "name": "Alice",
    "address": {
      "street": "123 Main Street",
      "city": "Anytown",
      "country": "USA"
    }
  }
}

我们可以定义如下结构体：

struct Address: Codable {
    let street: String
    let city: String
    let country: String
}

struct User: Codable {
    let id: Int
    let name: String
    let address: Address
}

struct UserData: Codable {
    let user: User
}

然后使用 JSONDecoder 解码 JSON 数据：

let jsonData = """
{
  "user": {
    "id": 123,
    "name": "Alice",
    "address": {
      "street": "123 Main Street",
      "city": "Anytown",
      "country": "USA"
    }
  }
}
""".data(using: .utf8)!

let decoder = JSONDecoder()
let userData = try decoder.decode(UserData.self, from: jsonData)

let user = userData.user

print("User ID: \(user.id), Name: \(user.name)")
print("Address: \(user.address.street), \(user.address.city), \(user.address.country)")

场景二： JSON 键名与 Swift 属性名不一致

如果 JSON 数据中的键名与 Swift 结构体中的属性名不一致，我们可以使用 CodingKeys 枚举来建立映射关系。

假设我们需要解码 JSON 数据中一个名为 "first_name" 的字段，但我们希望将其映射到 Swift 结构体中的 firstName 属性。

{
  "first_name": "John",
  "last_name": "Doe"
}

我们可以定义如下结构体：

struct Person: Codable {
    let firstName: String
    let lastName: String

    enum CodingKeys: String, CodingKey {
        case firstName = "first_name"
        case lastName = "last_name"
    }
}

然后使用 JSONDecoder 解码 JSON 数据：

let jsonData = """
{
  "first_name": "John",
  "last_name": "Doe"
}
""".data(using: .utf8)!

let decoder = JSONDecoder()
let person = try decoder.decode(Person.self, from: jsonData)

print("First Name: \(person.firstName), Last Name: \(person.lastName)")