swift-actor-persistence

swift-actor-persistence

热门

使用 Swift Actor 实现线程安全的数据持久化——内存缓存配合文件存储,从根本上消除数据竞争。

23万Star
3.5万Fork
更新于 2026/7/17
SKILL.md
readonly只读
name
swift-actor-persistence
description

使用 Swift Actor 实现线程安全的数据持久化——内存缓存配合文件存储,从根本上消除数据竞争。

Swift Actors 实现线程安全的持久化

使用 Swift actor 构建线程安全的数据持久化层的模式。结合内存缓存与文件存储,利用 actor 模型在编译时消除数据竞争。

何时使用

  • 在 Swift 5.5+ 中构建数据持久化层
  • 需要线程安全地访问共享可变状态
  • 希望消除手动同步(锁、DispatchQueue)
  • 构建离线优先的本地存储应用

核心模式

基于 Actor 的仓库

Actor 模型保证串行访问——编译器强制执行,无数据竞争。

public actor LocalRepository<T: Codable & Identifiable> where T.ID == String {
    private var cache: [String: T] = [:]
    private let fileURL: URL

    public init(directory: URL = .documentsDirectory, filename: String = "data.json") {
        self.fileURL = directory.appendingPathComponent(filename)
        // 初始化时同步加载(actor 隔离尚未生效)
        self.cache = Self.loadSynchronously(from: fileURL)
    }

    // MARK: - 公开 API

    public func save(_ item: T) throws {
        cache[item.id] = item
        try persistToFile()
    }

    public func delete(_ id: String) throws {
        cache[id] = nil
        try persistToFile()
    }

    public func find(by id: String) -> T? {
        cache[id]
    }

    public func loadAll() -> [T] {
        Array(cache.values)
    }

    // MARK: - 私有方法

    private func persistToFile() throws {
        let data = try JSONEncoder().encode(Array(cache.values))
        try data.write(to: fileURL, options: .atomic)
    }

    private static func loadSynchronously(from url: URL) -> [String: T] {
        guard let data = try? Data(contentsOf: url),
              let items = try? JSONDecoder().decode([T].self, from: data) else {
            return [:]
        }
        return Dictionary(uniqueKeysWithValues: items.map { ($0.id, $0) })
    }
}

使用方式

由于 actor 隔离,所有调用自动变为异步:

let repository = LocalRepository<Question>()

// 读取——从内存缓存中 O(1) 快速查找
let question = await repository.find(by: "q-001")
let allQuestions = await repository.loadAll()

// 写入——更新缓存并原子化写入文件
try await repository.save(newQuestion)
try await repository.delete("q-001")

与 @Observable ViewModel 结合

@Observable
final class QuestionListViewModel {
    private(set) var questions: [Question] = []
    private let repository: LocalRepository<Question>

    init(repository: LocalRepository<Question> = LocalRepository()) {
        self.repository = repository
    }

    func load() async {
        questions = await repository.loadAll()
    }

    func add(_ question: Question) async throws {
        try await repository.save(question)
        questions = await repository.loadAll()
    }
}

关键设计决策

决策 理由
Actor(而非 class + 锁) 编译器强制线程安全,无需手动同步
内存缓存 + 文件持久化 读取快速,写入持久
初始化时同步加载 避免异步初始化的复杂性
以 ID 为键的字典 按标识符 O(1) 查找
泛型约束 Codable & Identifiable 可复用于任何模型类型
原子化文件写入(.atomic 防止崩溃时部分写入

最佳实践

  • 使用 Sendable 类型 处理所有跨越 actor 边界的数据
  • 保持 actor 的公开 API 最小化——只暴露领域操作,不暴露持久化细节
  • 使用 .atomic 写入 防止应用在写入过程中崩溃导致数据损坏
  • init 中同步加载——异步初始化器增加复杂性,对本地文件收益甚微
  • @Observable ViewModel 结合 实现响应式 UI 更新

应避免的反模式

  • 在新的 Swift 并发代码中使用 DispatchQueueNSLock 替代 actor
  • 将内部缓存字典暴露给外部调用者
  • 使文件 URL 可配置而不进行验证
  • 忘记所有 actor 方法调用都需要 await——调用者必须处理异步上下文
  • 使用 nonisolated 绕过 actor 隔离(违背了目的)

何时使用

  • iOS/macOS 应用中的本地数据存储(用户数据、设置、缓存内容)
  • 离线优先架构,稍后同步到服务器
  • 任何应用多个部分并发访问的共享可变状态
  • 用现代 Swift 并发替代基于 DispatchQueue 的旧式线程安全方案