OpenHarmony關(guān)系型數(shù)據(jù)庫(kù)封裝前的知識(shí)要點(diǎn)
??想了解更多關(guān)于開源的內(nèi)容,請(qǐng)?jiān)L問(wèn):??
1、概述
關(guān)系型數(shù)據(jù)庫(kù)(Relational Database, 以下簡(jiǎn)稱RDB)是一種基于關(guān)系模型來(lái)管理數(shù)據(jù)的數(shù)據(jù)庫(kù),是在SQLite基礎(chǔ)上提供一套完整的對(duì)本地?cái)?shù)據(jù)庫(kù)進(jìn)行管理的機(jī)制,為開發(fā)者提供無(wú)需編寫原生SQL語(yǔ)句即可實(shí)現(xiàn)數(shù)據(jù)增、刪、改、查等接口,同時(shí)開發(fā)者也可以直接運(yùn)行原生SQL語(yǔ)句來(lái)滿足復(fù)雜的場(chǎng)景需要。關(guān)系型數(shù)據(jù)庫(kù)在應(yīng)用卸載之后,才會(huì)被自動(dòng)清除。
2、運(yùn)作機(jī)制
RDB對(duì)外提供通用的接口,底層使用SQLite作為持久化存儲(chǔ)引擎,支持SQLite具有的所有數(shù)據(jù)庫(kù)特性。SQLite是一個(gè)進(jìn)程內(nèi)的庫(kù),具有自給自足、無(wú)服務(wù)、零配置、事務(wù)性特性的SQL數(shù)據(jù)庫(kù)引擎。RDB包括但不限于事務(wù)、索引、視圖、觸發(fā)器、外鍵、參數(shù)化查詢和預(yù)編譯SQL語(yǔ)句。
3、使用場(chǎng)景
- 通訊錄
- 記事本
- 計(jì)算器歷史記錄
- App用戶登錄信息
- App主題
- …
4、流程
5、詳細(xì)步驟
RDB對(duì)開發(fā)者提供的接口大部分為異步接口,均有??callback?
?和??Promise?
?兩種返回形式,接下來(lái)將會(huì)一一介紹。
(1)導(dǎo)入模塊
(2)配置數(shù)據(jù)庫(kù)相關(guān)信息
創(chuàng)建數(shù)據(jù)庫(kù)時(shí)需要配置數(shù)據(jù)庫(kù)相關(guān)信息,RDB提供管理關(guān)系型數(shù)據(jù)庫(kù)配置的StoreConfig接口,其參數(shù)如表5-1所示:
表5-1 關(guān)系型數(shù)據(jù)庫(kù)配置參數(shù).
名稱 | 類型 | 必填 | 說(shuō)明 |
name | string | 是 | 數(shù)據(jù)庫(kù)文件名 |
securityLevel | SecurityLevel(詳見表5-2) | 是 | 設(shè)置數(shù)據(jù)庫(kù)安全級(jí)別 |
encrypt | boolean | 否 | 指定數(shù)據(jù)庫(kù)是否加密。 true:加密。 false:非加密。 |
表5-2 數(shù)據(jù)庫(kù)的安全級(jí)別枚舉。
名稱 | 值 | 說(shuō)明 |
S1 | 1 | 數(shù)據(jù)庫(kù)安全級(jí)別為低級(jí)別,當(dāng)數(shù)據(jù)泄露時(shí)會(huì)產(chǎn)生較低影響。如包含壁紙等系統(tǒng)數(shù)據(jù)的數(shù)據(jù)庫(kù)。 |
S2 | 2 | 數(shù)據(jù)庫(kù)安全級(jí)別為中級(jí)別,當(dāng)數(shù)據(jù)泄露時(shí)會(huì)產(chǎn)生較大影響。如包含錄音、視頻等用戶生成數(shù)據(jù)或通話記錄等信息的數(shù)據(jù)庫(kù)。 |
S3 | 3 | 數(shù)據(jù)庫(kù)安全級(jí)別為高級(jí)別,當(dāng)數(shù)據(jù)泄露時(shí)會(huì)產(chǎn)生重大影響。如包含用戶運(yùn)動(dòng)、健康、位置等信息的數(shù)據(jù)庫(kù)。 |
S4 | 4 | 數(shù)據(jù)庫(kù)安全級(jí)別為關(guān)鍵級(jí)別,當(dāng)數(shù)據(jù)泄露時(shí)會(huì)產(chǎn)生嚴(yán)重影響。如包含認(rèn)證憑據(jù)、財(cái)務(wù)數(shù)據(jù)等信息的數(shù)據(jù)庫(kù)。 |
(3)創(chuàng)建數(shù)據(jù)庫(kù)
和MySQL、Oracle等數(shù)據(jù)庫(kù)類似,在使用之前需要先創(chuàng)建數(shù)據(jù)庫(kù),RDB提供了getRdbStore()方法用于創(chuàng)建數(shù)據(jù)庫(kù),該方法需要傳入應(yīng)用上下文Context和數(shù)據(jù)庫(kù)配置信息StoreConfig兩個(gè)參數(shù),該方法有callback和Promise兩種返回形式,如表5-3所示。表5-3 數(shù)據(jù)庫(kù)創(chuàng)建方法。
方法名 | 描述 |
getRdbStore(context: Context, config: StoreConfig, callback: AsyncCallback<RdbStore>): void | 獲得一個(gè)相關(guān)的RdbStore,操作關(guān)系型數(shù)據(jù)庫(kù)。 context: 應(yīng)用上下文 config: 數(shù)據(jù)庫(kù)配置信息 callback: 回調(diào)函數(shù),返回RdbStore對(duì)象 |
getRdbStore(context: Context, config: StoreConfig): Promise<RdbStore> | 獲得一個(gè)相關(guān)的RdbStore,操作關(guān)系型數(shù)據(jù)庫(kù)。 context: 應(yīng)用上下文 config: 數(shù)據(jù)庫(kù)配置信息 Promise<RdbStore>: Promise對(duì)象,返回RdbStore對(duì)象 |
注:RDB不僅提供了數(shù)據(jù)庫(kù)創(chuàng)建的方法,同時(shí)還提供了刪除數(shù)據(jù)庫(kù)方法,可以調(diào)用deleteRdbStore()方法進(jìn)行數(shù)據(jù)庫(kù)刪除,使用方式和getRdbStore()方法類似。
(4)數(shù)據(jù)表操作
創(chuàng)建數(shù)據(jù)庫(kù)后,獲取到RdbStore實(shí)例。RdbStore提供管理RDB方法的接口,在使用其增、刪、改、查等接口之前,需要使用executeSql接口初始化數(shù)據(jù)表結(jié)構(gòu)和相關(guān)數(shù)據(jù)。
創(chuàng)建數(shù)據(jù)表
executeSql()方法執(zhí)行包含指定參數(shù)但不返回值得SQL語(yǔ)句,有callback和Promise兩種形式,如表5-4所示。
表5-4 創(chuàng)建數(shù)據(jù)表方法:
方法名 | 描述 |
executeSql(sql: string,bindArgs: Array<ValueType>, callback: AsyncCallback<void>): void | 執(zhí)行包含指定參數(shù)但不返回值得SQL語(yǔ)句。 sql: 指定要執(zhí)行得SQL語(yǔ)句 bindArgs: SQL語(yǔ)句中參數(shù)的值 callback: 回調(diào)函數(shù) |
executeSql(sql: string,bindArgs: Array<ValueType>): Promise<void> | 執(zhí)行包含指定參數(shù)但不返回值得SQL語(yǔ)句。 sql: 指定要執(zhí)行得SQL語(yǔ)句 bindArgs: SQL語(yǔ)句中參數(shù)的值 Promise<void>: 無(wú)返回結(jié)果的Promise對(duì)象 |
注:表中的ValueType用于表示允許的數(shù)據(jù)字段類型,當(dāng)前僅支持表示值類型為數(shù)字的number,表示值類型為字符的string,表示值類型為布爾值的boolean。
新增數(shù)據(jù)
RdbStore提供了單條數(shù)據(jù)插入和批量數(shù)據(jù)插入兩種為數(shù)據(jù)表新增數(shù)據(jù)的方法,如表5-5所示。
表5-5 新增數(shù)據(jù)方法:
方法名 | 描述 |
insert(table: string, values: ValuesBucket, callback: AsyncCallback<number>):void | 向表中插入一行數(shù)據(jù)。 table: 插入數(shù)據(jù)的目標(biāo)表名稱 values: 插入到表中的數(shù)據(jù)行 callback: 回調(diào)函數(shù)。插入成功,返回行ID,否則返回-1 |
insert(table: string, values: ValuesBucket): Promise<number> | 向表中插入一行數(shù)據(jù)。 table: 插入數(shù)據(jù)的目標(biāo)表名稱 values: 插入到表中的數(shù)據(jù)行 Promise<number>: Promise對(duì)象。插入成功,返回行ID,否則返回-1 |
batchInsert(table: string, values: Array<ValuesBucket>, callback: AsyncCallback<number>):void | 向表中插入一組數(shù)據(jù) table: 插入數(shù)據(jù)的目標(biāo)表名稱 插入到表中的一組數(shù)據(jù) callback: 回調(diào)函數(shù)。插入成功,返回插入的數(shù)據(jù)個(gè)數(shù),否則返回-1 |
batchInsert(table: string, values: Array<ValuesBucket>):Promise<number> | 向表中插入一組數(shù)據(jù) table: 插入數(shù)據(jù)的目標(biāo)表名稱 插入到表中的一組數(shù)據(jù) Promise<number>: Promise對(duì)象。插入成功,返回插入的數(shù)據(jù)個(gè)數(shù),否則返回-1 |
注:表5-5中ValuesBucket是用于存儲(chǔ)鍵值對(duì)的類型,其鍵為string類型,值類型可為ValueType|Uint8Array|null。
更新數(shù)據(jù)
RdbStore提供了根據(jù)RdbPredicates指定實(shí)例對(duì)象和根據(jù)DataSharePredicates指定實(shí)例對(duì)象兩種方式更新數(shù)據(jù)表中的數(shù)據(jù),兩種方式均有callback和Promise形式,如表5-6所示。
RdbPredicates和DataSharePredicates均用于數(shù)據(jù)表中用來(lái)代表數(shù)據(jù)實(shí)體的性質(zhì)、特征或者數(shù)據(jù)實(shí)體之間關(guān)系的詞項(xiàng),主要用于定義數(shù)據(jù)表的操作條件。如設(shè)置根據(jù)賬號(hào)查找用戶信息的條件,或者根據(jù)賬號(hào)修改用戶密碼的條件。兩者區(qū)別在于使用前者需要先指定操作的數(shù)據(jù)表名稱,同時(shí)前者為分布式數(shù)據(jù)操作做了擴(kuò)充。使用后者需要導(dǎo)入新模塊import dataSharePredicates from '@ohos.data.dataSharePredicates'。
表5-6 更新數(shù)據(jù)方法:
方法名 | 描述 |
update(values: ValuesBucket, predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根據(jù)RdbPredicates的指定實(shí)例對(duì)象更新數(shù)據(jù)庫(kù)中的數(shù)據(jù)。 values: 數(shù)據(jù)表中要更新的數(shù)據(jù)行 predicates: RdbPredicates的實(shí)例對(duì)象指定的更新條件 callback: 回調(diào)函數(shù),返回受影響的行數(shù) |
update(values: ValuesBucket, predicates: RdbPredicates):Promise<number> | 根據(jù)RdbPredicates的指定實(shí)例對(duì)象更新數(shù)據(jù)庫(kù)中的數(shù)據(jù)。 values: 數(shù)據(jù)表中要更新的數(shù)據(jù)行 predicates: RdbPredicates的實(shí)例對(duì)象指定的更新條件 Promise<number>: Promise對(duì)象,返回受影響的行數(shù) |
update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>): void | 根據(jù)DataSharePredicates的指定實(shí)例對(duì)象更新數(shù)據(jù)表的數(shù)據(jù)。 table: 更新數(shù)據(jù)表的名稱 values: 數(shù)據(jù)表中要更新的數(shù)據(jù)行 predicates: DataSharePredicates的實(shí)例對(duì)象指定的更新條件 callback: 回調(diào)函數(shù),返回受影響的行數(shù) |
update(table: string, values: ValuesBucket, predicates: dataSharePredicates.DataSharePredicates): Promise<number> | 根據(jù)DataSharePredicates的指定實(shí)例對(duì)象更新數(shù)據(jù)表的數(shù)據(jù)。 table: 更新數(shù)據(jù)表的名稱 values: 數(shù)據(jù)表中要更新的數(shù)據(jù)行 predicates: DataSharePredicates的實(shí)例對(duì)象指定的更新條件 Promise<number>: Promise對(duì)象,返回受影響的行數(shù) |
查詢數(shù)據(jù)
數(shù)據(jù)表數(shù)據(jù)的查詢和更新相似,RdbStore也提供了RdbPredicates和DataSharePredicates兩種方式,如表5-7所示。不同之處在于返回的結(jié)果不同,更新數(shù)據(jù)返回受影響的行數(shù),查詢數(shù)據(jù)返回的數(shù)據(jù)結(jié)果集ResultSet,關(guān)于結(jié)果集詳細(xì)講解將在下一節(jié)介紹。
表5-7 查詢數(shù)據(jù)方法:
方法名 | 描述 |
query(predicates: RdbPredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>): void | 根據(jù)RdbPredicates的指定實(shí)例對(duì)象條件查詢數(shù)據(jù)表中的數(shù)據(jù)。 predicates: RdbPredicates的實(shí)例對(duì)象指定的查詢條件 columns: 查詢的列名稱,為空則表示查詢所有列 callback: 回調(diào)函數(shù),操作成功,返回ResultSet對(duì)象 |
query(predicates: RdbPredicates, columns: Array<string>): Promise<ResultSet> | 根據(jù)RdbPredicates的指定實(shí)例對(duì)象條件查詢數(shù)據(jù)表中的數(shù)據(jù)。 predicates: RdbPredicates的實(shí)例對(duì)象指定的查詢條件 columns: 查詢的列名稱,為空則表示查詢所有列 Promise<ResultSet>: Promise對(duì)象,操作成功,返回ResultSet對(duì)象 |
query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>, callback: AsyncCallback<ResultSet>): void | 根據(jù)DataSharePredicates的指定實(shí)例對(duì)象條件查詢數(shù)據(jù)表中的數(shù)據(jù)。 table: 查詢數(shù)據(jù)表名稱 predicates: DataSharePredicates的實(shí)例對(duì)象指定的查詢條件 columns: 查詢的列名稱,為空則表示查詢所有列 callback: 回調(diào)函數(shù),操作成功,返回ResultSet對(duì)象 |
query(table: string, predicates: dataSharePredicates.DataSharePredicates, columns: Array<string>): Promise<ResultSet> | 根據(jù)DataSharePredicates的指定實(shí)例對(duì)象條件查詢數(shù)據(jù)表中的數(shù)據(jù)。 table: 查詢數(shù)據(jù)表名稱 predicates: DataSharePredicates的實(shí)例對(duì)象指定的查詢條件 columns: 查詢的列名稱,為空則表示查詢所有列 Promise<ResultSet>: Promise對(duì)象,操作成功,返回ResultSet對(duì)象 |
刪除數(shù)據(jù)
表5-8 刪除數(shù)據(jù)方法:
方法名 | 描述 |
delete(predicates: RdbPredicates, callback: AsyncCallback<number>):void | 根據(jù)RdbPredicates指定實(shí)例對(duì)象從數(shù)據(jù)表中刪除數(shù)據(jù) predicates: RdbPredicates實(shí)例對(duì)象指定的刪除條件 callback: 回調(diào)函數(shù),返回受影響的行數(shù) |
delete(predicates: RdbPredicates):Promise<number> | 根據(jù)RdbPredicates指定實(shí)例對(duì)象從數(shù)據(jù)表中刪除數(shù)據(jù) predicates: RdbPredicates實(shí)例對(duì)象指定的刪除條件 Promise<number>: Promise對(duì)象,返回受影響的行數(shù) |
delete(table: string, predicates: dataSharePredicates.DataSharePredicates, callback: AsyncCallback<number>):void | 根據(jù)DataSharePredicates指定實(shí)例對(duì)象從數(shù)據(jù)表中刪除數(shù)據(jù) table: 刪除數(shù)據(jù)的數(shù)據(jù)表名稱 predicates: DataSharePredicates實(shí)例對(duì)象指定的刪除條件 callback: 回調(diào)函數(shù),返回受影響的行數(shù) |
delete(table: string, predicates: dataSharePredicates.DataSharePredicates):Promise<number> | 根據(jù)DataSharePredicates指定實(shí)例對(duì)象從數(shù)據(jù)表中刪除數(shù)據(jù) table: 刪除數(shù)據(jù)的數(shù)據(jù)表名稱 predicates: DataSharePredicates實(shí)例對(duì)象指定的刪除條件 Promise<number>: 回調(diào)函數(shù),返回受影響的行數(shù) |
6、原生SQL操作數(shù)據(jù)表
RdbStore不僅提供了適用于增刪改查簡(jiǎn)單易操作的接口方法,同時(shí)還支持原生SQL語(yǔ)句的操作。
- querySql()方法支持使用指定SQL語(yǔ)句查詢數(shù)據(jù)表中的數(shù)據(jù)。
7、小節(jié)
當(dāng)然RdbStore還提供了其他的方法,諸如在開始執(zhí)行SQL語(yǔ)句之前開啟事務(wù)的beginTransaction()方法、提交已執(zhí)行的SQL語(yǔ)句的commit()方法、回滾已執(zhí)行的SQL語(yǔ)句的rollBack()方法以及用于其他能力的方法。本節(jié)僅對(duì)RDB數(shù)據(jù)庫(kù)的簡(jiǎn)單使用做了講解,其中涉及到RdbPredicates、DataSharePredicates、ResultSet相關(guān)的更多內(nèi)容將在后續(xù)封裝RDB工具類中詳細(xì)介紹。