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

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

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


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

相关推荐

HR必备Excel函数:4个与日期相关的计算函数。

提到日期函数,很多人首先会想到“today”,它可以显示当天的日期,并且每次打开表格时都会自动更新。但是,对于前天、昨天、明天和后天的日期,就不能用yesterday或者tomorrow等这些英文了,...

这篇文章有点长,但可以让你十分钟玩转Excel的时间函数

日期与时间函数——TODAY、NOW、YEAR、MONTH、DAY!如何用WORKDAY函数查询距离某天的第20个工作日是哪一天?如何用NETWORKDAYS函数查询员工工作了多少个工作日?如何用WE...

Excel2020年日历套装,表格设计,农历显示,查阅套打轻松应用

Hello大家好,我是帮帮。今天跟大家分享一组Excel2020年日历套装,表格设计,自带农历控件,查阅套打轻松应用。有个好消息!为了方便大家更快的掌握技巧,寻找捷径。请大家点击文章末尾的“了解更多”...

巧用NETWORKDAYS函数计算两个日期之间工作日的天数

带有日期的单元格是我们日常使用EXCEL的时候经常见到的,有的时候我们需要求出两个日期之间间隔的天数,可以直接用结束日期减去开始日期即可,这是个非常简单的减法公式。不过这个单纯的减法公式会默认去掉开始...

Excel按工作日、休息日进行汇总

1、按周六日/其它时间汇总为了区分一周的周六日和其它时间,可以使用WEEKDAY函数,把WEEKDAY函数的第2个参数指定为2,如WEEKDAY(A3,2),则周一返回1,周二返回2,…,周六返回...

如何计算每月应出勤天数,如有法定假期和调休,如何计算

本文介绍如何计算每月的应出勤天数。第一部分介绍正常双休制下计算应出勤天数;第二部份介绍当月有法定假期和调休的情况下计算应出勤天数。一、计算正常双休制的应出勤天数如下图所示,要求计算各员工2021年3月...

《Excel一键生成工作日历:让会议排期更轻松!》

每当需要安排会议时,总要翻看日历确认工作日,再逐个标注会议时间,既耗时又容易出错。今天教大家用Excel快速生成工作日历表,让会议排期变得简单高效!一、快速生成日历框架创建基础日期:在A1单元格输入月...

如何计算指定日期区间内,有多少工作日和休息日?

大家好,今天咱们要解决的问题是如何计算给定的一段日期内,正常工作日有多少天,放假时间有多少天?比如咱们要计算2025年3月份工作日一共有多少天,又有多少天放假,如下图所示:通过肉眼我们可以数清楚,20...

如何如何在表格中自动突出显示双休日?

现在不少人喜欢用Excel来制作备忘录或安排工作事项。在表格中输入日期后,可以使用条件格式突出显示双休日,避免在休息日安排了工作。具体方法是这样的:第1步:选择要设置条件格式的日期单元格区域;在“开始...

excel函数技巧:networkdays.intl判断节假日

如图,想知道6月的每一天是否是节假日,公式如下:=NETWORKDAYS.INTL(A2,A2,1,$E$2:$E$28)这个函数既可以判断当前日期(一参=二参)是否是周末及工作日(三参、四参)还可得...

仅需3步,让考勤表根据实际休息日,自动地填充颜色

Hello,大家好,之前跟大家分享了我们如何让考勤表根据单休与双休自动的填充颜色,最近有粉丝问到:能不能让考勤表根据实际的休息日自动的填充颜色呢?可以是可以,只不过因为牵扯到假期调休,我们每年的休息日...

5步搞定动态考勤表!标记节假日、调休日?Excel自动变色!

今天教你用「动态考勤表」一招解决所有问题!只需输入月份,自动变色、自动更新节假日,从此告别加班,效率翻倍!动态考勤表的优势:自动变色:节假日、双休日一键标记,颜色分明。一表多用:修改月份即可...

一起用python做个炫酷音乐播放器,想听啥随便搜

前言前段时间写的Python自制一款炫酷音乐播放器,有不少小伙伴私信我,对播放器提了不少改进建议,让我完善播放器的功能。今天音乐播放器2.0版本完成了,大家一起来看看是如何用python自制一款炫酷的...

用Python做个“冰墩墩雪容融”桌面部件(好玩又有趣)

桌面太单调?今天就带大家,一起用Python的PyQt5开发一个有趣的自定义桌面动画挂件,看看实现的动画挂件效果!下面,我们开始介绍这个自定义桌面动画挂件的制作过程。一、核心功能设计实现将动态图gif...

Python串口调试助手源码分享

以下是一个基于Python和PyQt5实现的串口调试助手示例,包含核心功能实现代码:pythonimportsysimportserialfromPyQt5.QtCoreimportQTim...