一、需求内容
遇到的一个需求内容是:从首页A的入口进入页面B,在页面B中输入设备号进入页面C开始同步(从网络获取一些项目中使用的数据)
- 如果在未结束状态下,在页面C左滑就直接退回首页A,然后在首页A入口点击直接进入页面C,并且进入页面C后不需要再次绑定设备
- 在页面C中退出同步后,进入页面B重新输入设备号绑定设备
在刚开始的时候我想着用viewModel定义一个标志变量就能解决了,后来才发现在切换页面的时候viewModel的生命周期就会结束,标志变量也就不生效了,因为viewModel的生命周期是和创建这个viewModel的Activity的生命周期所绑定的
然后在之后我找到一个方法,使用 SharedPreferences 就可以在全局存储一些简单的数据,正好在后面还需要在页面跳转过程中需要传递一些简单的列表,也就不再需要使用Intent了
SharedPreferences 是 Android 提供的一个轻量级的数据存储解决方案,它允许保存和检索键值对数据。这种存储方式适用于保存少量的数据,如用户设置、配置选项、应用状态等。SharedPreferences 将数据保存在磁盘上,因此即使应用程序关闭,数据也不会丢失。
二、SharedPreferences 特性
以下是 SharedPreferences 的一些关键特性:
- 简单易用:通过简单的 API 调用即可保存和读取数据。
- 数据类型支持:支持存储各种基本数据类型,如 String、int、long、float、boolean 以及 String 集合。
- 文件存储:数据被保存在一个 XML 文件中,通常位于设备的内部存储中。
- 私有和共享:可以为每个应用程序单独创建 SharedPreferences 文件,也可以让多个应用程序共享同一个文件。
- 异步操作:数据的保存操作是异步的,不会阻塞主线程。
当使用 SharedPreferences 时,可以通过指定不同的访问模式来控制文件的访问权限。以下是三种主要的访问模式:
Context.MODE_PRIVATE: 这是默认的访问模式。 使用此模式时,只有创建该 SharedPreferences 文件的应用程序可以访问它。 这意味着文件是私有的,其他应用程序无法读取或写入该文件。 这是保存敏感数据(如用户设置、认证令牌等)时推荐使用的模式。
Context.MODE_WORLD_READABLE: 此模式允许任何应用程序读取 SharedPreferences 文件。 但是,只有创建该文件的应用程序可以对其进行写操作。 这种模式通常不推荐使用,因为它会降低数据的安全性。
Context.MODE_WORLD_WRITEABLE: 此模式允许任何应用程序对 SharedPreferences 文件进行写操作。 同样,只有创建该文件的应用程序可以对其进行写操作。 这种模式也不推荐使用,因为它同样会降低数据的安全性。
三、使用步骤
使用 SharedPreferences 的基本步骤:
1、获取 SharedPreferences 实例:
- 获取 SharedPreferences 实例: 私有 SharedPreferences:getSharedPreferences(String name, int mode)
- 共享 SharedPreferences:getSharedPreferences(String name, int mode) 并使用相同的文件名在不同应用程序之间共享。
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
2、编辑数据:
- 使用 edit() 方法获取 SharedPreferences.Editor 实例。
- 使用 put 方法保存数据,如 putString、putInt、putBoolean 等。
val editor = prefs.edit()
editor.putBoolean(KEY_SYNC_STATUS, status)
3、提交更改:
- commit():同步提交更改,返回一个布尔值表示操作是否成功。
- apply():异步提交更改,不返回结果,适用于不需要立即知道结果的场景。
editor.apply()
4、读取数据:
- 使用 get 方法读取数据,如 getString、getInt、getBoolean 等,需要提供默认值。
return prefs.getBoolean(KEY_SYNC_STATUS, false)
5、移除和清除数据:
- remove(String key):移除指定键的数据。
- clear():清除所有数据。
editor.remove(KEY_SYNC_STATUS)
editor.remove(KEY_DEVICE_NUMBER)
editor.clear()
editor.apply()
四、在项目中使用
1、定义
然后我就在项目中定义了SyncStatus单例类,在类中定义了一系列get和set方法,代码如下:
import android.content.Context
object SyncStatus {
private const val PREF_NAME = "SyncPrefs"
private const val KEY_SYNC_STATUS = "sync_status"
private const val KEY_DEVICE_NUMBER = "serial_number"
private const val KEY_SELECTED_PHOTOS = "selected_photos"
private var selectedPhotos: ArrayList<String> = arrayListOf()
// 设置选中的照片列表
fun setSelectedPhotos(context: Context, photos: List<String>?) {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
val editor = prefs.edit()
val photoSet = HashSet(photos) // 将列表转换为集合以避免重复
editor.putStringSet(KEY_SELECTED_PHOTOS, photoSet)
editor.apply()
selectedPhotos = ArrayList(photoSet) // 更新内部列表
}
// 获取选中的照片列表
fun getSelectedPhotos(context: Context): ArrayList<String> {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
val photoSet = prefs.getStringSet(KEY_SELECTED_PHOTOS, null) ?: return arrayListOf()
return ArrayList(photoSet)
}
//设置同步状态
fun setSyncStatus(context: Context, status: Boolean) {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
val editor = prefs.edit()
editor.putBoolean(KEY_SYNC_STATUS, status)
editor.apply()
}
//获取同步状态
fun getSyncStatus(context: Context): Boolean {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
return prefs.getBoolean(KEY_SYNC_STATUS, false)
}
//设置设备号
fun setDeviceNumber(context: Context, serialNumber: String?) {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
val editor = prefs.edit()
editor.putString(KEY_DEVICE_NUMBER, serialNumber)
editor.apply()
}
//获取设备号
fun getDeviceNumber(context: Context): String? {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
return prefs.getString(KEY_DEVICE_NUMBER, null)
}
//清除保存的所有信息
fun clearAll(context: Context) {
val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
val editor = prefs.edit()
editor.clear()
editor.apply()
}
// // 清除同步状态
// fun clearSyncStatus(context: Context) {
// val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
// val editor = prefs.edit()
// editor.remove(KEY_SYNC_STATUS)
// editor.apply()
// }
//
// // 清除序列号
// fun clearSerialNumber(context: Context) {
// val prefs = context.getSharedPreferences(PREF_NAME, Context.MODE_PRIVATE)
// val editor = prefs.edit()
// editor.remove(KEY_DEVICE_NUMBER)
// editor.apply()
// }
}
2、使用
在网络请求成功回调时调用SyncStatus中的方法定义同步状态
private fun refresh(cameraNo:String){
vm.getSwingFunPhotoList(cameraNo,startAt){
mDataBind.printActSwingFunPhotoListRefresh.finishRefresh()
if (it){
val isEmpty = vm.swingFunPhotoList.isNullOrEmpty()
adapter.data = vm.swingFunPhotoList
mDataBind.empty = isEmpty
if (isEmpty){
initEmptyColor()
}
SyncStatus.setSyncStatus(this, true)
}else{
tip(vm.failMag)
}
}
}
在页面跳转之前检查当前同步状态决定跳转的页面
mDataBind.printActMainActionSwingFunSwitch.setOnClickListener{
if (checkNotLogin()) {
return@setOnClickListener
}
val isSyncing = SyncStatus.getSyncStatus(this)
if (isSyncing){
startActivity(Intent(this@MainAct,SwingFunSelectPhotoListAct::class.java))
}else{
startActivity(Intent(this@MainAct, SwingFunSelectPhotoAct::class.java))
}
}
在监听事件调用SyncStatus中设置列表
//下一步按钮
mDataBind.printActSwingFunPhotoListNext.setOnClickListener {
selectedPhotosUrl = vm.selectedPhotoList.map { it.user_url.toString() }
SyncStatus.setSelectedPhotos(this,selectedPhotosUrl)
dialog.show(supportFragmentManager, "SwingFunSettingDialog")
}
获取列表
//获取选中图片的url列表
selectedPhotos = SwingFunSyncStatus.getSelectedPhotos(this)