Swift-Tagged 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00018/article/details/138840429

Swift-Tagged 项目教程

swift-tagged 🏷 A wrapper type for safer, expressive code. 项目地址: https://gitcode.com/gh_mirrors/sw/swift-tagged

1. 项目介绍

Swift-Tagged 是一个用于增强 Swift 类型安全性的开源库。它通过引入“标签”机制，使得开发者可以在编译时区分不同类型的相同基础类型值，从而避免运行时错误。例如，一个 Int 类型的用户 ID 和一个 Int 类型的订阅 ID 可以通过 Tagged 包装成不同的类型，从而在编译时防止误用。

主要特点

类型安全：通过标签机制，确保不同类型的值在编译时被正确区分。
易用性：使用简单，只需对现有类型进行包装即可。
灵活性：支持多种基础类型，如 Int、String 等。

2. 项目快速启动

安装

首先，通过 Swift Package Manager 将 Swift-Tagged 添加到你的项目中。在你的 Package.swift 文件中添加以下依赖：

dependencies: [
    .package(url: "https://github.com/pointfreeco/swift-tagged.git", from: "0.6.0")
]

使用示例

以下是一个简单的使用示例，展示了如何使用 Tagged 来区分用户 ID 和订阅 ID。

import Tagged

struct User {
    let id: Id
    let email: String
    let subscriptionId: Subscription.Id
    
    typealias Id = Tagged<User, Int>
}

struct Subscription {
    let id: Id
    
    typealias Id = Tagged<Subscription, Int>
}

func fetchSubscription(byId id: Subscription.Id) -> Subscription? {
    // 模拟从数据库中获取订阅
    return nil
}

let user = User(id: 1, email: "user@example.com", subscriptionId: 2)

// 尝试使用用户 ID 获取订阅
// 这行代码会编译失败，因为类型不匹配
// let subscription = fetchSubscription(byId: user.id)

// 正确使用订阅 ID
let subscription = fetchSubscription(byId: user.subscriptionId)

3. 应用案例和最佳实践

案例1：区分不同类型的字符串

在某些情况下，你可能需要区分不同类型的字符串，例如用户的电子邮件地址和用户的地址。使用 Tagged 可以轻松实现这一点：

struct User {
    let id: Id
    let email: Email
    let address: Address
    
    typealias Id = Tagged<User, Int>
    typealias Email = Tagged<User, String>
    typealias Address = Tagged<(User, address: ()), String>
}

func sendWelcomeEmail(toAddress address: User.Email) {
    // 发送欢迎邮件
}

let user = User(id: 1, email: "user@example.com", address: "123 Main St")

// 尝试使用地址发送邮件
// 这行代码会编译失败，因为类型不匹配
// sendWelcomeEmail(toAddress: user.address)

// 正确使用电子邮件地址
sendWelcomeEmail(toAddress: user.email)