推荐使用 Retained Instance —— 简化Android UI控制器的实例保留

一、项目简介

在Android开发中，管理视图模型（ViewModel）的状态持久化是关键任务之一。Retained Instance 是一个轻量级库，基于Android架构组件的ViewModel，旨在简化Activity、Fragment以及NavBackStackEntry的实例保留过程。这个库的目标不仅是减少代码冗余，而且是为了提供更简洁、更易于理解的API。

二、项目技术分析

Retained Instance 取消了对继承ViewModel的需求，同时也去除了对ViewModelProvider.Factory的依赖。它提供了直接访问ViewModel范围内的属性，如CoroutineScope和SavedStateHandle，让您可以方便地处理异步操作和状态保存。此外，它支持回调监听，通过OnClearedListener可以在清除时执行清理操作。该库最初是为了在Kotlin多平台项目中轻松共享Android和iOS之间的ViewModel而创建的。

三、应用场景

• 在Activity之间或Fragment之间共享状态，确保在配置变更或后台任务后仍然能够恢复用户界面的状态。
• 在导航组件（Navigation）中，可以跨不同的NavGraph保留ViewModel实例，实现组件间的通信和数据共享。
• 对于Compose开发者，Retained Instance 提供了对应的Composable支持，同样可以在Jetpack Compose中轻松保留和恢复状态。

四、项目特点

1. 无需继承：避免了对ViewModel的直接继承，让您能专注于业务逻辑而不是继承层级。
2. 简化工厂：不再需要编写ViewModelProvider.Factory，减小了代码复杂性。
3. 内置功能丰富：内建了CoroutineScope和SavedStateHandle，使得保存和恢复状态更方便。
4. 回调机制：提供OnClearedListener接口，当ViewModel被清除时可执行清理逻辑。
5. 多场景支持：不仅适用于Activity和Fragment，还支持Compose和View层次的实例保留。

五、安装与使用

要开始使用Retained Instance，只需将以下依赖添加到您的Gradle构建文件：

dependencies {
    // 根据具体需求选择对应的模块
    implementation 'dev.marcellogalhardo:retained-activity:{Tag}'
    implementation 'dev.marcellogalhardo:retained-fragment:{Tag}'
    implementation 'dev.marcellogalhardo:retained-navigation:{Tag}'
    implementation 'dev.marcellogalhardo:retained-navigation-fragment:{Tag}'
    implementation 'dev.marcellogalhardo:retained-compose:{Tag}'
    implementation 'dev.marcellogalhardo:retained-view:{Tag}'
    implementation 'dev.marcellogalhardo:retained-navigation-view:{Tag}'
}

替换{Tag}为最新的版本号。

总的来说，Retained Instance 是一个强大且灵活的解决方案，可以极大地提高您在Android应用中管理ViewModel的效率和用户体验。无论是大型项目还是小型应用，都值得尝试并将其纳入您的开发工具箱。现在就加入数以千计的开发者行列，利用Retained Instance提升您的开发体验吧！