百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

如何使用 Kotlin 在 Android 应用程序中使用 DataStore 首选项

liuian 2025-04-01 19:46 90 浏览


在本教程中,我将向您展示如何使用数据存储首选项在 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()
    }
}

相关推荐

系统引导启动项怎么设置(系统引导按哪个键)

如果您想在计算机启动时添加系统启动引导选项,可以按照以下步骤进行操作:1.打开“运行”窗口,可以通过快捷键Win+R打开“运行”窗口。2.在“运行”窗口中输入“msconfig”命令,并点击“...

win10录屏快捷键ctrl+alt+(win10录屏功能快捷键)

答,笔记本电脑录屏快捷键是ctrl+alt+s。绝大多数人录制屏幕时,第一个想到的就是电脑自带的录屏功能,比较的方便快捷。这种方法运用起来时非常简单的,只需在键盘上同时按下“ctrl+alt+s”键就...

壁纸下载(壁纸下载安装)

回答如下:要下载电视屏保相册,您需要先找到适用于您的电视的屏保应用程序。这些应用程序可能会根据您的电视品牌和型号而有所不同,您可以在电视的应用商店中搜索或查看电视制造商的网站以获取更多信息。一旦您找到...

木马病毒下载安装(木马病毒下载安装不实名认证)

现在1,你自己机器上下载个杀毒软件,安装之后不要删除安装包2,运行杀毒软件3,插入优盘,杀毒软件会自动扫描优盘发现病毒然后提示你4,选择处理/杀毒/清理这些字样5,把杀毒软件安装包复制到优盘6,右键优...

免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
  • 免费清理软件哪个最好最快(免费好用的清理垃圾软件)
手机cdr转jpg最简单的方法(手机cdr转换jpg)

cdr文件怎么转换成jpg,快来看下操作方法吧。方法/步骤1、打开电脑中的cdr软件,点击文件,打开,打开需要转换格式的cdr文件。2、点击菜单栏的文件,导出。3、打开导出对话框选择保存文件路径。4、...

xp永久激活工具(xp永久激活码)

如果你需要重置XP的激活器,你需要先打开“开始”菜单,然后选择“运行”。在运行对话框中,输入“regedit”,然后按回车键。这会打开注册表编辑器。在编辑器中,使用左侧面板来导航到“HKEY_LOCA...

cad2008激活序列号(激活cad的序列号)

1.首先运行“AutoCAD2008安装包”中的“Setup.exe”安装AutoCAD2008,安装过程需要十分钟左右;2.第一次运行AutoCAD2008时,请在注册界面输入序列号666-9...

自己可以重装电脑系统么(可以自己重装系统吗)

电脑自身也可以重装系统。1.电脑是一个可编程的设备,通过特定的步骤和操作,用户可以自行进行系统重装。2.重装系统的过程包括备份重要数据、获取系统安装介质、重新启动电脑进入安装界面、按照指引选择系统...

win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
  • win11免费下载(win11正式版下载)
qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
  • qq邮箱在哪里找账号(qq邮箱账号在qq里怎么找)
苹果处理器性能排行(苹果处理器性能排行榜平板)

1、截止至最新的iPhoneXS上搭载的A12,从iPhone4首次搭载A4处理器开始,目前已经有9代的苹果A系列处理器;2、A4是一颗45nm制程的ARMCortex-A8的单核心处理器,GP...

苹果手机怎么录屏(苹果手机怎么录屏在哪里打开)

iPhone手机的屏幕录制功能需要在设置里面进行添加,添加成功之后,就可以使用录屏功能了。点击控制中心进入iPhone手机的设置,来到设置之后,找到控制中心选项并点击。点击加号添加录屏功能来到控制中心...

电脑怎么打开系统还原(电脑怎么开启系统还原的功能)

右键此电脑,属性,系统保护,配置,勾选启用系统保护,确定,创建,输入还原点描述,点击创建,系统提示已成功创建还原点,点击关闭,当需要还原的时候,点击上面的系统还原,选择需要还原的节点,点击完成,即可开...

ghost系统下载xp(非ghostxp下载)

蒲公英系统网站能下载。下载后缀为gho的xp系统,使用体验非常棒效果非常好。以上信息根据美国华盛顿操作系统邮报最新消息显示。不能装钉钉的。在WindowsXP系统上是不能安装钉钉来上网课的。要使用钉...