鸿蒙开发（32）arkTS、通过关系型数据库实现数据持久化封装 ...

应用数据持久化

应用数据持久化，是指应用将内存中的数据通过文件或数据库的形式保存到设备上。
HarmonyOS 标准体系支持典范的存储数据形态，包罗用户首选项、键值型数据库、关系型数据库。
通过关系型数据库实现数据持久化

场景介绍

关系型数据库基于SQLite组件，适用于存储包含复杂关系数据的场景，好比一个班级的学生信息，必要包罗姓名、学号、各科成绩等，又或者公司的雇员信息，必要包罗姓名、工号、职位等，由于数据之间有较强的对应关系，复杂水平比键值型数据更高，此时必要利用关系型数据库来持久化保存数据。
大数据量场景下查询数据大概会导致耗时长乃至应用卡死，如有相干操作可参考文档批量数据写数据库场景，且有建议如下：

• 单次查询数据量不超过5000条。
  
• 在TaskPool中查询。
  
• 拼接SQL语句只管简洁。
  
• 合理地分批次查询。
  

基本概念

• 谓词：数据库中用来代表数据实体的性子、特征或者数据实体之间关系的词项，紧张用来界说数据库的操作条件。
  
• 效果集：指用户查询之后的效果聚集，可以对数据进行访问。效果集提供了机动的数据访问方式，可以更方便地拿到用户想要的数据。
  

运作机制

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

约束限制

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

接口说明

以下是关系型数据库持久化功能的相干接口，大部分为异步接口。异步接口均有callback和Promise两种返回形式，下表均以callback形式为例，更多接口及利用方式请见关系型数据库。
接口名称描述getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback): void得到一个RdbStore，操作关系型数据库，用户可以根据本身的需求设置RdbStore的参数，然后通过RdbStore调用相干接口可以执行相干的数据操作。executeSql(sql: string, bindArgs: Array, callback: AsyncCallback):void执行包含指定参数但不返回值的SQL语句。insert(table: string, values: ValuesBucket, callback: AsyncCallback):void向目的表中插入一行数据。update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback):void根据predicates的指定实例对象更新数据库中的数据。delete(predicates: RdbPredicates, callback: AsyncCallback):void根据predicates的指定实例对象从数据库中删除数据。query(predicates: RdbPredicates, columns: Array, callback: AsyncCallback):void根据指定条件查询数据库中的数据。deleteRdbStore(context: Context, name: string, callback: AsyncCallback): void删除数据库。 开发步骤

下面是一个购物车封装示例，包含添加，更新，删除，查询。
1、创建数据模型 CartModel.ets

1. export class CartModel {
2.   id?:number
3.   goods_name?:string
4.   goods_code?:string
5.   goods_price?:number
6.   goods_count?:number
7.   goods_checked?:number
8. }

复制代码

2、封装代码 CartDBUtils.ets

1. import { relationalStore } from '@kit.ArkData'; // 导入模块
2. import { BusinessError } from '@kit.BasicServicesKit';
3. import { CartModel } from '../viewmodel/CartModel'
5. class CartDBUtils {
6.   private rdbStore: relationalStore.RdbStore | null = null
8.   /**
9.    *初始化数据库
10.    * @param context 上下文对象
11.    * @param tableName 创建的表格名字
12.    *
13.    */
14.   initCartDB(context: Context, tableName: string) {
15.     //(1)初始化数据库配置
16.     const STORE_CONFIG: relationalStore.StoreConfig = {
17.       name: 'woniumall.db', // 数据库文件名
18.       securityLevel: relationalStore.SecurityLevel.S1, // 数据库安全级别
19.       // encrypt: false, // 可选参数，指定数据库是否加密，默认不加密
20.       // customDir: 'customDir/subCustomDir', // 可选参数，数据库自定义路径。数据库将在如下的目录结构中被创建：context.databaseDir + '/rdb/' + customDir，其中context.databaseDir是应用沙箱对应的路径，'/rdb/'表示创建的是关系型数据库，customDir表示自定义的路径。当此参数不填时，默认在本应用沙箱目录下创建RdbStore实例。
21.       // isReadOnly: false // 可选参数，指定数据库是否以只读方式打开。该参数默认为false，表示数据库可读可写。该参数为true时，只允许从数据库读取数据，不允许对数据库进行写操作，否则会返回错误码801。
22.     };
23.     //（2）定义sql语句
24.     const SQL_CREATE_TABLE = `CREATE TABLE IF NOT EXISTS ${tableName} (
25.     ID INTEGER PRIMARY KEY AUTOINCREMENT,
26.     GOODS_NAME TEXT NOT NULL,
27.     GOODS_BIG_LOG TEXT,
28.     GOODS_CODE TEXT,
29.     GOODS_PRICE REAL,
30.     GOODS_COUNT INTEGER,
31.     GOODS_CHECKED INTEGER
32.     )`;
33.     //初始化数据库(getRdbStore 异步)
34.     relationalStore.getRdbStore(context, STORE_CONFIG, (err, store) => {
35.       if (err) {
36.         console.error(`获取RdbStore失败. Code:${err.code}, message:${err.message}`);
37.         return;
38.       }
39.       console.info('获取RdbStore成功.');
40.       this.rdbStore = store
41.       // 创建数据表
42.       store.executeSql(SQL_CREATE_TABLE, (error) => {
43.         if (!error) {
44.           console.info(`${tableName}创建成功`);
45.           return;
46.         } else {
47.           console.error(`${tableName}创建失败`);
48.         }
49.       });
50.     })
51.   }
53.   /**
54.    *添加到数据库
55.    * @param tableName
56.    * 注意传参顺序
57.    */
58.   insertDataDB(value: relationalStore.ValuesBucket, tableName: string) {
59.     if (this.rdbStore !== null) {
60.       this.rdbStore.insert(tableName, value, (err: BusinessError, rowId: number) => {
61.         if (err) {
62.           console.error(`往${tableName}中添加数据失败 ${err.code}-${err.name}-${err.message}`)
63.           return;
64.         }
65.         console.log(`往${tableName}中添加数据成功`)
66.       })
67.     }
68.   }
70.   /**
71.    *查询数据库
72.    * param column 投影列["ID","NAME"]
73.    * @param tableName 创建的表格名字
74.    */
75.   async queryDataDB(column: Array<string>, tableName: string, id?: number) {
76.     let predicates2 = new relationalStore.RdbPredicates(tableName);
77.     if (id) {
78.       //筛选条件指数据
79.       predicates2.equalTo('ID', id);
80.     }
81.     let carts: CartModel[] = []
82.     const resultSet = await (this.rdbStore as relationalStore.RdbStore).query(predicates2, column)
83.     console.info(`ResultSet column names: ${resultSet.columnNames}, column count: ${resultSet.columnCount}`);
84.     // resultSet是一个数据集合的游标，默认指向第-1个记录，有效的数据从0开始。
85.     while (resultSet.goToNextRow()) {
86.       const id = resultSet.getLong(resultSet.getColumnIndex('ID'));
87.       const goods_name = resultSet.getString(resultSet.getColumnIndex('GOODS_NAME'));
88.       const goods_code = resultSet.getString(resultSet.getColumnIndex('GOODS_CODE'));
89.       const goods_price = resultSet.getDouble(resultSet.getColumnIndex('GOODS_PRICE'));
90.       const goods_count = resultSet.getLong(resultSet.getColumnIndex('GOODS_COUNT'));
91.       const goods_checked = resultSet.getLong(resultSet.getColumnIndex('GOODS_CHECKED'));
92.       const temp: CartModel = new CartModel()
93.       temp.id = id
94.       temp.goods_name = goods_name
95.       temp.goods_code = goods_code
96.       temp.goods_price = goods_price
97.       temp.goods_count = goods_count
98.       temp.goods_checked = goods_checked
99.       carts.push(temp)
100.     }
101.     // 释放数据集的内存
102.     resultSet.close();
103.     return carts
104.   }
106.   /**
107.    *删除
108.    * @param tableName
109.    * @param id
110.    */
111.   deleteById(tableName: string, id: number,) {
112.     //获取要操作的对象
113.     let predicates1 = new relationalStore.RdbPredicates(tableName)
114.     //通过什么删除
115.     predicates1.equalTo('ID', id)
116.     if (this.rdbStore !== null) {
117.       this.rdbStore.delete(predicates1, (err: BusinessError, rows: number) => {
118.         if (err) {
119.           console.error(`删除购物车失败. Code:${err.code}, message:${err.message}`);
120.           return;
121.         }
122.         console.info(`删除购物车成功: ${rows}`);
123.       })
124.     }
125.   }
127.   /**
128.    * 修改
129.    * @param tableName
130.    * @param id 修改的商品编号
131.    * @param value 修改的字段
132.    */
133.   updateById(tableName: string, id: number, value: relationalStore.ValuesBucket) {
134.     //获取要操作的对象
135.     let predicates1 = new relationalStore.RdbPredicates(tableName)
136.     //通过什么删除
137.     predicates1.equalTo('ID', id)
138.     if (this.rdbStore !== null) {
139.       this.rdbStore.update(value, predicates1, (err: BusinessError, rows: number) => {
140.         if (err) {
141.           console.error(`修改购物车失败. Code:${err.code}, message:${err.message}`);
142.           return;
143.         }
144.         console.info(`修改购物车成功: ${rows}`);
145.       })
146.     }
147.   }
148. }
150. const cartDBUtils = new CartDBUtils()
152. export { cartDBUtils }

复制代码

3、在EntryAbility.ets利用注册初始化仓库

1. import { cartDBUtils } from '../utils/CartDBUtils'
2. onWindowStageCreate(windowStage: window.WindowStage): void {
3.   //加载数据库
4.   cartDBUtils.initCartDB(this.context, "MYCART")
5.   //加载窗口
6.   hilog.info(0x0000, 'testTag', '%{public}s', 'Ability onWindowStageCreate');
8.   windowStage.loadContent('pages/Page02_GuidePage', (err) => {
9.     if (err.code) {
10.       hilog.error(0x0000, 'testTag', 'Failed to load the content. Cause: %{public}s', JSON.stringify(err) ?? '');
11.       return;
12.     }
13.     hilog.info(0x0000, 'testTag', 'Succeeded in loading the content.');
14.   });
15. }

复制代码

4、添加到购物车

1. import { cartDBUtils } from '../utils/CartDBUtils'
2. @Entry
3. @Component
4. struct Page03_Detail {
5.   addCart = () => {
6.     const valueBucket1: relationalStore.ValuesBucket = {
7.       'GOODS_NAME': this.detail.goods_name,
8.       'GOODS_BIG_LOG': this.detail.goods_big_logo,
9.       'GOODS_CODE': this.detail.goods_id,
10.       'GOODS_PRICE': Number(this.detail.goods_price),
11.       'GOODS_COUNT': 1,
12.       'GOODS_CHECKED': 0,
13.     }
14.     //调用户数库，保存数据
15.     cartDBUtils.insertDataDB(valueBucket1,"MYCART")
16.   }
17.   build() {
18.           Button('修改').onClick(() => {
19.              this.addCart()
20.           })
21.   }
22. }

复制代码

5、在Texting.ets利用测试

1. import { cartDBUtils } from '../utils/CartDBUtils'
2. import { relationalStore } from "@kit.ArkData"
3. import {CartModel} from '../viewmodel/CartModel'
4. // xxx.ets
5. @Entry
6. @Component
7. struct GridExample {
8.   @State myId: number = 0
9.   @State count: number = 0
10.   @State cartList:CartModel[] =[]
12.   aboutToAppear(): void {
13.     this.findDataByDB()
14.   }
15.   findDataByDB = async ()=>{
16.     const res = await cartDBUtils.queryDataDB(["ID","GOODS_NAME","GOODS_BIG_LOG","GOODS_CODE","GOODS_PRICE","GOODS_COUNT","GOODS_CHECKED"],"MYCART")
17.     this.cartList = res
18.   }
19.   build() {
20.     Column() {
21.       TextInput({ placeholder: "请输入要删除的编号", text: $$this.myId })
22.       Button('删除').onClick(() => {
23.         cartDBUtils.deleteById("MYCART", this.myId)
24.       })
26.       TextInput({ placeholder: "请输入要修改的编号", text: $$this.myId })
27.       TextInput({ placeholder: "请输入购买数量", text: $$this.count })
28.       Button('修改').onClick(() => {
29.         const updateColum: relationalStore.ValuesBucket = {
30.           'GOODS_COUNT': this.count
31.         }
32.         cartDBUtils.updateById("MYCART", this.myId, updateColum)
33.       })
35.       List() {
36.         ForEach(this.cartList,(item:CartModel)=>{
37.           ListItem() {
38.             Column() {
39.               Text(`ID:${item.id}`)
40.               Text(`goods_name:${item.goods_name}`)
41.               Text(`goods_count:${item.goods_count}`)
42.             }
43.           }
44.           .width("100%")
45.           .height(120)
46.           .borderRadius(10)
47.           .backgroundColor(Color.White)
48.         })
49.       }
50.     }
51.   }
52. }

复制代码

参考文档：通过关系型数据库实现数据持久化

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。