【鸿蒙实战开发】关系型数据库(RelationalStore)

45 篇文章 0 订阅
38 篇文章 0 订阅

基本概念

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

接口说明

以下是关系型数据库持久化功能的相关接口,大部分为异步接口。异步接口均有callback和Promise两种返回形式,下表均以callback形式为例,更多接口及使用方式请见关系型数据库。

在这里插入图片描述

快速使用指南

1. 导入模块

import relationalStore from '@ohos.data.relationalStore'; // 导入模块 

2. 获得一个相关的RdbStore

在项目文件中的EntryAbility

在这里插入图片描述

在该代码的生命周期函数onWindowStageCreat中添加代码:

const STORE_CONFIG = {
      name: 'RdbTest.db', // 数据库文件名
      securityLevel: relationalStore.SecurityLevel.S1 // 数据库安全级别
    };

    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.`);

    });

relationalStore.getRdbStore接口说明:

getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback): void

获得一个相关的RdbStore,操作关系型数据库,用户可以根据自己的需求配置RdbStore的参数,然后通过RdbStore调用相关接口可以执行相关的数据操作,使用callback异步回调。

参数

在这里插入图片描述

在该代码中:STORE_CONFIG为数据库的配置参数,更详细的说明在官方文档,在执行getRdbStore时,需要提供context,以及配置参数。

当执行getRdbStore后,通过回调函数获取到RdbStore(store)对象,该对象可以用来操作数据库,如创建数据库,增删改查、创建数据表等操作。

注意:

●应用创建的数据库与其上下文(Context)有关,即使使用同样的数据库名称,但不同的应用上下文,会产生多个数据库,例如每个UIAbility都有各自的上下文。
●当应用首次获取数据库(调用getRdbStore)后,在应用沙箱内会产生对应的数据库文件。使用数据库的过程中,在与数据库文件相同的目录下可能会产生以-wal和-shm结尾的临时文件。此时若开发者希望移动数据库文件到其它地方使用查看,则需要同时移动这些临时文件,当应用被卸载完成后,其在设备上产生的数据库文件及临时文件也会被移除。

3. 创建RdbUtils工具包

为了方便我们后面在UI中操作数据库,我们在项目文件中创建common/rdbUtils/RdbUtils.ts文件,作为数据库操作工具包:

在这里插入图片描述

代码如下:

import relationalStore from '@ohos.data.relationalStore';
export default class RdbUtils {
  private static rdbStore: relationalStore.RdbStore;
  static setStore(store: relationalStore.RdbStore) {
    RdbUtils.rdbStore = store;
  }
  static getStore(): relationalStore.RdbStore {
    return RdbUtils.rdbStore;
  }
}

之后,我们需要在刚才的EntryAbility中的生命周期函数onWindowStageCreat中添加RdbUtils.setStore(store),代码如下:

const STORE_CONFIG = {
      name: 'RdbTest.db', // 数据库文件名
      securityLevel: relationalStore.SecurityLevel.S1 // 数据库安全级别
    };

    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.`);
      //保存store, 方便后面我们对数据库的操作
      RdbUtils.setStore(store)

    });

4. 创建数据库表

通过relationalStore.getRdbStore获得RdbStore(store)对象后 , 将其保存到我们的工具包中的静态变量中,方便我们后面执行创建数据库的操作。

在我们的工具包代码RdbUtils.ts文件中,添加 executeSql方法:

import relationalStore from '@ohos.data.relationalStore';
export default class RdbUtils {
  ...
  static executeSql(sql: string): Promise<void> {
    return RdbUtils.getStore().executeSql(sql);
  }
  ...
}

RdbStore.executeSql接口说明:

executeSql(sql: string, bindArgs?: Array):Promise

执行包含指定参数但不返回值的SQL语句,使用Promise异步回调。

参数:

在这里插入图片描述

在我们UI页面index.ets

import RdbUtils from '../common/rdbUtils/RdbUtils';
@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        Button('创建数据库表')
          .onClick(() => {
            const SQL_CREATE_TABLE = 'CREATE TABLE IF NOT EXISTS EMPLOYEE (ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB)'; // 建表Sql语句
            RdbUtils.executeSql(SQL_CREATE_TABLE)
            .then(() =>{
                openDialog('successfully created table')
              }).catch((err) => {
              openDialog(err);
            })
          })
      }
      .width('100%')
    }
    .height('100%')
  }
}

function openDialog(text: string) {
  AlertDialog.show(
    {
      title: 'title',
      message: text,
      autoCancel: true,
      alignment: DialogAlignment.Bottom,
      offset: { dx: 0, dy: -20 },
    }
  )
}

这个代码中,我们绑定了一个按钮,用来点击执行创建数据库表的操作。当执行RdbUtils.executeSql时,将返回Promise对象,将其处理之后。通过弹窗的形式将其展示。

效果如下:

在这里插入图片描述

表结构说明:

这是一个SQL语句,用于在数据库中创建一个名为"EMPLOYEE"的表。以下是该表的结构说明:

表名: EMPLOYEE

列名及类型:

1.ID: 这是一个整数类型的列,被设置为主键,并且自动递增。这意味着每次添加新记录时,此列的值会自动增加,不允许重复。
2.NAME: 这是一个文本类型的列,不允许为空。这意味着在插入或更新记录时,必须为这一列提供值。
3.AGE: 这是一个整数类型的列,可以包含任何整数值。
4.SALARY: 这是一个浮点数类型的列,可以用于存储工资或薪水的值。
5.CODES: 这是一个BLOB类型的列,通常用于存储二进制数据。它可以用于存储代码、数据或其他二进制格式的信息。
约束:

●由于"ID"列被指定为主键,所以每个"ID"值必须是唯一的,并且不能为空。
●"NAME"列被设置为"NOT NULL",这意味着每次插入或更新记录时,必须为这一列提供值。

5. 插入数据

在插入数据之前,需要再工具包中添加insert()方法:

import relationalStore from '@ohos.data.relationalStore';
export default class RdbUtils {
  ...
  static insert(tableName: string, data: any): Promise<number> {
    return RdbUtils.getStore().insert(tableName, data);
  }
  ...
}

接口说明:

insert:

insert(table: string, values: ValuesBucket):Promise

向目标表中插入一行数据,使用Promise异步回调。

参数:

在这里插入图片描述

返回值:

在这里插入图片描述

之后,在我们的UI中调用RdbUtils中的insert()方法插入数据。示例代码如下所示:、

import RdbUtils from '../common/rdbUtils/RdbUtils';
@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        ...
        Button('插入数据')
          .onClick(() => {
            const valueBucket = {
              'NAME': 'Lisa',
              'AGE': 18,
              'SALARY': 100.5,
              'CODES': new Uint8Array([1, 2, 3, 4, 5])
            };
            RdbUtils.insert('EMPLOYEE', valueBucket)
              .then((updateNumber) => {
                openDialog('已插入数据:' + updateNumber)
            }).catch((error) => {
              openDialog('error: ' + error)
            })
          })
        ...
      }
      .width('100%')
    }
    .height('100%')
  }
}
...

效果如图所示:

在这里插入图片描述

6. 查询数据

查询数据可以通过RdbStore中的query()方法执行查询,返回ResultSet:

接口说明:

query(predicates: RdbPredicates, columns?: Array):Promise

根据指定条件查询数据库中的数据,使用Promise异步回调。

参数:

在这里插入图片描述

在我们的工具包中添加代码:

static queryAll(): Promise<Array<Employee>> {
    let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
    return new Promise<Array<Employee>>((resolve, reject) => {
      RdbUtils.getStore().query(predicates).then((result) => {
        let employees = new Array<Employee>();
        while (result.goToNextRow()) {
          let employee = new Employee(
            result.getLong(0),
            result.getString(1),
            result.getLong(2),
            result.getDouble(3),
            result.getBlob(4)
          );
          employees.push(employee);
        }
        resolve(employees);
      }).catch((error) => {
        reject(error)
      })
    })
  }

该方法将通过RdbUtils.getStore().query(predicates)获取的结果集封装到Employee类中,然后通过Promise进行返回。

实体类Employee:

export default class Employee {
  id: number; // 员工ID
  name: string; // 姓名
  age: number | null; // 年龄,允许为null
  salary: number | null; // 工资,允许为null
  codes: Uint8Array | null; // 二进制数据,用于存储 BLOB 类型,允许为null

  constructor(id: number, name: string, age: number | null, salary: number | null, codes: Uint8Array | null) {
    this.id = id;
    this.name = name;
    this.age = age;
    this.salary = salary;
    this.codes = codes;
  }
}

在UI方面代码如下:

import RdbUtils from '../common/rdbUtils/RdbUtils';
@Entry
@Component
struct Index {
  build() {
    Row() {
      Column() {
        ...
        Button('查询数据')
          .onClick(() => {
            RdbUtils.queryAll()
              .then((employees: Array<Employee>) => {
                openDialog('employees: ' + JSON.stringify(employees))
              }).catch((error) => {
              openDialog('error' + error.toString())
            })
          })
        ...
      }
      .width('100%')
    }
    .height('100%')
  }
}
...

效果图:

在这里插入图片描述

7. 修改和删除数据

接口说明:

update

update(values: ValuesBucket, predicates: RdbPredicates):Promise

根据RdbPredicates的指定实例对象更新数据库中的数据,使用Promise异步回调。

参数:
在这里插入图片描述

在工具包中添加:

...
  static deleteById(id: number) {
    let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
    predicates.equalTo('ID', id)
    return RdbUtils.getStore().delete(predicates);
  }

  static updateById(id: number, data: any) {
    let predicates = new relationalStore.RdbPredicates('EMPLOYEE');
    predicates.equalTo('ID', id)
    return RdbUtils.getStore().update(data, predicates);
  }
...

这两个方法,一个是通过id删除数据,另一个是通过id修改数据

在UI层面:

      	Button('修改数据')
          .onClick(() => {
            const valueBucket = {
              'NAME': 'Rose',
              'AGE': 999,
              'SALARY': 100.5,
              'CODES': new Uint8Array([1, 2, 3, 4, 5])
            };
            RdbUtils.updateById(1, valueBucket)
              .then((updateNumber) => {
                openDialog('已更新数据:' + updateNumber.toString())
              }).catch((err) => {
              openDialog(err)
            })
          })

        Button('删除数据')
          .onClick(() => {
            RdbUtils.deleteById(1)
              .then((updateNumber) => {
                openDialog('已删除数据:' + updateNumber.toString())
              }).catch((err) => {
              openDialog(err)
            })
          })

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

8. 删除数据库

调用deleteRdbStore()方法,删除数据库及数据库相关文件。示例代码如下:

export default class EntryAbility extends UIAbility {
  ...
  onDestroy() {
    hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onDestroy');
    relationalStore.deleteRdbStore(this.context, 'RdbTest.db', (err) => {
      if (err) {
        console.error(`Failed to delete RdbStore. Code:${err.code}, message:${err.message}`);
        return;
      }
      console.info('Succeeded in deleting RdbStore.');
    });
  }
  ....
}

这里我在EntryAbility中的onDestroy生命周期函数中调用了删除数据库的操作,这意味着当我们的Ability被销毁的时候,自动将数据库删除。

接口说明:

relationalStore.deleteRdbStore

deleteRdbStore(context: Context, name: string, callback: AsyncCallback): void

删除数据库,使用callback异步回调。

参数:
在这里插入图片描述

写在最后

有很多小伙伴不知道学习哪些鸿蒙开发技术?不知道需要重点掌握哪些鸿蒙应用开发知识点?而且学习时频繁踩坑,最终浪费大量时间。所以有一份实用的鸿蒙(HarmonyOS NEXT)资料用来跟着学习是非常有必要的。

这份鸿蒙(HarmonyOS NEXT)资料包含了鸿蒙开发必掌握的核心知识要点,内容包含了(ArkTS、ArkUI开发组件、Stage模型、多端部署、分布式应用开发、音频、视频、WebGL、OpenHarmony多媒体技术、Napi组件、OpenHarmony内核、openHarmony南向开发、鸿蒙项目实战等等)鸿蒙(HarmonyOS NEXT)技术知识点。

希望这一份鸿蒙学习资料能够给大家带来帮助,有需要的小伙伴自行领取,限时开源,先到先得~无套路领取!!

获取这份完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料

鸿蒙(HarmonyOS NEXT)最新学习路线

在这里插入图片描述

有了路线图,怎么能没有学习资料呢,小编也准备了一份联合鸿蒙官方发布笔记整理收纳的一套系统性的鸿蒙(OpenHarmony )学习手册(共计1236页)与鸿蒙(OpenHarmony )开发入门教学视频,内容包含:ArkTS、ArkUI、Web开发、应用模型、资源分类…等知识点。

获取以上完整版高清学习路线,请点击→纯血版全套鸿蒙HarmonyOS学习资料

《鸿蒙 (OpenHarmony)开发入门教学视频》

在这里插入图片描述

《鸿蒙生态应用开发V3.0白皮书》

在这里插入图片描述

《鸿蒙 (OpenHarmony)开发基础到实战手册》

OpenHarmony北向、南向开发环境搭建

在这里插入图片描述

《鸿蒙开发基础》

●ArkTS语言
●安装DevEco Studio
●运用你的第一个ArkTS应用
●ArkUI声明式UI开发
.……
在这里插入图片描述

《鸿蒙开发进阶》

●Stage模型入门
●网络管理
●数据管理
●电话服务
●分布式应用开发
●通知与窗口管理
●多媒体技术
●安全技能
●任务管理
●WebGL
●国际化开发
●应用测试
●DFX面向未来设计
●鸿蒙系统移植和裁剪定制
……
在这里插入图片描述

《鸿蒙进阶实战》

●ArkTS实践
●UIAbility应用
●网络案例
……
在这里插入图片描述

获取以上完整鸿蒙HarmonyOS学习资料,请点击→纯血版全套鸿蒙HarmonyOS学习资料

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值