现在可以开始将 SharedPreferences 迁移到 Preferences DataStore 了。因为 DataStore 的存在就是为了替代SP,所以谷歌早提供SharedPreferencesMigration
属性用于SP数据迁移。其他代码与前面类似,只需向迁移列表传入 SharedPreferencesMigration
属性,其中构造函数第二个参数 sharedPreferencesName 为所创建SP的文件名称,在本例中即为”test“。
private val Context.dataStore: DataStore by preferencesDataStore(
name = “preferences-test”,
// 新增部分
produceMigrations = { context ->
listOf(SharedPreferencesMigration(context, “test”))
}
)
由于键只能从 SharedPreferences 迁移一次,因此在我们迁移完毕后,需要将刚才临时创建的SP相关代码删除,此时的完整代码如下:
有一处需要注意的,在SP文件创建时,我们的key值设置为“number”,迁移后dataStore的key值也会被设置为“number”。所以与前面的例子相比,我们还需要将intPreferencesKey()
函数中的key值更改为“number”。
class MainActivity : AppCompatActivity() {
// 创建:preferencesDataStore 委托可确保我们有一个 DataStore 实例在应用中具有该名称
private val Context.dataStore: DataStore by preferencesDataStore(
name = “preferences-test”,
produceMigrations = { context ->
listOf(SharedPreferencesMigration(context, “test”))
}
)
private val COUNTER = intPreferencesKey(“number”)
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
val tv = findViewById(R.id.tv_test)
val fab = findViewById(R.id.fab)
MainScope().launch {
dataStore.data
.map {
it[COUNTER] ?: 0
}.collect {
tv.text = it.toString()
}
}
fab.setOnClickListener {
MainScope().launch {
dataStore.edit {