返回资讯中心
外部精选
软件工程
#开发者实时流

NewsNinja借iCloud键值存储实现同步,全部数据不到1MB

来源标题:How NewsNinja syncs all its data in less than 1 MB of iCloud

NewsNinja没有账号和同步服务器,却能在iPhone、iPad、Vision Pro和Mac之间同步订阅源、设置、已读和收藏文章。它使用苹果的NSUbiquitousKeyValueStore键值存储API,将所有数据控制在iCloud的1MB上限以内。作者称相比Core Data或CloudKit,这一方案更轻量。

Hacker News 最新xeo842026/11/16 · 今天30 分钟阅读

以下正文由 AI 翻译自 Hacker News 最新(原文版权归原站所有),可能存在偏差,重要内容请以原文为准。

NewsNinja 没有账号,也没有同步服务器,但它依然能在你的 iPhone、iPad、Vision Pro 和 Mac 之间同步数据。你的订阅源、分类、设置、已读文章和星标文章,全都通过一个小巧的 Apple API 完成同步:NSUbiquitousKeyValueStore,也就是 iCloud 键值存储。

整套数据不到 1 MB。这篇文章会讲清楚这个存储是怎么工作的、我为什么选它,以及在应用不断成长的过程中,用什么技巧让 NewsNinja 始终不超出它的限制。

为此,用一个真正的数据库显得有点杀鸡用牛刀。Core Data 或 SwiftData 意味着要有一套 schema、一个 model container、迁移,还要搭一个 CloudKit container 来配置和维护,而这一切只是为了存一个字符串数组。我也不想自己跑同步服务器。NewsNinja 没有账号,我希望它保持这样。

NSUbiquitousKeyValueStore 的体量刚好匹配这个问题。

如果你熟悉 UserDefaults,那你已经掌握了这套 API 的大部分内容。它就是一个键和属性列表值(字符串、数字、布尔值、日期、Data、数组和字典)组成的字典,由系统通过用户的 iCloud 账号进行同步。

要使用它,在 Xcode 中启用 iCloud capability,并勾选 Key-value storage。这会添加 com.apple.developer.ubiquity-kvstore-identifier 权限。不需要 CloudKit container 或 schema。

下面这段代码接近 NewsNinja 在 2024 年 6 月首次发布的那个 KeyValueStore:

import Foundation
import Combine

class KeyValueStore: ObservableObject {
    static let shared = KeyValueStore()
    private let keyValueStore = NSUbiquitousKeyValueStore.default
    private let rssFeedsKey = "rssFeeds"
    private var cancellable: AnyCancellable?

    @Published var rssFeeds: [String] = [] {
        didSet {
            keyValueStore.set(rssFeeds, forKey: rssFeedsKey)
            keyValueStore.synchronize()
        }
    }

    private init() {
        rssFeeds = keyValueStore.array(forKey: rssFeedsKey) as? [String] ?? []
    }

    func addRssFeed(_ feedUrl: String) {
        guard !rssFeeds.contains(feedUrl) else { return }
        rssFeeds.append(feedUrl)
    }
}

这就是整个持久化层:一个键,一个字符串数组。读取是同步的,写入是即时的,所以 SwiftUI 视图可以像绑定其他任何 @Published 属性一样绑定它。

当你调用 set(_:forKey:) 时,值会立即写入设备上的本地副本。系统会在它选定的时间稍后将其上传到 iCloud。synchronize() 并不会强制上传。正如 Apple 的文档所说,它只是“让 iCloud 知道有新的键和值可以上传”。它还会读入已经到达的变更,所以在启动时调用它是明智之举。

这也意味着这个存储在没有 iCloud 的情况下也能工作。如果用户已登出,值仍然会保存在设备上,只是不会同步。

当另一台设备修改了某个值时,系统会发出 didChangeExternallyNotification。其 userInfo 会告诉你哪些键发生了变化以及原因:

cancellable = NotificationCenter.default
    .publisher(for: NSUbiquitousKeyValueStore.didChangeExternallyNotification)
    .sink { [weak self] notification in
        let reason = notification.userInfo?[NSUbiquitousKeyValueStoreChangeReasonKey] as? Int
        let changedKeys = notification.userInfo?[NSUbiquitousKeyValueStoreChangedKeysKey] as? [String] ?? []

        switch reason {
        case NSUbiquitousKeyValueStoreServerChange,
             NSUbiquitousKeyValueStoreInitialSyncChange:
            // 另一台设备写入了内容,或者这是首次下载
            Task { @MainActor in self?.reload(keys: changedKeys) }
        case NSUbiquitousKeyValueStoreQuotaViolationChange:
            // 存储超出限制,不会上传新的变更
            break
        case NSUbiquitousKeyValueStoreAccountChange:
            // 用户切换了 iCloud 账号,存储被替换
            break
        default:
            break
        }
    }

NewsNinja 在启动时开始监听这个通知,调用一次 synchronize(),然后从存储中重新加载全部内容。每个属性在赋值前都会先进行比较,因此来自另一台设备的同步只会刷新那些数据确实发生了变化的视图。

问题来了:这个存储是为小数据量设计的。

系统还会限制同步的频率,所以它不适合那些每秒变化多次的数据。而且冲突解决方式很简单:对某个键的最后一次写入胜出,会替换掉整个值。

对于一组订阅源 URL 来说,这些都不成问题。几百个订阅源也就几 KB。

每当 NewsNinja 学会了新东西,总会忍不住想把它也放进存储里。而且这总是很容易:加一个新键,加一个 didSet。

设置很小。订阅源和分类也一直很小。已读文章和星标文章就不一样了:它们会随着你使用应用的时间一天天增长。大部分的工作都花在这两者上。

为了记住你读过哪些文章,NewsNinja 需要为每篇你打开的文章提供一个身份标识。最明显的选择是文章 URL。但 URL 很长。我测量了 25,000 个典型文章 URL 编码为属性列表后的大小,大约需要 1.9 MB。这几乎是整个存储容量的两倍,而这还只是一个功能。

NewsNinja 不需要知道你看的是哪个 URL。它只需要回答一个问题:“我以前见过这篇文章吗?”哈希同样能很好地回答这个问题。

从一开始,NewsNinja 存的就是每篇文章 URL 的 CRC32 校验和,而不是 URL 本身。CRC32 是一个 32 位的值,所以每篇已读文章正好占用 4 字节,无论它的 URL 是 40 个字符还是 400 个字符长。

struct CRC32 {
    private static let table: [UInt32] = (0...255).map { i in
        (0..<8).reduce(UInt32(i)) { crc, _ in
            (crc >> 1) ^ (crc & 1 == 1 ? 0xEDB88320 : 0)
        }
    }

    static func checksum(string: String) -> UInt32 {
        ~Data(string.utf8).reduce(~UInt32(0)) { crc, byte in
            (crc >> 8) ^ table[Int((crc & 0xFF) ^ UInt32(byte))]
        }
    }
}

func markArticleAsRead(url: String) {
    readArticles.insert(CRC32.checksum(string: url))
}

(原文较长,此处译出前 6000 字,完整内容请点「打开原文」。)

正文由 探How 从来源站点 RSS 同步,内容未经改写;遇到排版缺失或需要图片、视频时请以原文为准。

打开原文
去社区讨论 →