HarmonyOS 应用开辟之通过用户首选项实现数据持久化

应用数据持久化概述

应用数据持久化，是指应用将内存中的数据通过文件或数据库的形式保存到设备上。内存中的数据形态通常是任意的数据结构或数据对象，存储介质上的数据形态可能是文本、数据库、二进制文件等。
OpenHarmony尺度系统支持典型的存储数据形态，包括用户首选项、键值型数据库、关系型数据库。
开辟者可以根据如下功能先容，选择合适的数据形态以满足自己应用数据的持久化需要。

• 用户首选项（Preferences）：通常用于保存应用的设置信息。数据通过文本的形式保存在设备中，应用使用过程中会将文本中的数据全量加载到内存中，所以访问速率快、效率高，但不适合需要存储大量数据的场景。
  
• 键值型数据库（KV-Store）：一种非关系型数据库，其数据以“键值”对的形式进行组织、索引和存储，其中“键”作为唯一标识符。适合很少数据关系和业务关系的业务数据存储，同时因其在分布式场景中降低了解决数据库版本兼容题目标复杂度，和数据同步过程中辩说解决的复杂度而被广泛使用。相比于关系型数据库，更轻易做到跨设备跨版本兼容。
  
• 关系型数据库（RelationalStore）：一种关系型数据库，以行和列的形式存储数据，广泛用于应用中的关系型数据的处理，包括一系列的增、删、改、查等接口，开辟者也可以运行自己定义的SQL语句来满足复杂业务场景的需要。
  

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

场景先容

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

如图所示，用户程序通过ArkTS接口调用用户首选项读写对应的数据文件。开辟者可以将用户首选项持久化文件的内容加载到Preferences实例，每个文件唯一对应到一个Preferences实例，系统会通过静态容器将该实例存储在内存中，直到自动从内存中移除该实例大概删除该文件。
应用首选项的持久化文件保存在应用沙箱内部，可以通过context获取其路径。
图1 用户首选项运作机制

束缚限制

• Key键为string类型，要求非空且长度不超过80个字节。
  
• 如果Value值为string类型，请使用UTF-8编码格式，可以为空，不为空时长度不超过8192个字节。
  
• 内存会随着存储数据量的增大而增大，所以存储的数据量应该是轻量级的，建议存储的数据不超过一万条，否则会在内存方面产生较大的开销。
  

接口说明

以下是用户首选项持久化功能的相关接口，更多接口及使用方式请见用户首选项。
接口名称形貌getPreferencesSync(context: Context, options: Options): Preferences获取Preferences实例。该接口存在异步接口。putSync(key: string, value: ValueType): void将数据写入Preferences实例，可通过flush将Preferences实例持久化。该接口存在异步接口。hasSync(key: string): void查抄Preferences实例是否包罗名为给定Key的存储键值对。给定的Key值不能为空。该接口存在异步接口。getSync(key: string, defValue: ValueType): void获取键对应的值，如果值为null大概非默认值类型，返回默认数据defValue。该接口存在异步接口。deleteSync(key: string): void从Preferences实例中删除名为给定Key的存储键值对。该接口存在异步接口。flush(callback: AsyncCallback): void将当前Preferences实例的数据异步存储到用户首选项持久化文件中。on(type: ‘change’, callback: Callback): void订阅数据变更，订阅的数据发生变更后，在执行flush方法后，触发callback回调。off(type: ‘change’, callback?: Callback): void取消订阅数据变更。deletePreferences(context: Context, options: Options, callback: AsyncCallback): void从内存中移除指定的Preferences实例。若Preferences实例有对应的持久化文件，则同时删除其持久化文件。 开辟步调

• 导入@ohos.data.preferences模块。
  

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

复制代码

• 获取Preferences实例。
  

Stage模型示例：

1. import UIAbility from '@ohos.app.ability.UIAbility';
2. import { BusinessError } from '@ohos.base';
3. import window from '@ohos.window';
5. let preferences: dataPreferences.Preferences | null = null;
7. class EntryAbility extends UIAbility {
8.   onWindowStageCreate(windowStage: window.WindowStage) {
9.     let options: dataPreferences.Options = { name: 'myStore' };
10.     preferences = dataPreferences.getPreferencesSync(this.context, options);
11.   }
12. }

复制代码

FA模型示例：

1. // 获取context
2. import featureAbility from '@ohos.ability.featureAbility';
3. import { BusinessError } from '@ohos.base';
5. let context = featureAbility.getContext();
6. let options: dataPreferences.Options =  { name: 'myStore' };
7. let preferences: dataPreferences.Preferences = dataPreferences.getPreferencesSync(context, options);

复制代码

• 写入数据。
  

使用putSync()方法保存数据到缓存的Preferences实例中。在写入数据后，如有需要，可使用flush()方法将Preferences实例的数据存储到持久化文件。
   说明：
  当对应的键已经存在时，putSync()方法会修改其值。可以使用hasSync()方法查抄是否存在对应键值对。
  示例代码如下所示：

1. import util from '@ohos.util';
2. if (preferences.hasSync('startup')) {
3.   console.info("The key 'startup' is contained.");
4. } else {
5.   console.info("The key 'startup' does not contain.");
6.   // 此处以此键值对不存在时写入数据为例
7.   preferences.putSync('startup', 'auto');
8.   // 当字符串有特殊字符时，需要将字符串转为Uint8Array类型再存储
9.   let uInt8Array = new util.TextEncoder().encodeInto("~！@#￥%……&\*（）——+？");
10.   preferences.putSync('uInt8', uInt8Array);
11. }

复制代码

• 读取数据。
  

使用getSync()方法获取数据，即指定键对应的值。如果值为null大概非默认值类型，则返回默认数据。
示例代码如下所示：

1. import util from '@ohos.util';
2. let val = preferences.getSync('startup', 'default');
3. console.info("The 'startup' value is " + val);
4. // 当获取的值为带有特殊字符的字符串时，需要将获取到的Uint8Array转换为字符串
5. let uInt8Array : dataPreferences.ValueType = preferences.getSync('uInt8', new Uint8Array(0));
6. let textDecoder = util.TextDecoder.create('utf-8');
7. val = textDecoder.decodeWithStream(uInt8Array as Uint8Array);
8. console.info("The 'uInt8' value is " + val);

复制代码

• 删除数据。
  

使用deleteSync()方法删除指定键值对，示例代码如下所示：

1. preferences.deleteSync('startup');

复制代码

• 数据持久化。
  

应用存入数据到Preferences实例后，可以使用flush()方法实现数据持久化。示例代码如下所示：

1. preferences.flush((err: BusinessError) => {
2.   if (err) {
3.     console.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
4.     return;
5.   }
6.   console.info('Succeeded in flushing.');
7. })

复制代码

• 订阅数据变更。
  

应用订阅数据变更需要指定observer作为回调方法。订阅的Key值发生变更后，当执行flush()方法时，observer被触发回调。示例代码如下所示：

1. let observer = (key: string) => {
2.   console.info('The key' + key + 'changed.');
3. }
4. preferences.on('change', observer);
5. // 数据产生变更，由'auto'变为'manual'
6. preferences.put('startup', 'manual', (err: BusinessError) => {
7.   if (err) {
8.     console.error(`Failed to put the value of 'startup'. Code:${err.code},message:${err.message}`);
9.     return;
10.   }
11.   console.info("Succeeded in putting the value of 'startup'.");
12.   if (preferences !== null) {
13.     preferences.flush((err: BusinessError) => {
14.       if (err) {
15.         console.error(`Failed to flush. Code:${err.code}, message:${err.message}`);
16.         return;
17.       }
18.       console.info('Succeeded in flushing.');
19.     })
20.   }
21. })

复制代码

• 删除指定文件。
  

使用deletePreferences()方法从内存中移除指定文件对应的Preferences实例，包括内存中的数据。若该Preference存在对应的持久化文件，则同时删除该持久化文件，包括指定文件及其备份文件、损坏文件。
   说明：
  

• 调用该接口后，应用不允许再使用该Preferences实例进行数据操纵，否则会出现数据一致性题目。
  
• 乐成删除后，数据及文件将不可规复。
  

  示例代码如下所示：

1. let options: dataPreferences.Options = { name: 'myStore' };
2.   dataPreferences.deletePreferences(this.context, options, (err: BusinessError) => {
3.     if (err) {
4.       console.error(`Failed to delete preferences. Code:${err.code}, message:${err.message}`);
5.         return;
6.     }
7.     console.info('Succeeded in deleting preferences.');
8. })

复制代码

为了能让各人更好的学习鸿蒙（HarmonyOS NEXT）开辟技能，这边特意整理了《鸿蒙开辟学习手册》（共计890页），希望对各人有所帮助：https://qr21.cn/FV7h05
《鸿蒙开辟学习手册》：

如何快速入门：https://qr21.cn/FV7h05

• 基本概念
  
• 构建第一个ArkTS应用
  
• ……
  

开辟底子知识：https://qr21.cn/FV7h05

• 应用底子知识
  
• 设置文件
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。