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

news2024/9/25 7:21:08

概述

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

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.coloradmin.cn/o/1533939.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Docker Compose部署YAPI

1、首先已安装mongodb 2、 使用navicat连接数据库&#xff0c;使用以下命令创建数据库&#xff1a; # 先use命令切换至yapi数据库。如果该库不存在&#xff0c;那么则会创建该数据库。 use yapi; # 创建用户&#xff0c;分配权限&#xff0c;下面会用到该用户和密码 db.…

数组实现对数组中对象中的指定项的查找并输出该条记录

文章目录 需求分析 需求 已知返回的数据如下&#xff1a;&#xff0c;现需找到指定字段的那一项并输出 分析 写一个方法就能搞定&#xff0c;代码中定义了一个名为 findDeviceByName 的函数&#xff0c;它会遍历给定的数组&#xff0c;查找其中 deviceName 字段值等于目标…

骨传导游泳耳机怎么样?四款个性能卓越的骨传导游泳耳机收录!

在游泳运动中&#xff0c;音乐是许多人不可或缺的陪伴。然而传统耳机在水下使用时常常会出现各种问题&#xff0c;比如防水性能不佳、音质下降等。随着科技的进步&#xff0c;一种新型的耳机——骨传导游泳耳机应运而生。 它不仅具备出色的防水性能&#xff0c;还能通过骨头传递…

许战海战略文库|橋頭品牌突破区域局限打透全国市场的4个建议

自宣统元年(公元1908年)起&#xff0c;重庆南岸区海棠溪古石桥边诞生了一家传奇火锅店——桥头火锅。凭借深厚的文化底蕴和独特的风味&#xff0c;历经百年沉淀桥头火锅已成为南岸区乃至中华餐饮文化中的璀璨明珠。 桥头火锅不仅荣获了“中华老字号”和“中国名菜”两项殊荣&a…

第十节HarmonyOS 常用容器组件1-Badge

1、描述 可以附加在单个组件上用于信息标记的容器组件。支持单个子组件。 2、接口 方法1&#xff1a;Badge(value:{count: number, position?: BadgePosition, maxCount?: number, style:BadgeStyle}) 方法2&#xff1a;Badge(value: {value: string, position?: BadgeP…

Jenkins安装Role-based Authorization Strategy不生效

Jenkins安装Role-based Authorization Strategy不生效&#xff0c;需开启Role-based 访问策略。 https://blog.51cto.com/zengestudy/1782494

阶乘的强悍溢出技能

【题目描述】 输入n&#xff0c;计算S&#xff1d;1&#xff01;&#xff0b;2&#xff01;&#xff0b;3&#xff01;&#xff0b;…&#xff0b;n&#xff01;的末6位&#xff08;不含前导0&#xff09;。&#xff0c;n&#xff01;表示 前n个正整数之积。 【样例输入】 …

探讨Java代码混淆加固工具

摘要 本篇博客将介绍几种常用的Java代码混淆工具&#xff0c;如ProGuard、Allatori Java Obfuscator、VirboxProtector、ipaguard和DashO。我们将深入探讨它们的特点、功能以及在保护Java应用程序安全方面的作用。此外&#xff0c;还将强调在使用Java代码混淆工具时需要注意的…

DUSt3R:简化三维重建

3D 重建是从二维 (2D) 图像创建对象或场景的 3D 虚拟表示的任务&#xff0c;可用于模拟、可视化或本地化等多种目的。 它广泛应用于计算机视觉、机器人和虚拟现实&#xff08;VR&#xff09;等多个领域。 在基本设置中&#xff0c;3D 重建方法输入一对图像 I1 和 I2&#xff0c…

安装nginx和PHP

首先规划四台虚拟机&#xff0c;之前的主从数据库已经两台&#xff0c;其余两台&#xff0c;一个设置nginx&#xff0c;一个是php 首先NGINX的概念&#xff0c;请参考https://blog.csdn.net/hyfsbxg/article/details/122322125。正向代理&#xff0c;反向代理&#xff0c;可以…

(C语言) print输出函数系列介绍

(C语言) print输出函数系列介绍 文章目录 (C语言) print输出函数系列介绍前言输出系列函数&#x1f5a8;️printf&#x1f5a8;️sprintf & snprintf&#x1f5a8;️fprintf&#x1f5a8;️vprintf&#x1f5a8;️dprintf&#x1f5a8;️puts&#x1f5a8;️fputs&#x1f…

【C语言】基本语法知识C语言函数操作符详解

主页&#xff1a;醋溜马桶圈-CSDN博客 专栏&#xff1a;C语言_醋溜马桶圈的博客-CSDN博客 gitee&#xff1a;mnxcc (mnxcc) - Gitee.com 目录 1.基本语法 1.1 代码解释 1.1.1 main()主函数 1.1.2 int 1.1.3 { } 1.1.4 printf()库函数 1.1.5 stdio.h头文件 1.2 C语言的…

js 输出负数的个数,和所有正整数的平均值。

首先输入要输入的整数个数n&#xff0c;然后输入n个整数。输出为n个整数中负数的个数&#xff0c;和所有正整数的平均值&#xff0c;结果保留一位小数。 0即不是正整数&#xff0c;也不是负数&#xff0c;不计入计算。如果没有正数&#xff0c;则平均值为0。输入 11 1 2 3 4 5 …

雷池 WAF 社区版:下一代 Web 应用防火墙的革新

黑客的挑战 智能语义分析算法&#xff1a; 黑客们常利用复杂技术进行攻击&#xff0c;但雷池社区版的智能语义分析算法能深入解析攻击本质&#xff0c;即使是最复杂的攻击手法也难以逃脱。 0day攻击防御&#xff1a; 传统防火墙难以防御未知攻击&#xff0c;但雷池社区版能有效…

Delphi7应用教程学习1.3【练习题目】:文本及悬停文字的显示

这个例子主要用到了btn的Hint 属性&#xff0c;Hint是提示的意思。 还有Delphi7还是很好用的&#xff0c;改变了的属性是粗体&#xff0c;默认没有改变的属性为细体。

项目中如何获取Java运行环境中的文件内容

业务场景&#xff1a;获取Java运行环境下的hsminfo.properties文件中&#xff0c;获取key为TESTRSAKEY的值 步骤&#xff1a; 1、获取Java运行环境的根目录&#xff0c;一般是jdk包下的jre文件&#xff1b; 2、通过File.separator拼接运行环境的根路径及目标文件的的名称&am…

SQL查询早于到期时间的数据

遇到个需求是需要查询有效的一些数据&#xff0c;所以要以到期时间作为过滤条件&#xff0c;把到期时间大于到期时间的数据返回&#xff1b; -- 查询早于当前时间 SELECT * FROM jc_tmp t WHERE t.expiration_time > now() 可以直接用 < > 即可 到期时间是now( ) …

实战纪实 | 记一次信息泄露到未授权的挖掘

目标 开局一个登录框 打点 尝试爆破&#xff0c;无望 之后查询了一下供应商的归属&#xff0c;发现是xxxx公司 去了公司官网啾啾&#xff0c;发现了一处wiki&#xff0c;不过现在修了&#xff0c;下面是修了的截图 里面翻到了很多有趣的信息 这时候我们拿到了 a / b (分别代…

漫谈5种注册中心

01 注册中心基本概念 1.1 什么是注册中心&#xff1f; 注册中心主要有三种角色&#xff1a; 服务提供者&#xff08;RPC Server&#xff09;&#xff1a;在启动时&#xff0c;向 Registry 注册自身服务&#xff0c;并向 Registry 定期发送心跳汇报存活状态。 服务消费者&…

ideaSSM博物馆网站系统VS开发mysql数据库web结构java编程计算机网页源码maven项目

一、源码特点 idea 开发 SSM 博物馆网站系统是一套完善的信息管理系统&#xff0c;结合SSM框架和bootstrap完成本系统&#xff0c;对理解JSP java编程开发语言有帮助系统采用SSM框架&#xff08;MVC模式开发&#xff09;&#xff0c;系统具有完整的源代码和数据库&#xff0c…