[Swift] Identifiable, Codable, Hashable 协议

한국어 English 日本語 简体中文 繁體中文
By Gi Pyeong Lee
协议 ios protocol identifiable swift SwiftUI
在 Swift 中，协议扮演着重要的角色。协议是定义执行特定功能所需属性和方法的接口，遵循该协议的类型必须实现协议的要求。本篇博客将介绍在创建用户模型时非常实用的 Identifiable、Codable 和 Hashable 协议。

用户模型结构体定义示例

以下是定义了一个名为 User 的结构体，并遵循 Identifiable、Codable 和 Hashable 协议的代码。 


import Foundation

struct User: Identifiable, Codable, Hashable {
    let id: String
    let fullname: String
    let email: String
    let username: String
    let profileImageUrl: String?
    let bio: String?

    init(
        id: String,
        fullname: String,
        email: String,
        username: String,
        profileImageUrl: String? = nil,
        bio: String? = nil)
    {
        self.id = id
        self.fullname = fullname
        self.email = email
        self.username = username
        self.profileImageUrl = profileImageUrl
        self.bio = bio
    }
}

该结构体是为了存储用户信息而定义的模型。在上述代码中，最值得关注的是它遵循了 Identifiable、Codable 和 Hashable 这三个协议。现在我将解释每个协议的含义，以及为什么它们在这个代码中如此重要。

1. Identifiable 协议

Identifiable 协议与 SwiftUI 密切相关。当 SwiftUI 渲染列表时，需要能够唯一地识别每一项，因此 Identifiable 协议的作用就是提供用于此目的的唯一标识符。

要求

Identifiable 协议要求具备一个名为 id 的属性，且该属性必须是唯一的。在 User 结构体中，id 定义为 String 类型，通过该值来唯一标识用户。

优点

  • 与 SwiftUI 的兼容性 ：在 SwiftUI 中渲染列表或数据时，需要一个能够识别每一项的 id。该协议使其能够自动提供支持。
  • 唯一数据管理 ：由于通过 id 来区分用户，因此可以轻松管理列表中不重复的唯一项。

示例代码 


let user1 = User(id: "123", fullname: "John Doe", email: "john@example.com", username: "johnny")
let user2 = User(id: "456", fullname: "Jane Doe", email: "jane@example.com", username: "janedoe")

let users = [user1, user2]

当在 SwiftUI 列表中使用时，users 数组的每一项都会通过 id 值进行识别。

2. Codable 协议

Codable 协议允许将对象转换为 JSON 等外部数据格式，或将这些数据转换为 Swift 对象。它是两个协议（Encodable 和 Decodable）的组合，可以轻松地对对象进行序列化（encode）或反序列化（decode）。

要求

Codable 默认提供自动序列化和反序列化结构体所有属性的功能。这意味着无需编写额外的代码，就可以将 JSON 数据转换为 Swift 的 User 对象，反之亦然。

优点

  • 网络通信 ：可以轻松地将从 API 获取的 JSON 数据转换为 Swift 对象，在向服务器发送数据时也非常有用。
  • 文件存储 ：将用户数据存储到文件时，可以轻松地将对象转换为 JSON 格式进行保存。

示例代码 


// 将 User 对象编码为 JSON
let encoder = JSONEncoder()
if let jsonData = try? encoder.encode(user1) {
    print(String(data: jsonData, encoding: .utf8)!)
}

// 将 JSON 解码为 User 对象
let decoder = JSONDecoder()
if let decodedUser = try? decoder.decode(User.self, from: jsonData) {
    print(decodedUser)
}

3. Hashable 协议

Hashable 协议允许对象被哈希化。哈希函数用于生成一个整数值，该值用于唯一标识对象，从而可以将对象用于 Set 或 Dictionary 等集合中。

要求

Hashable 协议要求对象必须具有一个名为 hashValue 的唯一整数值。但在大多数情况下，Swift 会自动生成该值。

优点

  • 可以使用 Set 和 Dictionary ：可以将 User 对象用作 Set 的元素或 Dictionary 的键。
  • 快速检索 ：可以使用哈希值快速检索数据。

示例代码 


var userSet: Set<User> = [user1, user2]
let userDict: [User: String] = [user1: "First User", user2: "Second User"]

如果 User 结构体不遵循 Hashable，则无法将其用于 Set 或 Dictionary。通过遵循 Hashable，可以生成对象的唯一哈希值并使用。

结论

Identifiable、Codable 和 Hashable 协议在 Swift 中非常有用，特别是在定义数据模型时经常被使用。如果同时使用这三个协议，可以高效地处理 UI 中的数据管理、API 通信 以及 集合内的快速数据检索 等各种需求。希望通过本篇博客介绍的用户模型示例，能让大家更好地理解在 Swift 中如何利用协议。

AD