WhatsNewKit 项目中的版本存储机制解析

概述

WhatsNewKit 是一个用于在应用更新后向用户展示新特性的 Swift 库。其中版本存储机制是核心功能之一，它决定了何时以及如何向用户展示"新功能"页面。

版本存储的基本原理

WhatsNewKit 通过版本存储(VersionStore)来记录用户已经看到过哪些版本的新功能介绍。当应用更新后，系统会比较当前版本与存储的版本，决定是否需要展示新功能页面。

主要存储类型

WhatsNewKit 提供了两种主要的版本存储方式：

1. 内存存储(WhatsNewVersionInMemoryStore)

   • 仅在应用运行时有效
   • 应用关闭后记录会丢失
   • 适合开发调试阶段使用

2. UserDefaults存储(UserDefaultsWhatsNewVersionStore)

   • 持久化存储
   • 记录会保存在设备的UserDefaults中
   • 适合生产环境使用

实际应用示例

基本使用方式

// 创建UserDefaults存储实例
let versionStore = UserDefaultsWhatsNewVersionStore()

// 记录用户已看到的版本
let version = WhatsNew.Version(major: 1, minor: 0, patch: 0)
versionStore.save(presentedVersion: version)

自动展示逻辑

WhatsNewKit 可以自动处理版本比较和展示逻辑：

// 配置自动展示
WhatsNewViewController.presentAutomatically(
    whatsNew: whatsNew,
    versionStore: versionStore
)

版本比较机制

当使用自动展示模式时，WhatsNewKit 会执行以下逻辑：

1. 获取当前应用的版本号
2. 从版本存储中读取用户最后看到的版本号
3. 如果当前版本 > 存储版本，则展示新功能页面
4. 展示完成后，存储当前版本号

常见问题解决方案

问题：新版本发布后页面未展示

可能原因：

1. 版本号格式不正确
2. 存储机制未正确配置
3. 版本比较逻辑不符合预期

解决方案：

1. 确保版本号格式正确，例如 WhatsNew.Version(major: 1, minor: 0, patch: 0)
2. 检查是否使用了持久化存储(UserDefaults)
3. 确认当前版本号确实大于存储的版本号

调试技巧

1. 使用内存存储进行快速测试
2. 打印出存储的版本号进行验证
3. 在模拟器中重置应用数据，模拟首次安装场景

最佳实践

1. 生产环境：始终使用UserDefaults存储
2. 测试阶段：可以结合内存存储快速验证
3. 版本规划：合理规划版本号变更策略，确保用户能看到重要的更新内容
4. 用户体验：不要过于频繁地展示新功能页面，只在有重要更新时使用

通过合理配置WhatsNewKit的版本存储机制，开发者可以有效地管理新功能展示逻辑，提升用户体验。