鸿蒙OS 轻量级偏好数据库开发指导

场景介绍

轻量级偏好数据库是轻量级存储，主要用于保存应用的一些常用配置，并不适合存储大量数据和频繁改变数据的场景。用户的数据保存在文件中，可以持久化的存储在设备上。需要注意的是用户访问的实例包含文件所有数据，并一直加载在设备的内存中，并通过轻量级偏好数据库的 API 完成数据操作。

接口说明

轻量级偏好数据库向本地应用提供了操作偏好型数据库的 API，支持本地应用读写少量数据及观察数据变化。数据存储形式为键值对，键的类型为字符串型，值的存储数据类型包括整型、字符串型、布尔型、浮点型、长整型、字符串型 Set 集合。

创建数据库

通过数据库操作的辅助类可以获取到要操作的 Preferences 实例，用于进行数据库的操作。

类名	接口名	描述
DatabaseHelper	Preferences getPreferences(String name)	获取文件对应的 Preferences 单实例，用于数据操作。

查询数据

通过调用 Get 系列的方法，可以查询不同类型的数据。

类名	接口名	描述
Preferences	int getInt(String key, int defValue)	获取键对应的 int 类型的值。
Preferences	float getFloat(String key, float defValue)	获取键对应的 float 类型的值。

插入数据

通过 Put 系列的方法可以修改 Preferences 实例中的数据，通过 flush 或者 flushSyn c将 Preferences 实例持久化。

类名	接口名	描述
Preferences	Preferences putInt(String key, int value)	设置 Preferences 实例中键对应的 int 类型的值。
Preferences	Preferences putString(String key, String value)	设置 Preferences 实例中键对应的 String 类型的值。
Preferences	void flush()	将 Preferences 实例异步写入文件。
Preferences	boolean flushSync()	将 Preferences 实例同步写入文件。

观察数据变化

轻量级偏好数据库还提供了一系列的接口变化回调，用于观察数据的变化。开发者可以通过重写 onChange 方法来定义观察者的行为。

类名	接口名	描述
Preferences	void registerObserver(PreferencesObserver preferencesObserver)	注册观察者，用于观察数据变化。
Preferences	void unRegisterObserver(PreferencesObserver preferencesObserver)	注销观察者。
Preferences.PreferencesObserver	void onChange(Preferences preferences, String key)	观察者的回调方法，任意数据变化都会回调该方法。

删除数据文件

通过调用以下两种接口，可以删除数据文件。

类名	接口名	描述
DatabaseHelper	boolean deletePreferences(String name)	删除文件和文件对应的Preferences单实例。
DatabaseHelper	void removePreferencesFromCache(String name)	删除文件对应的Preferences单实例。

移动数据库文件

类名	接口名	描述
DatabaseHelper	boolean movePreferences(Context sourceContext, String sourceName, String targetName)	移动数据库文件。

开发步骤

1. 准备工作，导入对轻量级偏好数据库 SDK 到开发环境。

1. 获取 Preferences 实例。

读取指定文件，将数据加载到 Preferences 实例，用于数据操作。

   DatabaseHelper databaseHelper = new DatabaseHelper(context);// context入参类型为ohos.app.Context
   String fileName = "name";
   Preferences preferences = databaseHelper.getPreferences(fileName);

1. 从指定文件读取数据。

首先获取指定文件对应的 Preferences 实例，然后借助 Preferences API 读取数据。

java 接口 读取整型数据

   int value = preferences.getInt("intKey", 0);

1. 将数据写入指定文件。

首先获取指定文件对应的 Preferences 实例，然后借助 Preferences API 将数据写入 Preferences 实例，通过 flush 或者 flushSync 将 Preferences 实例持久化。

异步：

   preferences.putInt("intKey", 3);
   preferences.putString("StringKey", "String value");
   preferences.flush();

同步：

   preferences.putInt("intKey", 3);
   preferences.putString("StringKey", "String value");
   preferences.flushSync();

1. 注册观察者。

开发者可以向 Preferences 实例注册观察者，观察者对象需实现Preferences.PreferencesObserver 接口。flushSync() 或 flush() 执行后，该 Preferences 实例注册的所有观察者的 onChange() 方法都会被回调。不再需要观察者时请注销。

   private class PreferencesChangeCounter implements Preferences.PreferencesObserver {
       final AtomicInteger notifyTimes = new AtomicInteger(0);
       @Override    
       public void onChange(Preferences preferences, String key) {
           if ("intKey".equals(key)) {
               notifyTimes.incrementAndGet();        
           }    
       }
   }
   // 向preferences实例注册观察者
   PreferencesChangeCounter counter = new PreferencesChangeCounter();
   preferences.registerObserver(counter);
   // 修改数据preferences.putInt("intKey", 3);
   boolean result = preferences.flushSync();
   // 修改数据后，onChange方法会被回调，notifyTimes == 1
   int notifyTimes = counter.notifyTimes.intValue();
   // 向preferences实例注销观察者
   preferences.unRegisterObserver(counter);

1. 移除 Preferences 实例。

从内存中移除指定文件对应的 Preferences 单实例。移除 Preferences 单实例时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题。

   DatabaseHelper databaseHelper = new DatabaseHelper(context);
   // 指定文件名称
   String fileName = "name";
   databaseHelper.removePreferencesFromCache(fileName);

1. 删除指定文件。

从内存中移除指定文件对应的 Preferences 单实例，并删除指定文件及其备份文件、损坏文件。删除指定文件时，应用不允许再使用该实例进行数据操作，否则会出现数据一致性问题

   DatabaseHelper databaseHelper = new DatabaseHelper(context);
   // 指定文件名称
   String fileName = "name";
   boolean result = databaseHelper.deletePreferences(fileName);

1. 移动指定文件。

从源路径移动文件到目标路径。移动文件时，应用不允许再操作该文件数据，否则会出现数据一致性问题。

   Context targetContext = XXX;
   DatabaseHelper databaseHelper = new DatabaseHelper(targetContext);
   // 指定文件名称
   String srcFile = "srcFile";
   String targetFile = "targetFile";
   Context srcContext = XXX;
   boolean result = databaseHelper.movePreferences(srcContext,srcFile,targetFile);