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

最新推荐文章于 2024-06-12 17:05:10 发布
最新推荐文章于 2024-06-12 17:05:10 发布
阅读量1.2k 收藏 27
点赞数 14
分类专栏： 鸿蒙开发学习笔录 文章标签： harmonyos openharmony 移动开发 鸿蒙 数据管理 接口 鸿蒙系统
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/2301_76813281/article/details/139535234
版权

首选项

首选项为应用提供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表示值类型为布尔值。
爱桥代码的程序媛
关注
  • 14
    点赞
  • 踩
  • 27
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
鸿蒙应用开发之数据管理
xiangzhihong8的专栏
10-27 2899
首选项为应用提供Key-Value键值型的数据存储能力，支持应用持久化轻量级数据，并对其进行增删除改查等。该存储对象中的数据会被缓存在内存中，因此它可以获得更快的存取速度，下面详细介绍下首选项的开发过程。常用接口有：保存数据（put）、获取数据（get）、是否包含指定的key（has）、删除数据（delete）、数据持久化（flush）等。
harmonyOS鸿蒙-数据管理-用户首选项(@ohos.data.preferences)
zhujian82637的博客
07-02 3019
用户首选项为应用提供key-value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。数据存储形式为键值对，键的类型为字符串，值得存储数据类型包括数字型、字符型、布尔型以及3种类型的数组类型。
HarmonyOS鸿蒙应用开发（三、轻量级配置存储dataPreferences）
独行猫a 的沉淀、积累、总结。天天学习，好好向上...c/c++,嵌入式 linux,Android,HarmonyOS)
01-21 2691
在应用开发中存储一些配置是很常见的需求。在android中有SharedPreferences，一个轻量级的存储类，用来保存应用的一些常用配置。在HarmonyOS鸿蒙应用开发中，实现类似功能的也叫首选项，dataPreferences。
HarmonyOS 应用开发之通过用户首选项实现数据持久化
maniuT的博客
04-01 1516
用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。当用户希望有一个全局唯一存储的地方，可以采用用户首选项来进行存储。Preferences会将该数据缓存在内存中，当用户读取的时候，能够快速从内存中获取数据，当需要持久化时可以使用flush接口将内存中的数据写入持久化文件中。
鸿蒙应用开发小例-实现数据持久化
MonkeyZ_的博客
04-05 348
封装用户首选项，通过用户首选项的应用持久化轻量级数据的能力，保存用户设置。
HarmonyOS实战开发：@ohos.data.preferences (用户首选项)
2401_84194030的博客
05-31 1245
用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。
鸿蒙HarmonyOS开发 preferences首选项
最新发布
nanxuan521的专栏
06-12 976
ohos.data.preferences (用户首选项)用户首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型以及这3种类型的数组类型。注意：Key的最大长度限制为80个字节，Value的最大长度限制为8192个字节。大概2000个字符左右的长度，如果数据多长建议使用文件或轻量型数据库来存储。
HarmonyOS鸿蒙应用开发——数据持久化之Preferences
学习，思考，输出
12-13 2977
数据持久化就是将内存数据通过文件或者数据库的方式保存到设备中。返回值类型是不确定性，定义一个联合类型的别名。，方便后期可以通过单例直接获取实例；实例后会将其保存单例中，这个单例是。实例就可以对数据增删改查操作。注意：以上方法都是异步的。方法中创建实例，其中。
HarmonyOS应用开发-首选项与后台通知管理
断线的风筝
11-10 1135
首选项为应用提供Key-Value键值型的数据存储能力，支持应用持久化轻量级数据，并对其进行增删除改查等。该存储对象中的数据会被缓存在内存中，因此它可以获得更快的存取速度。数据以键值对的形式存储，其中Key是唯一的关键字，而对应的Value是实际的数据值。与关系型数据库不同，首选项不遵循ACID特性（Atomicity, Consistency, Isolation, Durability），且数据之间没有关系。在一个进程中，每个文件只存在一个首选项实例。
harmonyOS鸿蒙官网教程-保存应用数据
移动端开发与最新技术
10-08 1998
数据管理
HarmonyOS数据存储之首选项Demo
12-02
在 HarmonyOS 中，首选项的实现旨在提供类似 Android 的 API 接口，使开发者能快速上手。 2. **创建首选项** 在 HarmonyOS 中，首选项通常通过 `SharedPreferences` 类进行操作。首先，你需要在 `src` 文件夹下的 ...
移动应用开发：保存全局参数 .pptx
08-06
移动应用开发：保存全局参数 移动应用开发中，保存全局参数是一项重要的任务。全局参数是指应用程序中需要保存的配置信息，例如用户输入的参数、服务器地址等。为了保存这些参数，我们可以使用两种方式：...
鸿蒙HarmonyOS应用开发者认证 题库+答案案
01-18
本资源提供了鸿蒙HarmonyOS应用开发者认证的题库和答案，涵盖了HarmonyOS应用开发的多个方面，包括容器组件、 Ability、Web组件、网络请求、首选项、自定义组件、弹窗组件、图片加载、网络权限等。通过学习和理解...
设置：我的设置...点文件，别名，函数，首选项，应用程序。 一切
02-05
点文件，别名，函数，首选项，应用程序。 一切。 时 zprezto-update git -C $SETUP_PATH pull origin master source $SETUP_PATH/dotfiles/.zshrc sourceFiles $SETUP_PATH/preferences/*.prefs brew upgrade brew ...
Java Web初级编程：开发环境配置.pptx
04-30
在Java Web开发中，开发环境的配置是初学者必须掌握的基础步骤。这涉及到JSP（Java Server Pages）编码设置、Web服务器的配置以及Web应用的创建与部署。下面将详细阐述这些关键知识点。 1. **开发环境配置** 开发...
【鸿蒙应用ArkTS开发系列】- 轻量级缓存框架Preferences使用
枫的专栏
04-20 3909
Preferences 首选项为应用提供Key-Value键值型的数据处理能力，支持应用持久化轻量级数据，并对其修改和查询。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括数字型、字符型、布尔型以及这3种类型的数组类型。具体参考官网。
鸿蒙开发之数据持久化存储Preferences
Lu_Ca的博客
12-19 1230
用户首选项（Preferences）提供的是key-value键值对的方式处理数据。类似于iOS开发中的NSUserDefault，主要针对的是轻量化数据的存储。如：字体大小、用户的信息等。其中，key为字符串类型，value是string、number、boolean以及其组成的数组类型。
HarmonyOS数据存储之首选项（含源码）
当你发现自己的才华撑不起野心时，就请安静下来学习~
12-02 1149
我们在globalThis对象中定义了一个函数getFontPreferences ，用来获取Preferences实例，该实例包括get,put,has,delete和flush等方法。然后我们在页面加载显示的时候，也就是触发生命周期函数onPageShow方法处，通过我们封装的工具类方法getChangeFontSize()来读取首选项中的字体配置。为了保证App启动后，页面里的字体能正常展示，我们需要在生命周期的onCreate方法里，提前保存下默认的字体大小。本功能初步学完，继续加油！
【纯血鸿蒙】之用户首选项
yihanss的博客
05-03 1663
好了，就到这了，上面是我简单的写了个用户首选项的基本用法，其实AppStorage也可以用来存取数据，个人比较喜欢用首选项，AppStorage好像有个坑，在EntryAbility里面不能获取数据，不知道华为修复这个bug没，后面我会继续给大家分享系列的鸿蒙相关实战，包括各种踩坑，网络请求封装系列之类的，首页渐变效果，节后见！
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值