当前位置： 首页 > news >正文

鸿蒙开发接口数据管理：【@ohos.data.preferences (首选项)】

news 来源：原创 2024/7/5 2:24:23

首选项

首选项为应用提供key-value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型。

说明：  本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

常量

系统能力：  以下各项对应的系统能力均为SystemCapability.DistributedDataManager.Preferences.Core

名称参数类型可读可写说明
MAX_KEY_LENGTHstring是否key的最大长度限制，需小于80字节。
MAX_VALUE_LENGTHstring是否value的最大长度限制，需小于8192字节。

data_preferences.getPreferences

getPreferences(context: Context, name: string, callback: AsyncCallback): void

读取指定首选项持久化文件，将数据加载到Preferences实例，用于数据操作，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
context[Context]是应用程序或功能的上下文。
namestring是应用程序内部数据存储名称。
callbackAsyncCallback<[Preferences]>是回调函数。

示例：

data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {if (err) {console.info("Get preferences failed.")return;}console.info("Get preferences successfully.")
})

data_preferences.getPreferences

getPreferences(context: Context, name: string): Promise

读取指定首选项持久化文件，将数据加载到Preferences实例，用于数据操作，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
context[Context]是应用程序或功能的上下文。
namestring是应用程序内部数据存储名称。

返回值：

类型说明
Promise<[Preferences]>Promise实例，用于异步获取结果。

示例：

let promise = data_preferences.getPreferences(this.context, 'mystore')
promise.then((preferences) => {console.info("Get preferences successfully.")
}).catch((err) => {console.info("Get preferences failed.")
})

data_preferences.deletePreferences

deletePreferences(context: Context, name: string, callback: AsyncCallback): void

从内存中移除指定首选项持久化文件对应的Preferences单实例，并删除指定文件及其备份文件和损坏文件。 删除指定首选项持久化文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
context[Context]是应用程序或功能的上下文。
namestring是应用程序内部数据存储名称。
callbackAsyncCallback是回调函数。

示例：

data_preferences.deletePreferences(this.context, 'mystore', function (err) {if (err) {console.info("Deleted preferences failed, err: " + err)return}console.info("Deleted preferences successfully.")
})

data_preferences.deletePreferences

deletePreferences(context: Context, name: string): Promise

从内存中移除指定首选项持久化文件对应的Preferences单实例，并删除指定文件及其备份文件和损坏文件。 删除指定首选项持久化文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
context[Context]是应用程序或功能的上下文。
namestring是应用程序内部数据存储名称。

返回值：

类型说明
PromisePromise实例，用于异步获取结果。

示例：

let promise = data_preferences.deletePreferences(this.context, 'mystore')
promise.then(() => {console.info("Deleted preferences successfully.")
}).catch((err) => {console.info("Deleted preferences failed, err: " + err)
})

data_preferences.removePreferencesFromCache

removePreferencesFromCache(context: Context, name: string, callback: AsyncCallback): void

从内存中移除指定首选项持久化文件对应的Preferences单实例。

移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
context[Context]是应用程序或功能的上下文。
namestring是应用程序内部数据存储名称。
callbackAsyncCallback是回调函数。

示例：

data_preferences.removePreferencesFromCache(this.context, 'mystore', function (err) {if (err) {console.info("Removed preferences from cache failed, err: " + err)return}console.info("Removed preferences from cache successfully.")
})

data_preferences.removePreferencesFromCache

removePreferencesFromCache(context: Context, name: string): Promise

从内存中移除指定首选项持久化文件对应的Preferences单实例。

移除Preferences单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
context[Context]是应用程序或功能的上下文。
namestring是应用程序内部数据存储名称。

返回值：

类型说明
PromisePromise实例，用于异步获取结果。

示例：

let promise = data_preferences.removePreferencesFromCache(this.context, 'mystore')
promise.then(() => {console.info("Removed preferences from cache successfully.")
}).catch((err) => {console.info("Removed preferences from cache failed, err: " + err)
})

Preferences

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

get

get(key: string, defValue: ValueType, callback: AsyncCallback): void

获取键对应的值，如果值为null或者非默认值类型，返回默认数据，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要获取的存储key名称，不能为空。
defValue[ValueType]是默认返回值。支持number、string、boolean。
callbackAsyncCallback是回调函数。

示例：

preferences.get('startup', 'default', function(err, value) {if (err) {console.info("Get value of startup failed, err: " + err)return}console.info("Get value of startup is " + value)
})

get

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

获取键对应的值，如果值为null或者非默认值类型，返回默认数据，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

  • 参数：

    参数名类型必填说明
    keystring是要获取的存储key名称，不能为空。
    defValue[ValueType]是默认返回值。支持number、string、boolean。

返回值：

类型说明
PromisePromise实例，用于异步获取结果。

示例：

let promise = preferences.get('startup', 'default')
promise.then((value) => {console.info("Get value of startup is " + value)
}).catch((err) => {console.info("Get value of startup failed, err: " + err)
})

getAll

getAll(callback: AsyncCallback): void;

返回含有所有键值的Object对象。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调函数。返回含有所有键值的Object对象。

示例：

preferences.getAll(function (err, value) {if (err) {console.info("getAll failed, err: " + err)return}let keys = Object.keys(value)console.info('getAll keys = ' + keys)console.info("getAll object = " + JSON.stringify(value))
});

getAll

getAll(): Promise

返回含有所有键值的Object对象。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

返回值：

类型说明
PromisePromise对象。返回含有所有键值的Object对象。

示例：

let promise = preferences.getAll()
promise.then((value) => {let keys = Object.keys(value)console.info('getAll keys = ' + keys)console.info("getAll object = " + JSON.stringify(value))
}).catch((err) => {console.info("getAll failed, err: " + err)
})

put

put(key: string, value: ValueType, callback: AsyncCallback): void

首先获取指定首选项持久化文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要修改的存储的key，不能为空。
value[ValueType]是存储的新值。支持number、string、boolean。
callbackAsyncCallback是回调函数。

示例：

preferences.put('startup', 'auto', function (err) {if (err) {console.info("Put value of startup failed, err: " + err)return}console.info("Put value of startup successfully.")
})

put

put(key: string, value: ValueType): Promise

首先获取指定首选项持久化文件对应的Preferences实例，然后借助Preferences API将数据写入Preferences实例，通过flush或者flushSync将Preferences实例持久化，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要修改的存储的key，不能为空。
value[ValueType]是存储的新值。支持number、string、boolean。

返回值：

类型说明
PromisePromise实例，用于异步处理。

示例：

let promise = preferences.put('startup', 'auto')
promise.then(() => {console.info("Put value of startup successfully.")
}).catch((err) => {console.info("Put value of startup failed, err: " + err)
})

has

has(key: string, callback: AsyncCallback): void

检查存储对象是否包含名为给定key的存储键值对，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要检查的存储key名称，不能为空。
callbackAsyncCallback是回调函数。返回存储对象是否包含给定key的存储键值对，true表示存在，false表示不存在。

示例：

preferences.has('startup', function (err, isExist) {if (err) {console.info("Check the key of startup failed, err: " + err)return}if (isExist) {console.info("The key of startup is contained.")} else {console.info("The key of startup dose not contain.")}
})

has

has(key: string): Promise

检查存储对象是否包含名为给定key的存储键值对，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要检查的存储key名称，不能为空。

返回值：

类型说明
PromisePromise对象。返回存储对象是否包含给定key的存储键值对，true表示存在，false表示不存在。

示例：

let promise = preferences.has('startup')
promise.then((isExist) => {if (isExist) {console.info("The key of startup is contained.")} else {console.info("The key of startup dose not contain.")}
}).catch((err) => {console.info("Check the key of startup failed, err: " + err)
})

delete

delete(key: string, callback: AsyncCallback): void

从存储对象中删除名为给定key的存储键值对，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要删除的存储key名称，不能为空。
callbackAsyncCallback是回调函数。

示例：

preferences.delete('startup', function (err) {if (err) {console.info("Delete startup key failed, err: " + err)return}console.info("Deleted startup key successfully.")
})

delete

delete(key: string): Promise

从存储对象删除名为给定key的存储键值对，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
keystring是要删除的存储key名称，不能为空。

返回值：

类型说明
PromisePromise实例，用于异步处理。

示例：

let promise = preferences.delete('startup')
promise.then(() => {console.info("Deleted startup key successfully.")
}).catch((err) => {console.info("Delete startup key failed, err: " + err)
})

flush

flush(callback: AsyncCallback): void

将当前preferences对象中的修改保存到当前的preferences，并异步存储到首选项持久化文件中，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调函数。

示例：

preferences.flush(function (err) {if (err) {console.info("Flush to file failed, err: " + err)return}console.info("Flushed to file successfully.")
})

flush

flush(): Promise

将当前preferences对象中的修改保存到当前的preferences，并异步存储到首选项持久化文件中，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

返回值：

类型说明
PromisePromise实例，用于异步处理。

示例：

let promise = preferences.flush()
promise.then(() => {console.info("Flushed to file successfully.")
}).catch((err) => {console.info("Flush to file failed, err: " + err)
})

clear

clear(callback: AsyncCallback): void

清除此存储对象中的所有存储，该方法使用callback方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
callbackAsyncCallback是回调函数。

示例：

preferences.clear(function (err) {if (err) {console.info("Clear to file failed, err: " + err)return}console.info("Cleared to file successfully.")
})

clear

clear(): Promise

清除此存储对象中的所有存储，该方法使用Promise方式作为异步方法。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

返回值：

类型说明
PromisePromise实例，用于异步处理。

示例：

let promise = preferences.clear()
promise.then(() => {console.info("Cleared to file successfully.")
}).catch((err) => {console.info("Clear to file failed, err: " + err)
})

on(‘change’)

on(type: ‘change’, callback: Callback<{ key : string }>): void

订阅数据变更者类，订阅的key的值发生变更后，在执行flush方法后，callback方法会被回调。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
typestring是事件类型，固定值’change’，表示数据变更。
callbackCallback<{ key : string }>是回调对象实例。

示例：

data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {if (err) {console.info("Get preferences failed.")return;}var observer = function (key) {console.info("The key of " + key + " changed.")}preferences.on('change', observer)preferences.put('startup', 'auto', function (err) {if (err) {console.info("Put the value of startup failed, err: " + err)return}console.info("Put the value of startup successfully.")preferences.flush(function (err) {if (err) {console.info("Flush to file failed, err: " + err)return}console.info("Flushed to file successfully.") // observer will be called.})})
})

off(‘change’)

off(type: ‘change’, callback?: Callback<{ key : string }>): void

当不再进行订阅数据变更时，使用此接口取消订阅。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

参数：

参数名类型必填说明
typestring是事件类型，固定值’change’，表示数据变更。
callbackCallback<{ key : string }>否需要取消的回调对象实例，不填则全部取消。

示例：

data_preferences.getPreferences(this.context, 'mystore', function (err, preferences) {if (err) {console.info("Get preferences failed.")return;}var observer = function (key) {console.info("The key of " + key + " changed.")}preferences.on('change', observer)preferences.put('startup', 'auto', function (err) {if (err) {console.info("Put the value of startup failed, err: " + err)return}console.info("Put the value of startup successfully.")preferences.flush(function (err) {if (err) {console.info("Flush to file failed, err: " + err)return}console.info("Flushed to file successfully.") // observer will be called.})preferences.off('change', observer)})
})

ValueType

用于表示允许的数据字段类型。

系统能力：  SystemCapability.DistributedDataManager.Preferences.Core

名称说明
number表示值类型为数字。
string表示值类型为字符串。
boolean表示值类型为布尔值。

相关文章：

  • 在Windows中使用svn的命令行
  • 【ARFoundation自学04】AR Tracked Image 图像追踪识别
  • 基于安卓的虫害识别软件设计--（1）模型训练与可视化
  • 关于安装typescript后运行tsc -v命令报错问题
  • idm2024最新完美破解版免费下载 idm绿色直装版注册机免费分享 idm永久激活码工具
  • HTML5 视频 Vedio 标签详解
  • 神经网络---网络模型的保存、加载
  • 分治算法例子
  • OceanBase v4.2 解读：tenant=all 语义优化，提升易用性
  • Java Web学习笔记4——HTML、CSS
  • PyTorch 的 torch.nn 模块学习
  • 正则表达式----IP地址合法性判断
  • 啵啵啵啵啵啵啵啵啵啵啵啵啵啵啵
  • Java面试——中间件
  • 嵌入式Linux系统编程 — 2.1 标准I/O库简介
  • 【Linux系统编程】快速查找errno错误码信息
  • Angular 2 DI - IoC DI - 1
  • angular学习第一篇-----环境搭建
  • AWS实战 - 利用IAM对S3做访问控制
  • chrome扩展demo1-小时钟
  • Flex布局到底解决了什么问题
  • Java教程_软件开发基础
  • log4j2输出到kafka
  • rc-form之最单纯情况
  • SwizzleMethod 黑魔法
  • vue2.0一起在懵逼的海洋里越陷越深（四）
  • XML已死 ？
  • 通过npm或yarn自动生成vue组件
  • 线性表及其算法（java实现）
  • 一些css基础学习笔记
  • TPG领衔财团投资轻奢珠宝品牌APM Monaco
  • #NOIP 2014# day.1 生活大爆炸版 石头剪刀布
  • (14)Hive调优——合并小文件
  • （2024，LoRA，全量微调，低秩，强正则化，缓解遗忘，多样性）LoRA 学习更少，遗忘更少
  • (3)Dubbo启动时qos-server can not bind localhost22222错误解决
  • (ZT) 理解系统底层的概念是多么重要(by趋势科技邹飞）
  • （保姆级教程）Mysql中索引、触发器、存储过程、存储函数的概念、作用，以及如何使用索引、存储过程，代码操作演示
  • （第27天）Oracle 数据泵转换分区表
  • （三）终结任务
  • （十二）springboot实战——SSE服务推送事件案例实现
  • （转）fock函数详解
  • **python多态
  • .babyk勒索病毒解析：恶意更新如何威胁您的数据安全
  • .NET 表达式计算：Expression Evaluator
  • .net 怎么循环得到数组里的值_关于js数组
  • .NET 中 GetProcess 相关方法的性能
  • .net8.0与halcon编程环境构建
  • .Net各种迷惑命名解释
  • .Net开发笔记（二十）创建一个需要授权的第三方组件
  • .net中我喜欢的两种验证码
  • @Async注解的坑，小心
  • @reference注解_Dubbo配置参考手册之dubbo:reference
  • [ C++ ] STL_stack(栈)queue(队列)使用及其重要接口模拟实现
  • [Android]一个简单使用Handler做Timer的例子
  • [AutoSAR 存储] 汽车智能座舱的存储需求