如何在 HarmonyOS 对数据库进行备份，恢复与加密_harmonyos distributedkvstore

数据库备份与恢复

场景介绍

当应用在处理一项重要的操作，显然是不能被打断的。例如：写入多个表关联的事务。此时，每个表的写入都是单独的，但是表与表之间的事务关联性不能被分割。

如果操作的过程中出现问题，开发者可以使用恢复功能，将数据库恢复到之前的状态，重新对数据库进行操作。

在数据库被篡改、删除、或者设备断电场景下，数据库可能会因为数据丢失、数据损坏、脏数据等而不可用，可以通过数据库的备份恢复能力将数据库恢复至可用状态。

键值型数据库和关系型数据库均支持对数据库的备份和恢复。另外，键值型数据库还支持删除数据库备份，以释放本地存储空间。

键值型数据库备份、恢复与删除

键值型数据库，通过 backup 接口实现数据库备份，通过 restore 接口实现数据库恢复，通过 deletebackup 接口删除数据库备份。具体接口及功能，可见分布式键值数据库。

1.  创建数据库。(1) 创建 kvManager。

(2) 配置数据库参数。

(3)  创建 kvStore。

import distributedKVStore from '@ohos.data.distributedKVStore';
let kvManager;let context = getContext(this);const kvManagerConfig = {  context: context,  bundleName: 'com.example.datamanagertest'}try {  kvManager = distributedKVStore.createKVManager(kvManagerConfig);  console.info('Succeeded in creating KVManager.');} catch (e) {  console.error(`Failed to create KVManager. Code:${e.code},message:${e.message}`);}let kvStore;try {  const options = {    createIfMissing: true,    encrypt: false,    backup: false,    kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,    securityLevel: distributedKVStore.SecurityLevel.S2  };  kvManager.getKVStore('storeId', options, (err, store) => {    if (err) {      console.error(`Fail to get KVStore. Code:${err.code},message:${err.message}`);      return;    }    console.info('Succeeded in getting KVStore.');    kvStore = store;  });} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

2.  使用 put()方法插入数据。

const KEY_TEST_STRING_ELEMENT = 'key_test_string';const VALUE_TEST_STRING_ELEMENT = 'value_test_string';try {  kvStore.put(KEY_TEST_STRING_ELEMENT, VALUE_TEST_STRING_ELEMENT, (err) => {    if (err !== undefined) {      console.error(`Fail to put data. Code:${err.code},message:${err.message}`);      return;    }    console.info('Succeeded in putting data.');  });} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

3.  使用 backup()方法备份数据。

let file = 'BK001';try {  kvStore.backup(file, (err) => {    if (err) {      console.error(`Fail to backup data.code:${err.code},message:${err.message}`);    } else {      console.info('Succeeded in backupping data.');    }  });} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

4.  使用 delete()方法删除数据（模拟意外删除、篡改场景）。

try {  kvStore.delete(KEY_TEST_STRING_ELEMENT, (err) => {    if (err !== undefined) {      console.error(`Fail to delete data. Code:${err.code},message:${err.message}`);      return;    }    console.info('Succeeded in deleting data.');  });} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

5.  使用 restore()方法恢复数据。

let file = 'BK001';try {  kvStore.restore(file, (err) => {    if (err) {      console.error(`Fail to restore data. Code:${err.code},message:${err.message}`);    } else {      console.info('Succeeded in restoring data.');    }  });} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

6.  当本地设备存储空间有限或需要重新备份时，还可使用 deleteBackup()方法删除备份，释放存储空间。

let kvStore;let files = ['BK001'];try {  kvStore.deleteBackup(files).then((data) => {    console.info(`Succeed in deleting Backup. Data:filename is ${data[0]},result is ${data[1]}.`);  }).catch((err) => {    console.error(`Fail to delete Backup. Code:${err.code},message:${err.message}`);  })} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

关系型数据库备份与恢复

关系型数据库，通过 backup 接口实现数据库备份，通过 restore 接口实现数据库恢复。具体接口及功能，可见关系型数据库。

1.  使用 getRdbStore()方法创建关系型数据库。

import relationalStore from '@ohos.data.relationalStore';
let store;let context = getContext(this);const STORE_CONFIG = {  name: 'RdbTest.db',  securityLevel: relationalStore.SecurityLevel.S1};relationalStore.getRdbStore(context, STORE_CONFIG, (err, rdbStore) => {  store = rdbStore;  if (err) {    console.error(`Failed to get RdbStore. Code:${err.code},message:${err.message}`);    return;  }  store.executeSql("CREATE TABLE IF NOT EXISTS EMPLOYEE (id INTEGER PRIMARY KEY AUTOINCREMENT, name TEXT NOT NULL, age INTEGER, salary INTEGER, codes Uint8Array);", null);  console.info('Succeeded in getting RdbStore.');})

2.  使用 insert()方法插入数据。

const valueBucket = {  'NAME': 'Lisa',  'AGE': 18,  'SALARY': 100.5, 'CODES': new Uint8Array([1, 2, 3, 4, 5])};store.insert('EMPLOYEE', valueBucket, relationalStore.ConflictResolution.ON_CONFLICT_REPLACE, (err, rowId) => {  if (err) {    console.error(`Failed to insert data. Code:${err.code},message:${err.message}`);    return;  }  console.info(`Succeeded in inserting data. rowId:${rowId}`);})

3.  使用 backup()方法备份数据。

store.backup('dbBackup.db', (err) => {  if (err) {    console.error(`Failed to backup data. Code:${err.code},message:${err.message}`);    return;  }  console.info(`Succeeded in backuping data.`);})

4.  使用 delete()方法删除数据（模拟意外删除、篡改场景）。

let predicates = new relationalStore.RdbPredicates('EMPLOYEE');predicates.equalTo('NAME', 'Lisa');let promise = store.delete(predicates);promise.then((rows) => {  console.info(`Delete rows: ${rows}`);}).catch((err) => {  console.error(`Failed to delete data. Code:${err.code},message:${err.message}`);})

5.  使用 restore()方法恢复数据。

store.restore('dbBackup.db', (err) => {  if (err) {    console.error(`Failed to restore data. Code:${err.code},message:${err.message}`);    return;  }  console.info(`Succeeded in restoring data.`);})

数据库加密

场景介绍

为了增强数据库的安全性，数据库提供了一个安全适用的数据库加密能力，从而对数据库存储的内容实施有效保护。通过数据库加密等安全方法实现了数据库数据存储的保密性和完整性要求，使得数据库以密文方式存储并在密态方式下工作，确保了数据安全。

加密后的数据库只能通过接口进行访问，无法通过其它方式打开数据库文件。数据库的加密属性在创建数据库时确认，无法变更。

键值型数据库和关系型数据库均支持数据库加密操作。

键值型数据库加密

键值型数据库，通过 options 中 encrypt 参数来设置是否加密，默认为 false，表示不加密。encrypt 参数为 true 时表示加密。

具体接口及功能，可见分布式键值数据库。

import distributedKVStore from '@ohos.data.distributedKVStore';
let kvManager;let context = getContext(this);const kvManagerConfig = {  context: context,  bundleName: 'com.example.datamanagertest'}try {  kvManager = distributedKVStore.createKVManager(kvManagerConfig);  console.info('Succeeded in creating KVManager.');} catch (e) {  console.error(`Failed to create KVManager. Code:${e.code},message:${e.message}`);}let kvStore;try {  const options = {    createIfMissing: true,    // 设置数据库加密    encrypt: true,    backup: false,    kvStoreType: distributedKVStore.KVStoreType.SINGLE_VERSION,    securityLevel: distributedKVStore.SecurityLevel.S2  };  kvManager.getKVStore('storeId', options, (err, store) => {    if (err) {      console.error(`Fail to get KVStore. Code:${err.code},message:${err.message}`);      return;    }    console.info('Succeeded in getting KVStore.');    kvStore = store;  });} catch (e) {  console.error(`An unexpected error occurred. Code:${e.code},message:${e.message}`);}

关系型数据库加密

关系型数据库，通过 StoreConfig 中 encrypt 属性来设置是否加密，默认为 false，表示不加密。encrypt 参数为 true 时表示加密。

具体接口及功能，可见关系型数据库。

import relationalStore from '@ohos.data.relationalStore';
let store;let context = getContext(this);const STORE_CONFIG = {  name: 'RdbTest.db',  securityLevel: relationalStore.SecurityLevel.S1,  encrypt: true};relationalStore.getRdbStore(context, STORE_CONFIG, (err, rdbStore) => {  store = rdbStore;  if (err) {    console.error(`Failed to get RdbStore. Code:${err.code},message:${err.message}`);    return;  }  console.info(`Succeeded in getting RdbStore.`);})