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

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

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


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

相关推荐

驱动网卡(怎么从新驱动网卡)
驱动网卡(怎么从新驱动网卡)

网卡一般是指为电脑主机提供有线无线网络功能的适配器。而网卡驱动指的就是电脑连接识别这些网卡型号的桥梁。网卡只有打上了网卡驱动才能正常使用。并不是说所有的网卡一插到电脑上面就能进行数据传输了,他都需要里面芯片组的驱动文件才能支持他进行数据传输...

2026-01-30 00:37 liuian

win10更新助手装系统(微软win10更新助手)

1、点击首页“系统升级”的按钮,给出弹框,告诉用户需要上传IMEI码才能使用升级服务。同时给出同意和取消按钮。华为手机助手2、点击同意,则进入到“系统升级”功能华为手机助手华为手机助手3、在检测界面,...

windows11专业版密钥最新(windows11专业版激活码永久)

 Windows11专业版的正版密钥,我们是对windows的激活所必备的工具。该密钥我们可以通过微软商城或者通过计算机的硬件供应商去购买获得。获得了windows11专业版的正版密钥后,我...

手机删过的软件恢复(手机删除过的软件怎么恢复)
手机删过的软件恢复(手机删除过的软件怎么恢复)

操作步骤:1、首先,我们需要先打开手机。然后在许多图标中找到带有[文件管理]文本的图标,然后单击“文件管理”进入页面。2、进入页面后,我们将在顶部看到一行文本:手机,最新信息,文档,视频,图片,音乐,收藏,最后是我们正在寻找的[更多],单击...

2026-01-29 23:55 liuian

一键ghost手动备份系统步骤(一键ghost 备份)

  步骤1、首先把装有一键GHOST装系统的U盘插在电脑上,然后打开电脑马上按F2或DEL键入BIOS界面,然后就选择BOOT打USDHDD模式选择好,然后按F10键保存,电脑就会马上重启。  步骤...

怎么创建局域网(怎么创建局域网打游戏)

  1、购买路由器一台。进入路由器把dhcp功能打开  2、购买一台交换机。从路由器lan端口拉出一条网线查到交换机的任意一个端口上。  3、两台以上电脑。从交换机任意端口拉出网线插到电脑上(电脑设置...

精灵驱动器官方下载(精灵驱动手机版下载)

是的。驱动精灵是一款集驱动管理和硬件检测于一体的、专业级的驱动管理和维护工具。驱动精灵为用户提供驱动备份、恢复、安装、删除、在线更新等实用功能。1、全新驱动精灵2012引擎,大幅提升硬件和驱动辨识能力...

一键还原系统步骤(一键还原系统有哪些)

1、首先需要下载安装一下Windows一键还原程序,在安装程序窗口中,点击“下一步”,弹出“用户许可协议”窗口,选择“我同意该许可协议的条款”,并点击“下一步”。  2、在弹出的“准备安装”窗口中,可...

电脑加速器哪个好(电脑加速器哪款好)

我认为pp加速器最好用,飞速土豆太懒,急速酷六根本不工作。pp加速器什么网页都加速,太任劳任怨了!以上是个人观点,具体性能请自己试。ps:我家电脑性能很好。迅游加速盒子是可以加速电脑的。因为有过之...

任何u盘都可以做启动盘吗(u盘必须做成启动盘才能装系统吗)

是的,需要注意,U盘的大小要在4G以上,最好是8G以上,因为启动盘里面需要装系统,内存小的话,不能用来安装系统。内存卡或者U盘或者移动硬盘都可以用来做启动盘安装系统。普通的U盘就可以,不过最好U盘...

u盘怎么恢复文件(u盘文件恢复的方法)

开360安全卫士,点击上面的“功能大全”。点击文件恢复然后点击“数据”下的“文件恢复”功能。选择驱动接着选择需要恢复的驱动,选择接入的U盘。点击开始扫描选好就点击中间的“开始扫描”,开始扫描U盘数据。...

系统虚拟内存太低怎么办(系统虚拟内存占用过高什么原因)

1.检查系统虚拟内存使用情况,如果发现有大量的空闲内存,可以尝试释放一些不必要的进程,以释放内存空间。2.如果系统虚拟内存使用率较高,可以尝试增加系统虚拟内存的大小,以便更多的应用程序可以使用更多...

剪贴板权限设置方法(剪贴板访问权限)
剪贴板权限设置方法(剪贴板访问权限)

1、首先打开iphone手机,触碰并按住单词或图像直到显示选择选项。2、其次,然后选取“拷贝”或“剪贴板”。3、勾选需要的“权限”,最后选择开启,即可完成苹果剪贴板权限设置。仅参考1.打开苹果手机设置按钮,点击【通用】。2.点击【键盘】,再...

2026-01-29 21:37 liuian

平板系统重装大师(平板重装win系统)

如果你的平板开不了机,但可以连接上电脑,那就能好办,楼主下载安装个平板刷机王到你的个人电脑上,然后连接你的平板,平板刷机王会自动识别你的平板,平板刷机王上有你平板的我刷机包,楼主点击下载一个,下载完成...

联想官网售后服务网点(联想官网售后服务热线)

联想3c服务中心是联想旗下的官方售后,是基于互联网O2O模式开发的全新服务平台。可以为终端用户提供多品牌手机、电脑以及其他3C类产品的维修、保养和保险服务。根据客户需求层次,联想服务针对个人及家庭客户...