WhatsNewKit库中首次安装时不显示更新提示页面的解决方案

背景介绍

WhatsNewKit是一个优秀的SwiftUI库，用于在应用更新时向用户展示"新功能"页面。该库默认会在应用首次安装或更新后自动显示新功能介绍页面。然而，在某些业务场景下，开发者可能希望在首次安装时不立即展示这个页面，而是先显示其他更重要的引导内容。

问题分析

在WhatsNewKit的默认实现中，当使用UserDefaultsWhatsNewVersionStore作为版本存储时，系统会将已展示版本信息同时保存在UserDefaults和属性列表文件中。当开发者重置模拟器时，这些存储信息会被清除，导致应用在下一次启动时误判为"首次运行"而再次展示新功能页面。

这种机制在大多数情况下是合理的，但对于需要在首次安装时优先展示其他内容的开发者来说，就需要寻找解决方案来绕过默认行为。

解决方案探索

方案一：自定义WhatsNewVersionStore

WhatsNewKit提供了WhatsNewVersionStore协议，允许开发者实现自己的版本存储逻辑。通过自定义存储实现，可以完全控制版本展示的判断条件。

struct CustomVersionStore: WhatsNewVersionStore {
    func hasPresented(_ version: WhatsNew.Version) -> Bool {
        // 自定义判断逻辑
        return true // 返回true表示已展示过，不显示新功能页面
    }
    
    func save(presentedVersion version: WhatsNew.Version) {
        // 自定义保存逻辑
    }
    
    var presentedVersions: [WhatsNew.Version] {
        // 返回已展示版本列表
        return []
    }
}

方案二：修改WhatsNewEnvironment

WhatsNewKit还提供了WhatsNewEnvironment环境变量，可以通过重写环境值来自定义展示逻辑：

struct YourApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
                .environment(
                    \.whatsNew,
                     WhatsNewEnvironment(
                        versionStore: UserDefaultsWhatsNewVersionStore(),
                        whatsNewCollection: self
                     )
                )
        }
    }
}

extension YourApp: WhatsNewCollection {
    func whatsNew(at version: WhatsNew.Version) -> WhatsNew? {
        // 在这里添加自定义逻辑判断是否应该展示
        if /* 首次安装条件 */ {
            return nil // 返回nil表示不展示
        }
        return WhatsNew(...) // 返回实际的更新内容
    }
}

方案三：扩展ViewModifier

开发者还可以通过扩展ViewModifier来实现更细粒度的控制。这种方法虽然灵活，但需要注意避免在ViewModifier的body中使用过多条件判断，以免影响SwiftUI的视图更新效率。

extension View {
    func customWhatsNewSheet(
        whatsNew: Binding<WhatsNew?>,
        versionStore: WhatsNewVersionStore? = nil,
        layout: WhatsNew.Layout = .default,
        onDismiss: (() -> Void)? = nil,
        hideOnInitialInstall: Bool = false
    ) -> some View {
        self.modifier(
            CustomWhatsNewSheetViewModifier(
                whatsNew: whatsNew,
                versionStore: versionStore,
                layout: layout,
                onDismiss: onDismiss,
                hideOnInitialInstall: hideOnInitialInstall
            )
        )
    }
}

最佳实践建议

1. 评估业务需求：首先明确是否需要完全禁止首次安装时的展示，还是只需要延迟展示。

2. 考虑用户体验：确保用户不会错过重要的新功能介绍，同时避免过度打扰。

3. 测试验证：在真实设备上测试各种场景，包括首次安装、更新安装和常规启动。

4. 数据持久化：如果选择自定义存储方案，确保数据持久化机制可靠，避免数据丢失导致重复展示。

总结

WhatsNewKit提供了多种灵活的扩展点，使开发者能够根据具体需求调整新功能页面的展示逻辑。通过理解库的核心机制和合理利用其提供的协议和环境变量，开发者可以轻松实现"首次安装不展示"等定制化需求，同时保持代码的整洁和可维护性。

对于大多数场景，推荐使用WhatsNewEnvironment方案，它既能满足定制需求，又能保持与库的深度集成，是最优雅的解决方案。