鸿蒙Next开发-通讯录app，创建数据库（三）

1. 官方文档指南

1. 关系型数据库实现数据持久化： https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/data-persistence-by-rdb-store-V5

2. 场景介绍

关系型数据库基于SQLite组件，适用于存储包含复杂关系数据的场景，比如一个班级的学生信息，需要包括姓名、学号、各科成绩等，又或者公司的雇员信息，需要包括姓名、工号、职位等，由于数据之间有较强的对应关系，复杂程度比键值型数据更高，此时需要使用关系型数据库来持久化保存数据。

3. 运作机制

关系型数据库对应用提供通用的操作接口，底层使用SQLite作为持久化存储引擎，支持SQLite具有的数据库特性，包括但不限于事务、索引、视图、触发器、外键、参数化查询和预编译SQL语句。

4. 约束限制

• 系统默认日志方式是WAL（Write Ahead Log）模式，系统默认落盘方式是FULL模式。
• 数据库中有4个读连接和1个写连接，线程获取到空闲读连接时，即可进行读取操作。当没有空闲读连接且有空闲写连接时，会将写连接当做读连接来使用。
• 为保证数据的准确性，数据库同一时间只能支持一个写操作。
• 当应用被卸载完成后，设备上的相关数据库文件及临时文件会被自动清除。
• ArkTS侧支持的基本数据类型：number、string、二进制类型数据、boolean。
• 为保证插入并读取数据成功，建议一条数据不要超过2M。超出该大小，插入成功，读取失败。

5. 接口说明

接口名称	描述
getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback)	获得一个RdbStore，操作关系型数据库，用户可以根据自己的需求配置RdbStore的参数，然后通过RdbStore调用相关接口可以执行相关的数据操作。
executeSql(sql: string, bindArgs: Array, callback: AsyncCallback)	执行包含指定参数但不返回值的SQL语句。
insert(table: string, values: ValuesBucket, callback: AsyncCallback)	向目标表中插入一行数据。
update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback)	根据predicates的指定实例对象更新数据库中的数据。
delete(predicates: RdB Predicates, callback: AsyncCallback)	根据predicates的指定实例对象从数据库删除数据。
query(predicates: RdbPredicates, columns: Array, callback: AsyncCallback)	根据指定条件查询数据库中的数据。
deleteRdbStore(context: Context, name: string, callback: AsyncCallback)	删除数据库。

6. 开发步骤

这里只讲Stage模型

1. 使用关系型数据库实现数据持久化，需要获取一个RdbStore，其中包括建库、建表、升降级等操作。示例代码如下所示：

导入模块：import { relationalStore } from '@kit.ArkData'; // 导入模块

2. 获取RdbStore实例

参数：

参数名	类型	必填	说明
context	Context	是	应用的上下文。FA模型的应用Context定义见Context。Stage模型的应用Context定义见Context。
config	StoreConfig	是	与此RDB存储相关的数据库配置。
callback	AsyncCallback	是	指定回调函数，返回RdbStore对象。

官方文档指南：https://developer.huawei.com/consumer/cn/doc/harmonyos-references-V5/js-apis-data-relationalstore-V5#relationalstoregetrdbstore

relationalStore.getRdbStore(this.context, STORE_CONFIG, (err, store) => {
      if (err) {
        console.error('-------------', `Failed to get RdbStore. Code:${err.code}, message:${err.message}`);
        return
      }
      console.info('-----------------', 'Succeeded in getting RdbStore.');

    })

3. 设置数据库相关配置 relationalStore.StoreConfig

 const STORE_CONFIG: relationalStore.StoreConfig = {
      name: 'contacts.db', //必选
      securityLevel: relationalStore.SecurityLevel.S1, //必选  数据库安全级别
      // encrypt: false, // 可选参数，指定数据库是否加密，默认不加密
      //  customDir: 'customDir/subCustomDir', // 可选参数，数据库自定义路径。数据库将在如下的目录结构中被创建：context.databaseDir + '/rdb/' + customDir，其中context.databaseDir是应用沙箱对应的路径，'/rdb/'表示创建的是关系型数据库，customDir表示自定义的路径。当此参数不填时，默认在本应用沙箱目录下创建RdbStore实例。
      //  isReadOnly: false // 可选参数，指定数据库是否以只读方式打开。该参数默认为false，表示数据库可读可写。该参数为true时，只允许从数据库读取数据，不允许对数据库进行写操作，否则会返回错误码801。
    }

4. 建表

 const SQL_CREATE_TABLE = 'CREATE TABLE IF NOT EXISTS Contacts_Table (' +
        'contacts_id INTEGER PRIMARY KEY AUTOINCREMENT,' +
        'ct_username TEXT,' +
        'ct_mobile TEXT,' +
        'ct_bg_color TEXT)';

5. 执行建表sql

 store.executeSql(SQL_CREATE_TABLE)

温馨提示：

1. 请确保获取到RdbStore实例后，再进行数据库的增、删、改、查等操作
2. 尽可能写在EntryAbility中的onWindowStageCreate下初始化数据 ，越早初始化越好

7. 具体实现过程

import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { window } from '@kit.ArkUI';
import { relationalStore } from '@kit.ArkData'; // 导入模块


//导出storeDb，在其他页面需要使用storeDb的时候，import再导入
export let storeDb: relationalStore.RdbStore | undefined = undefined;

export default class EntryAbility extends UIAbility {
  onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
    console.info('----------', 'Ability onCreate');
  }

  onDestroy(): void {
    console.info('----------', 'Ability onDestroy');
  }

  onWindowStageCreate(windowStage: window.WindowStage): void {
    // Main window is created, set main page for this ability
    console.info('----------', 'Ability onWindowStageCreate');

    //第二步：设置数据库相关配置 relationalStore.StoreConfig
    const STORE_CONFIG: relationalStore.StoreConfig = {
      name: 'contacts.db', //必选
      securityLevel: relationalStore.SecurityLevel.S1, //必选  数据库安全级别
      // encrypt: false, // 可选参数，指定数据库是否加密，默认不加密
      //  customDir: 'customDir/subCustomDir', // 可选参数，数据库自定义路径。数据库将在如下的目录结构中被创建：context.databaseDir + '/rdb/' + customDir，其中context.databaseDir是应用沙箱对应的路径，'/rdb/'表示创建的是关系型数据库，customDir表示自定义的路径。当此参数不填时，默认在本应用沙箱目录下创建RdbStore实例。
      //  isReadOnly: false // 可选参数，指定数据库是否以只读方式打开。该参数默认为false，表示数据库可读可写。该参数为true时，只允许从数据库读取数据，不允许对数据库进行写操作，否则会返回错误码801。
    }

    // 1. 第一步：获取RdbStore实例
    relationalStore.getRdbStore(this.context, STORE_CONFIG, (err, store) => {
      if (err) {
        console.error('-------------', `Failed to get RdbStore. Code:${err.code}, message:${err.message}`);
        return
      }
      storeDb =store

      // 第三步：建表Sql语句  Contacts_Table为表名
      const SQL_CREATE_TABLE = 'CREATE TABLE IF NOT EXISTS Contacts_Table (' +
        'contacts_id INTEGER PRIMARY KEY AUTOINCREMENT,' +    //id(每张表一定需要一个自增长的ID)
        'ct_username TEXT,' +     //用户名
        'ct_mobile TEXT,' +      //手机号
        'ct_bg_color TEXT)';    //用户名首字母的背景颜色


      //3. 第四步：执行建表sql
      store.executeSql(SQL_CREATE_TABLE)

      console.info('-----------------', 'Succeeded in getting RdbStore.');

    })


    windowStage.loadContent('pages/Index', (err) => {
      if (err.code) {
        console.error('-----------------', JSON.stringify(err) ?? '');
        return;
      }
      console.info('-----------------', 'Succeeded in loading the content.');
    });
  }

  onWindowStageDestroy(): void {
    // Main window is destroyed, release UI related resources
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageDestroy');
  }

  onForeground(): void {
    // Ability has brought to foreground
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onForeground');
  }

  onBackground(): void {
    // Ability has back to background
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onBackground');
  }
}