【鸿蒙HarmonyOS开发笔记】应用数据持久化之通过用户首选项实现数据持久化

概述

应用数据持久化,是指应用将内存中的数据通过文件或数据库的形式保存到设备上。内存中的数据形态通常是任意的数据结构或数据对象,存储介质上的数据形态可能是文本、数据库、二进制文件等。

HarmonyOS标准系统支持典型的存储数据形态,包括用户首选项键值型数据库关系型数据库

开发者可以根据如下功能介绍,选择合适的数据形态以满足自己应用数据的持久化需要。

用户首选项(Preferences):通常用于保存应用的配置信息。数据通过文本的形式保存在设备中,应用使用过程中会将文本中的数据全量加载到内存中,所以访问速度快、效率高,但不适合需要存储大量数据的场景。

键值型数据库(KV-Store):一种非关系型数据库,其数据以“键值”对的形式进行组织、索引和存储,其中“键”作为唯一标识符。适合很少数据关系和业务关系的业务数据存储,同时因其在分布式场景中降低了解决数据库版本兼容问题的复杂度,和数据同步过程中冲突解决的复杂度而被广泛使用。相比于关系型数据库,更容易做到跨设备跨版本兼容。

关系型数据库(RelationalStore):一种关系型数据库,以行和列的形式存储数据,广泛用于应用中的关系型数据的处理,包括一系列的增、删、改、查等接口,开发者也可以运行自己定义的SQL语句来满足复杂业务场景的需要。


通过用户首选项实现数据持久化

场景介绍

用户首选项为应用提供Key-Value键值型的数据处理能力,支持应用持久化轻量级数据,并对其修改和查询。当用户希望有一个全局唯一存储的地方,可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中,当用户读取的时候,能够快速从内存中获取数据,当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。Preferences会随着存放的数据量越多而导致应用占用的内存越大,因此,Preferences不适合存放过多的数据,适用的场景一般为应用保存用户的个性化设置(字体大小,是否开启夜间模式)等。

运作机制
如图所示,用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开发者可以将用户首选项持久化文件的内容加载到Preferences实例,每个文件唯一对应到一个Preferences实例,系统会通过静态容器将该实例存储在内存中,直到主动从内存中移除该实例或者删除该文件。

应用首选项的持久化文件保存在应用沙箱内部,可以通过context获取其路径。

在这里插入图片描述


约束限制
Key键为string类型,要求非空且长度不超过80个字节。
如果Value值为string类型,可以为空,不为空时长度不超过8192个字节。
内存会随着存储数据量的增大而增大,所以存储的数据量应该是轻量级的,建议存储的数据不超过一万条,否则会在内存方面产生较大的开销。


接口说明

以下是用户首选项持久化功能的相关接口,大部分为异步接口。异步接口均有callbackPromise两种返回形式,下均以Promise形式为例


导入模块

import dataPreferences from '@ohos.data.preferences';

dataPreferences.getPreferences

获取Preferences实例,使用Promise异步回调。

getPreferences(context: Context, name: string): Promise<Preferences>

参数说明

context:Stage模型的应用Context

name: Preferences实例的名称

返回值

Promise<Preferences>Promise对象,返回Preferences实例。

示例

import UIAbility from '@ohos.app.ability.UIAbility';let preferences = null;class EntryAbility extends UIAbility {onWindowStageCreate(windowStage) {try {let promise = dataPreferences.getPreferences(this.context, 'mystore');promise.then((object) => {preferences = object;console.info("Succeeded in getting preferences.");}).catch((err) => {console.error("Failed to get preferences. code =" + err.code + ", message =" + err.message);})} catch(err) {console.error("Failed to get preferences. code =" + err.code + ", message =" + err.message);}}
}

dataPreferences.deletePreferences

从内存中移除指定的Preferences实例,使用Promise异步回调。

Preferences实例有对应的持久化文件,则同时删除其持久化文件。

调用该接口后,应用不允许再使用该Preferences实例进行数据操作,否则会出现数据一致性问题。

deletePreferences(context: Context, name: string): Promise<void>

参数说明

context:Stage模型的应用Context

name: Preferences实例的名称

返回值

Promise<Preferences>Promise对象,返回Preferences实例。

示例

import UIAbility from '@ohos.app.ability.UIAbility';
class EntryAbility extends UIAbility {onWindowStageCreate(windowStage) {try{let promise = dataPreferences.deletePreferences(this.context, 'mystore');promise.then(() => {console.info("Succeeded in deleting preferences.");}).catch((err) => {console.error("Failed to delete preferences. code =" + err.code + ", message =" + err.message);})} catch(err) {console.error("Failed to delete preferences. code =" + err.code + ", message =" + err.message);}}
}

Preferences

存储实例,提供获取和修改存储数据的接口。

下列接口都需先使用data_preferences.getPreferences获取到Preferences实例,再通过此实例调用对应接口。


get

get(key: string, defValue: ValueType): Promise<ValueType>

获取键对应的值,如果值为null或者非默认值类型,返回默认数据defValue,使用Promise异步回调。

参数说明

key:要获取的存储Key名称,不能为空。

defValue: 默认返回值。支持number、string、boolean、Array<number>、Array<string>、Array<boolean>类型。

返回值

Promise<Preferences>Promise对象,返回键对应的值

示例:

try {let promise = preferences.get('startup', 'default');promise.then((data) => {console.info("Succeeded in getting value of 'startup'. Data: " + data);}).catch((err) => {console.error("Failed to get value of 'startup'. code =" + err.code + ", message =" + err.message);})
} catch(err) {console.error("Failed to get value of 'startup'. code =" + err.code + ", message =" + err.message);
}

put

put(key: string, value: ValueType): Promise<void>

将数据写入Preferences实例,可通过flushPreferences实例持久化,使用Promise异步回调。

参数说明

key:要修改的存储的Key,不能为空。

value: 存储的新值。支持number、string、boolean、Array<number>、Array<string>、Array<boolean>类型。

返回值

Promise<Preferences>:无返回结果的Promise对象。

示例:

try {let promise = preferences.put('startup', 'auto');promise.then(() => {console.info("Succeeded in putting value of 'startup'.");}).catch((err) => {console.error("Failed to put value of 'startup'. code =" + err.code +", message =" + err.message);})
} catch(err) {console.error("Failed to put value of 'startup'. code =" + err.code +", message =" + err.message);
}

has

has(key: string): Promise<boolean>

检查Preferences实例是否包含名为给定Key的存储键值对,使用Promise异步回调。

参数说明

key:要检查的存储key名称,不能为空。

返回值

Promise<Preferences>Promise对象。返回Preferences实例是否包含给定key的存储键值对,true表示存在,false表示不存在。

示例:

try {let promise = preferences.has('startup');promise.then((val) => {if (val) {console.info("The key 'startup' is contained.");} else {console.info("The key 'startup' dose not contain.");}}).catch((err) => {console.error("Failed to check the key 'startup'. code =" + err.code + ", message =" + err.message);})
} catch(err) {console.error("Failed to check the key 'startup'. code =" + err.code + ", message =" + err.message);
}

delete

delete(key: string): Promise<void>

Preferences实例中删除名为给定Key的存储键值对,使用Promise异步回调。

参数说明

key: 要删除的存储key名称,不能为空。

返回值

Promise<Preferences>:无返回结果的Promise对象。

示例:

try {let promise = preferences.delete('startup');promise.then(() => {console.info("Succeeded in deleting the key 'startup'.");}).catch((err) => {console.error("Failed to delete the key 'startup'. code =" + err.code +", message =" + err.message);})
} catch(err) {console.error("Failed to delete the key 'startup'. code =" + err.code +", message =" + err.message);
}

flush

flush(): Promise<void>

将当前Preferences实例的数据异步存储到用户首选项的持久化文件中,使用Promise异步回调。

参数说明

返回值

Promise<Preferences>:无返回结果的Promise对象。

示例:

try {let promise = preferences.flush();promise.then(() => {console.info("Succeeded in flushing.");}).catch((err) => {console.error("Failed to flush. code =" + err.code + ", message =" + err.message);})
} catch (err) {console.error("Failed to flush. code =" + err.code + ", message =" + err.message);
}

clear

clear(callback: AsyncCallback<void>): void

清除此·Preferences·实例中的所有存储,使用·Promise·异步回调。

参数说明

返回值

Promise<Preferences>:无返回结果的Promise对象。

示例:

try {let promise = preferences.clear();promise.then(() => {console.info("Succeeded in clearing.");}).catch((err) => {console.error("Failed to clear. code =" + err.code + ", message =" + err.message);})
} catch(err) {console.error("Failed to clear. code =" + err.code + ", message =" + err.message);
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.rhkb.cn/news/280974.html

如若内容造成侵权/违法违规/事实不符,请联系长河编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

如何配置VS Code环境

一、下载 Visual Studio Code - Code Editing. Redefined 二、傻瓜式安装 如果出现没有安装路径选择&#xff0c;则看下面图片 经过上面操作后&#xff0c;可以修改路径 三、按照下面步骤配置环境变量即可 Visual Studio Code 中的 C 和 MinGW-w64 入门

信雅纳400/800G网络测试仪之 CDF/ Extended Payload 功能:完全用户自定义的协议报文支持/可编程的协议内容支持

Note# 2024-3-21 今天被一个做芯片测试的客户追着问&#xff0c;应该合作在测试仪上做完全自定义的报文&#xff0c;添加自己的私有协议进去&#xff0c;他觉得每次都导入报头太麻烦了&#xff0c;然后就看了下Application Note关于CDF功能的描述&#xff0c;照着机翻的版本来…

D55125ADA A型漏电保护芯片,适用于 110V⁓220V(50/60Hz)电压,可应用于 新能源充电桩(充电枪)、智能空开(智能微断开关)等工业产品

一、应用领域 新能源充电桩&#xff08;充电枪&#xff09;、智能空开&#xff08;智能微断开关&#xff09;等工业产品&#xff0c;以及电热水器、电烤箱、电烤炉等小家电产品。 二、功能介绍 D55125ADA 是一款高性能 CMOS 漏电保护器专用电路。芯片内部包含稳压电源、放大电路…

IP 协议的相关特性

1.IP协议的特性 无连接性。IP协议是一种无连接协议&#xff0c;这意味着数据包在传输过程中不需要保留连接状态信息。每个数据包都是独立发送和处理的&#xff0c;每个包都可以按不同的路径传输到目的地。 不可靠性。IP协议不提供任何可靠性保证&#xff0c;数据包在传输过程…

设计模式 模板方法模式

01.如果接到一个任务&#xff0c;要求设计不同型号的悍马车 02.设计一个悍马车的抽象类&#xff08;模具&#xff0c;车模&#xff09; public abstract class HummerModel {/** 首先&#xff0c;这个模型要能够被发动起来&#xff0c;别管是手摇发动&#xff0c;还是电力发动…

鸿蒙Harmony应用开发—ArkTS-全局UI方法(列表选择弹窗)

列表弹窗。 说明&#xff1a; 从API Version 8开始支持。后续版本如有新增内容&#xff0c;则采用上角标单独标记该内容的起始版本。 本模块功能依赖UI的执行上下文&#xff0c;不可在UI上下文不明确的地方使用&#xff0c;参见UIContext说明。 从API version 10开始&#xff0…

什么是VR应急预案演练虚拟化|VR体验馆加盟|元宇宙文旅

VR 应急预案演练虚拟化指的是利用虚拟现实&#xff08;Virtual Reality&#xff0c;VR&#xff09;技术进行应急预案演练的过程。在传统的应急预案演练中&#xff0c;人们通常需要在实际场地或模拟环境中进行演练&#xff0c;这可能存在一些限制&#xff0c;如成本高昂、场地受…

C语言每日一题06

一、题目 二、解析 void main &#xff08;&#xff09; { char c1&#xff0c;c2&#xff1b; int a1&#xff0c;a2&#xff1b; c1 getchar &#xff08;&#xff09;&#xff1b;//读取第一个输入&#xff0c;c11 scanf &#xff08;“%3d”&#xff0c;&a1&#xff…

MNN createSession 之创建流水线后端(四)

系列文章目录 MNN createFromBuffer&#xff08;一&#xff09; MNN createRuntime&#xff08;二&#xff09; MNN createSession 之 Schedule&#xff08;三&#xff09; MNN createSession 之创建流水线后端&#xff08;四&#xff09; MNN Session 之维度计算&#xff08;五…

CSS学习(2)-盒子模型

1. CSS 长度单位 px &#xff1a;像素。em &#xff1a;相对元素 font-size 的倍数。rem &#xff1a;相对根字体大小&#xff0c;html标签就是根。% &#xff1a;相对父元素计算。 注意&#xff1a; CSS 中设置长度&#xff0c;必须加单位&#xff0c;否则样式无效&#xff…

19---时钟电路设计

视频链接 时钟硬件电路设计01_哔哩哔哩_bilibili 时钟电路设计 晶振是数字电路的心脏&#xff0c;数字电路需要一个稳定的工作时钟信号&#xff0c;时钟电路至关重要&#xff01; 1、晶振概述 晶振一般指晶体振荡器。晶体振荡器是指从一块石英晶体上按一定方位角切下薄片&…

python课后习题一

题目&#xff1a; 1. 2. 解题过程&#xff1a; 1. """计算年数和天数""" minute int(input("请输入分钟数&#xff1a;")) hours minute // 60 days hours // 24 years days // 365 last_days days % 365 print(f"{minut…

kafka集群介绍及搭建

介绍 kafka是一个高性能、低延迟、分布式的消息传递系统&#xff0c;特点在于实时处理数据。集群由多个成员节点broker组成&#xff0c;每个节点都可以独立处理消息传递和存储任务。 路由策略 发布消息由key、value组成&#xff0c;真正的消息是value&#xff0c;key是标识路…

使用Pygame做一个乒乓球游戏

项目介绍 使用Pygame做一个乒乓球游戏。左侧为电脑&#xff0c;右侧为玩家。 视频地址-YT 视频搬运-B站 视频教程约90分钟。 代码地址 环境&#xff1a;需要pygame库&#xff0c;可用pip安装&#xff1a;pip install pygame 1. 基础版本 首先进行一些初始化&#xff0c;初始…

PHP全新美化广告横幅在线制作源码

源码简介 可以做网站的引流不需要安装上传就可以使用&#xff0c;在第一版基础上做了二次开发更加好用 注意&#xff1a;主机和服务器均可架设搭建,如果使用宝塔架设点击访问的时候提示找不到文件路径的时候,记得点击网站目录把防跨站攻击先关闭,这样就可以正常访问了,这款是…

海格里斯HEGERLS托盘搬运机器人四向车引领三维空间集群设备柔性运维

随着市场的不断迅猛发展变化&#xff0c;在物流仓储中&#xff0c;无论是国内还是海外&#xff0c;都对托盘式解决方案需求量很大。顾名思义&#xff0c;托盘式解决方案简单理解就是将产品放置在托盘上进行存储、搬运和拣选。 面对托盘式方案需求&#xff0c;行业中常见的方案是…

如何在CentOS搭建docker compose ui可视化工具并无公网IP远程管理容器

&#x1f49d;&#x1f49d;&#x1f49d;欢迎来到我的博客&#xff0c;很高兴能够在这里和您见面&#xff01;希望您在这里可以感受到一份轻松愉快的氛围&#xff0c;不仅可以获得有趣的内容和知识&#xff0c;也可以畅所欲言、分享您的想法和见解。 推荐:kwan 的首页,持续学…

【C++ leetcode】双指针问题(续)

3. 202 .快乐数 题目 编写一个算法来判断一个数 n 是不是快乐数。 「快乐数」 定义为&#xff1a; 对于一个正整数&#xff0c;每一次将该数替换为它每个位置上的数字的平方和。然后重复这个过程直到这个数变为 1&#xff0c;也可能是 无限循环 但始终变不到 1。如果这个过程 结…

node.js快速入门-day03

个人名片&#xff1a; &#x1f60a;作者简介&#xff1a;一名大二在校生 &#x1f921; 个人主页&#xff1a;坠入暮云间x &#x1f43c;座右铭&#xff1a;给自己一个梦想&#xff0c;给世界一个惊喜。 &#x1f385;**学习目标: 坚持每一次的学习打卡 文章目录 web服务器创建…

JavaScript高级(十三)---ES6中Set,map

ES6 Set 在ES6之前&#xff0c;我们存储数据的结构主要有两种&#xff1a;数组、对象。 在ES6中新增了另外两种数据结构&#xff1a;Set、Map&#xff0c;以及它们的另外形式WeakSet、WeakMap。 Set是一个新增的数据结构&#xff0c;可以用来保存数据&#xff0c;类似于数组&a…