在本教程中,我将向您展示如何使用数据存储首选项在 Android 应用程序中本地保存数据,而不是使用共享首选项的旧方法。
我看到很多人不知道如何使用 DataStore,他们认为这太难了,所以在这篇文章中我将解释 DataStore 中的所有内容,让您更容易使用,所以请保存这篇文章并跟我一起关注
.
什么是数据存储首选项?
DataStore 是一种数据存储解决方案,允许您使用协议缓冲区存储键值对或类型化对象。 DataStore 使用 Kotlin 协程和 Flow 以异步、一致和事务方式存储数据。
我知道你不明白上下文,但让我们现在开始吧!
在本文中,我们将创建一个简单的应用程序,它将保存用户名和电子邮件地址,这是 Github 上的项目源代码
您还可以从 github actions 下载演示应用程序以查看该应用程序的工作原理:演示应用程序
现在就开始吧
1. 在Android Studio上创建一个新项目。
2. 打开 build.gradle 文件并添加库实现:
dependencies {
// DataStore
implementation "androidx.datastore:datastore-preferences:1.0.0"
implementation "androidx.datastore:datastore-preferences-core:1.0.0"
}
3. 创建一个名为 DataStoreManager 的新类,并创建 DataStore 的 Init:
val Context.user: DataStore by preferencesDataStore(name = "userInfo")
我们需要在这里停下来了解前面的代码发生了什么。
看一下这张图片,让我们解释一下:1-这是数据存储首选项的名称,我们将使用它来对此数据存储名称执行操作。2-第二个是数据存储名称假设它就像数据库名称(例如 SQL) 我们将用这个名称来存储数据。
4. 现在让我们创建将数据保存在我们创建的数据存储中的键:
object DataStoreKeys {
val USER_NAME = stringPreferencesKey("user_name")
val EMAIL = stringPreferencesKey("email")
}
在这里,我创建了两个密钥,一个用于存储用户名,另一个用于存储电子邮件地址。
现在我们准备在我们的 Activity/Fragment 中使用 DataStore。
我创建了一个简单的应用程序,其中包含两个 EditTexts 和两个按钮以及两个将显示保存的数据的文本视图,您可以在 Github 上找到示例项目。
5. 现在打开您的 Activity 并创建一个暂停乐趣,这将保存我们的编辑文本数据:
private suspend fun saveUserData(name: String, email: String) {
user.edit { usrData ->
usrData[DataStoreKeys.USER_NAME] = name
usrData[DataStoreKeys.EMAIL] = email
}
}
等等,这是怎么回事?
首先,DataStore 仅在 suspend fun 或 CoroutineScope 内部运行,因此这就是我创建 sailed fun 的原因。
之后,我创建了我们之前通过调用声明的用户实例:
user.edit { usrData ->
}
usrData 是一个值参数,您可以选择任何名称,因为它是一个 lambda 表达式。
在 user.edit 表达式中,我添加了之前创建的用于保存姓名和电子邮件的键:
user.edit { usrData ->
usrData[DataStoreKeys.USER_NAME] = name
usrData[DataStoreKeys.EMAIL] = email
}
现在您已经成功使用 DataStore 保存数据了,是不是很简单?
6. 让我们创建一个新函数来获取保存的数据并将其显示在我们的 UI 中:
private suspend fun getUserData() {
user.data.collect { usrData ->
val name = usrData[DataStoreKeys.USER_NAME] ?: "none"
val email = usrData[DataStoreKeys.EMAIL] ?: "none"
}
}
解释:正如我们在添加用户实例之前所解释的,但是在 GetData 中,您将使用 user.data.collect 来收集保存的数据,它是否存在,如果没有保存数据,它将返回 null,这就是我添加的原因? :“none”检查数据存储是否返回null,null检查将返回“none”值。
正如我们所知,我们可以通过用于保存数据的相同键来检索数据,因此您将再次使用它来再次检索数据:
user.data.collect { usrData ->
val name = usrData[DataStoreKeys.USER_NAME] ?: "none"
val email = usrData[DataStoreKeys.EMAIL] ?: "none"
// you can use $name variable or $email anywhere
}
正如我在添加 ?: "none" 之前告诉您的那样,检查数据存储是否返回 null ,它将返回“none”而不是 null 以防止应用程序崩溃。
7. 最后一步是创建一个删除已保存数据的函数:
private suspend fun deleteUserData() {
user.edit { usrData ->
usrData.clear()
}
}
说明:很简单,只需使用 user 实例并使用 user.edit 访问 DataStore 并调用 userData.clear():
user.edit { usrData ->
usrData.clear()
}
您可以在 CoroutineScope(Dispatchers.IO) 内的 OnCreate 中使用所有这些函数,如下所示:
CoroutineScope(Dispatchers.IO).launch {
getUserData() //get data suspend fun
}
完整的MainActivity代码:
import android.annotation.SuppressLint
import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import androidx.datastore.preferences.core.edit
import co.encept.datastore.databinding.ActivityMainBinding
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
class MainActivity : AppCompatActivity() {
private lateinit var binding: ActivityMainBinding
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
binding = ActivityMainBinding.inflate(layoutInflater)
setContentView(binding.root)
binding.apply {
// Get User Data If It Exists
CoroutineScope(Dispatchers.IO).launch {
getUserData()
}
// Save User Data
btnSave.setOnClickListener {
CoroutineScope(Dispatchers.IO).launch {
saveUserData(
edName.text.toString(),
edEmail.text.toString()
)
}
}
// Delete Saved User Data
btnDelete.setOnClickListener {
CoroutineScope(Dispatchers.IO).launch {
deleteUserData()
getUserData()
}
}
}
}
private suspend fun saveUserData(name: String, email: String) {
user.edit { usrData ->
usrData[DataStoreKeys.USER_NAME] = name
usrData[DataStoreKeys.EMAIL] = email
}
// Display Data after save:
getUserData()
}
private suspend fun getUserData() {
user.data.collect { usrData ->
val name = usrData[DataStoreKeys.USER_NAME] ?: "none"
val email = usrData[DataStoreKeys.EMAIL] ?: "none"
// Display Data On UI
runOnUiThread {
binding.apply {
userName.text = "Username: $name"
txtEmail.text = "Email: $email"
}
}
}
}
private suspend fun deleteUserData() {
user.edit { usrData ->
usrData.clear()
}
// Display Data after delete:
getUserData()
}
}