Swift Sharing 开源项目教程

Swift Sharing 开源项目教程

swift-sharing A universal solution to persistence and data sharing in surprisingly little code. 项目地址: https://gitcode.com/gh_mirrors/sw/swift-sharing

1. 项目介绍

Swift Sharing 是一个开源库，由 Point-Free 团队开发，旨在为 Swift 应用程序提供一种简便的方式来共享状态和实现数据持久化。这个库允许开发者轻松地在多个应用部分间同步数据，支持多种持久化策略，如用户偏好设置、文件系统以及内存中的数据共享。

2. 项目快速启动

首先，您需要在您的 Xcode 项目中添加 Swift Sharing 作为依赖项。如果您使用 Swift 包管理器（SwiftPM），可以在 Package.swift 文件中添加以下代码：

.package(url: "https://github.com/pointfreeco/swift-sharing.git", from: "2.0.0"),
.product(name: "Sharing", package: "swift-sharing"),

然后，将 Sharing 添加到需要使用该库的任何目标中。

下面是一个快速启动的示例，演示如何使用 @Shared 属性包装器在两个模型之间共享会议列表，并同步到文件系统：

import Sharing

// 定义一个模型，用于存储会议列表
@Observable
class MeetingsListModel {
    @ObservationIgnored
    @Shared(.fileStorage(.meetingsURL))
    var meetings: [Meeting] = []
}

// 定义另一个模型，它也将共享相同的会议列表
@Observable
class ArchivedMeetingsModel {
    @ObservationIgnored
    @Shared(.fileStorage(.meetingsURL))
    var meetings: [Meeting] = []
}

请注意，由于 Swift 的宏不支持与属性包装器良好交互，所以需要在 @Observable 模型中持有的每个 @Shared 属性上标注 @ObservationIgnored。这样可以确保当共享状态发生变化时，视图能够更新，因为 @Shared 会处理它自己的观察。

3. 应用案例和最佳实践

以下是使用 Swift Sharing 的一些常见案例和最佳实践：

• 在 SwiftUI 视图中直接使用 @Shared：

struct DebugMeetingsView: View {
    @Shared(.fileStorage(.meetingsURL))
    var meetings: [Meeting] = []

    var body: some View {
        ForEach(meetings) { meeting in
            Text(meeting.title)
        }
    }
}

• 在 UIKit 视图控制器中使用 @Shared 并观察变化：

final class DebugMeetingsViewController: UIViewController {
    @Shared(.fileStorage(.meetingsURL))
    var meetings: [Meeting] = []

    override func viewDidLoad() {
        super.viewDidLoad()
        // 使用 Sharing/publisher 或者 Swift Navigation 库的 observe 工具来观察 meetings 的变化
    }
}

• 持久化简单数据到用户偏好设置：

@Shared(.appStorage("soundsOn"))
var soundsOn = true

@Shared(.appStorage("hapticsOn"))
var hapticsOn = true

• 测试使用 @Shared 的功能：

Swift Sharing 允许您在测试中隔离存储系统，确保每个测试都是独立的，并且只能访问其自己的存储。

4. 典型生态项目

Swift Sharing 生态系统中有一些项目，可以帮助您进一步扩展其功能：

• SharingGRDB： 一个轻量级的 SwiftData 和 @Query 宏的替代品，由 Sharing 和 GRDB 支持。
• SwiftWasm 应用： 一个使用 Swift Sharing 在 Web 浏览器的本地存储中共享状态的项目。

以上就是关于 Swift Sharing 的开源项目教程。通过这些内容，您可以开始在自己的项目中使用 Swift Sharing，并探索其强大的功能。

swift-sharing A universal solution to persistence and data sharing in surprisingly little code. 项目地址: https://gitcode.com/gh_mirrors/sw/swift-sharing