轻量级偏好数据库：开发指导

场景介绍

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

接口说明

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

创建数据库

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

表1  轻量级偏好数据库创建接口

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

查询数据

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

表2  轻量级偏好数据库查询接口

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

插入数据

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

表3 轻量级偏好数据库插入接口

类名	接口名	描述
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方法来定义观察者的行为。

表4 轻量级偏好数据库接口变化回调

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

删除数据文件

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

表5 轻量级偏好数据库删除接口

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

移动数据库文件

表6 轻量级偏好数据库移动接口

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

开发步骤

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

2.获取Preferences实例。

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

DatabaseHelper databaseHelper = new DatabaseHelper(context); // context入参类型为ohos.app.Context。
String fileName = "name"; // fileName表示文件名，其取值不能为空，也不能包含路径，默认存储目录可以通过context.getPreferencesDir()获取。
Preferences preferences = databaseHelper.getPreferences(fileName);

 

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

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

java接口 读取整型数据

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

 

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

首先获取指定文件对应的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();

  5.注册观察者。

开发者可以向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);

6.移除Preferences实例。

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

DatabaseHelper databaseHelper = new DatabaseHelper(context);
String fileName = "name"; // fileName表示文件名，其取值不能为空，也不能包含路径。
databaseHelper.removePreferencesFromCache(fileName);

7.删除指定文件。

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

DatabaseHelper databaseHelper = new DatabaseHelper(context);
String fileName = "name"; // fileName表示文件名，其取值不能为空，也不能包含路径。
boolean result = databaseHelper.deletePreferences(fileName);

8.移动指定文件。

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

Context targetContext = XXX;
DatabaseHelper databaseHelper = new DatabaseHelper(targetContext);
String srcFile = "srcFile"; // srcFile表示源文件名或者源文件的绝对路径，不能为相对路径，其取值不能为空。当srcFile只传入文件名时，srcContext不能为空。
String targetFile = "targetFile"; // targetFile表示目标文件名，其取值不能为空，也不能包含路径。
Context srcContext = XXX;
boolean result = databaseHelper.movePreferences(srcContext,srcFile,targetFile);