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

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

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


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

相关推荐

教你把多个视频合并成一个视频的方法

一.情况介绍当你有一个m3u8文件和一个目录,目录中有连续的视频片段,这些片段可以连成一段完整的视频。m3u8文件打开后像这样:m3u8文件,可以理解为播放列表,里面是播放视频片段的顺序。视频片段像这...

零代码编程:用kimichat合并一个文件夹下的多个文件

一个文件夹里面有很多个srt字幕文件,如何借助kimichat来自动批量合并呢?在kimichat对话框中输入提示词:你是一个Python编程专家,完成如下的编程任务:这个文件夹:D:\downloa...

Java APT_java APT 生成代码

JavaAPT(AnnotationProcessingTool)是一种在Java编译阶段处理注解的工具。APT会在编译阶段扫描源代码中的注解,并根据这些注解生成代码、资源文件或其他输出,...

Unit Runtime:一键运行 AI 生成的代码,或许将成为你的复制 + 粘贴神器

在我们构建了UnitMesh架构之后,以及对应的demo之后,便着手于实现UnitMesh架构。于是,我们就继续开始UnitRuntime,以用于直接运行AI生成的代码。PS:...

挣脱臃肿的枷锁:为什么说Vert.x是Java开发者手中的一柄利剑?

如果你是一名Java开发者,那么你的职业生涯几乎无法避开Spring。它如同一位德高望重的老国王,统治着企业级应用开发的大片疆土。SpringBoot的约定大于配置、SpringCloud的微服务...

五年后,谷歌还在全力以赴发展 Kotlin

作者|FredericLardinois译者|Sambodhi策划|Tina自2017年谷歌I/O全球开发者大会上,谷歌首次宣布将Kotlin(JetBrains开发的Ja...

kotlin和java开发哪个好,优缺点对比

Kotlin和Java都是常见的编程语言,它们有各自的优缺点。Kotlin的优点:简洁:Kotlin程序相对于Java程序更简洁,可以减少代码量。安全:Kotlin在类型系统和空值安全...

移动端架构模式全景解析:从MVC到MVVM,如何选择最佳设计方案?

掌握不同架构模式的精髓,是构建可维护、可测试且高效移动应用的关键。在移动应用开发中,选择合适的软件架构模式对项目的可维护性、可测试性和团队协作效率至关重要。随着应用复杂度的增加,一个良好的架构能够帮助...

颜值非常高的XShell替代工具Termora,不一样的使用体验!

Termora是一款面向开发者和运维人员的跨平台SSH终端与文件管理工具,支持Windows、macOS及Linux系统,通过一体化界面简化远程服务器管理流程。其核心定位是解决多平台环境下远程连接、文...

预处理的底层原理和预处理编译运行异常的解决方案

若文章对您有帮助,欢迎关注程序员小迷。助您在编程路上越走越好![Mac-10.7.1LionIntel-based]Q:预处理到底干了什么事情?A:预处理,顾名思义,预先做的处理。源代码中...

为“架构”再建个模:如何用代码描述软件架构?

在架构治理平台ArchGuard中,为了实现对架构的治理,我们需要代码+模型描述所要处理的内容和数据。所以,在ArchGuard中,我们有了代码的模型、依赖的模型、变更的模型等,剩下的两个...

深度解析:Google Gemma 3n —— 移动优先的轻量多模态大模型

2025年6月,Google正式发布了Gemma3n,这是一款能够在2GB内存环境下运行的轻量级多模态大模型。它延续了Gemma家族的开源基因,同时在架构设计上大幅优化,目标是让...

比分网开发技术栈与功能详解_比分网有哪些

一、核心功能模块一个基本的比分网通常包含以下模块:首页/总览实时比分看板:滚动展示所有正在进行的比赛,包含比分、比赛时间、红黄牌等关键信息。热门赛事/焦点战:突出显示重要的、关注度高的比赛。赛事导航...

设计模式之-生成器_一键生成设计

一、【概念定义】——“分步构建复杂对象,隐藏创建细节”生成器模式(BuilderPattern):一种“分步构建型”创建型设计模式,它将一个复杂对象的构建与其表示分离,使得同样的构建过程可以创建...

构建第一个 Kotlin Android 应用_kotlin简介

第一步:安装AndroidStudio(推荐IDE)AndroidStudio是官方推荐的Android开发集成开发环境(IDE),内置对Kotlin的完整支持。1.下载And...