天天看點

#夏日挑戰賽#OpenHarmony JS 關系型資料庫使用示例

本文正在參加星光計劃3.0–夏日挑戰賽

作者:杜晨陽

概述

在應用開發的過程中,資料存儲是一項重要功能。那麼在鴻蒙系統中,作為資料持久化存儲之一的資料庫是怎麼使用的呢?

下面給大家帶來的是基于api8版本的資料庫使用示例

導入子產品

import dataRdb from '@ohos.data.rdb'
           

關系型資料庫的使用

1、建立資料庫及表格

const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS " + TABLE_NAME
        + "(ID INTEGER PRIMARY KEY AUTOINCREMENT,NAME TEXT NOT NULL,AGE NUMBER,SCORE BLOB)";
    dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
        // @ts-ignore 建立資料庫中表格
        rdbStore.executeSql(SQL_CREATE_TABLE);
    })
           

2、增/删/改/查資料庫資料

新增資料

dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
        rdbStore.insert(TABLE_NAME, info, function (err, ret) {
        })
    })
           

删除資料

dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
        let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
        predicates.equalTo("NAME", info);
        rdbStore.delete(predicates, function (err, rows) {
        })
    })
           

更新資料

dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
        let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
        predicates.equalTo("NAME", oldInfo.name).equalTo("AGE", oldInfo.age);
        rdbStore.update(newInfo, predicates, function (err, ret) {
        })
    })
           

查詢資料

dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
        let datas = [];
        let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
        rdbStore.query(predicates, ["NAME", "AGE", "SCORE"],function (err, resultSet) {
        })
   })

 或者使用sql語句
    dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
        let datas = [];
        rdbStore.querySql("SELECT * FROM " + TABLE_NAME, [], function (err, resultSet) {
        })
   })
           

注:增删改查也可以執行sql語句,但是沒有傳回值,示例:

dataRdb.deleteRdbStore(STORE_CONFIG.name, function (err, rdbStore) {
        rdbStore.executeSql("DELETE FROM EMPLOYEE", null, function () {
        })
    })
           

3、删除資料庫

dataRdb.deleteRdbStore(STORE_CONFIG.name, function (err, rdbStore) {
    })
           

完整代碼示例

// @ts-nocheck
import dataRdb from '@ohos.data.rdb'

const STORE_VERSION = 1;
const STORE_CONFIG = {
    name: "RdbLocal.db"
}
const TABLE_NAME = "table_name";
const TAG = "RdbManager";

/**
 * 資料庫管理類,基于API 8版本
 *   Info:{
        //名稱:String
        name:"小明",
        //年齡:Number
        age : "18",
        //分數: BLOB 整型數組
        score: new Uint8Array([60, 70, 80]),
   }
 */
export default class RdbManager {
    /**
     * 初始化資料庫及表,在應用啟動時必須先調用,
     * 調用方式:RdbManager.createRdb();
     */
    createRdb() {
        const SQL_CREATE_TABLE = "CREATE TABLE IF NOT EXISTS " + TABLE_NAME
        + "(ID INTEGER PRIMARY KEY AUTOINCREMENT,NAME TEXT NOT NULL,AGE NUMBER,SCORE BLOB)";
        dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
            // @ts-ignore 建立資料庫中表格
            rdbStore.executeSql(SQL_CREATE_TABLE);
            console.info(TAG + ' createRdb table done. ' + err);
        })
    }
    /**
     * 删除資料庫
     * 調用方式:RdbManager.createRdb();
     */
    deleteRdb() {
        dataRdb.deleteRdbStore(STORE_CONFIG.name, function (err, rdbStore) {
            console.info(TAG + '  delete store done. ' + err)
        })
    }

    /**
     * 添加資料
     * return 執行結果 true 添加成功   false 添加失敗
     *
     * 調用方式:RdbManager.insertInfo(info,function (result) {});
     */
    insertInfo(info, callback) {
        dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
            rdbStore.insert(TABLE_NAME, info, function (err, ret) {
                console.info(TAG + ' insertInfo table done. ' + "  err:" + err + "  ret:" + ret);
                let result = false;
                if (ret > 0) {
                    result = true;
                }
                callback(result);
            })
        })
    }
    /**
     * 删除資料
     * return 執行結果 true 删除成功   false 删除失敗
     *
     * 調用方式:RdbManager.deleteInfo(info,function (result) {});
     */
    deleteInfo(info, callback) {
        dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
            let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
            predicates.equalTo("NAME", info);
            rdbStore.delete(predicates, function (err, rows) {
                console.log(TAG + "  deleteInfo table done. rows: " + rows)
                let result = false;
                if (rows > 0) {
                    result = true;
                }
                callback(result);
            })
        })
    }

    /**
     * 更新資料
     * return 執行結果 true 更新成功   false 更新失敗
     *
     * 調用方式:RdbManager.updateInfo(oldInfo, newInfo,function (result) {});
     * oldInfo,newInfo 都是Info類型
     */
    updateInfo(oldInfo, newInfo, callback) {
        dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
            let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
            predicates.equalTo("NAME", oldInfo.name).equalTo("AGE", oldInfo.age);
            rdbStore.update(newInfo, predicates, function (err, ret) {
                console.log(TAG + "  updateInfo table done. row count: " + ret)
                let result = false;
                if (ret > 0) {
                    result = true;
                }
                callback(result);
            })
        })
    }

    /**
     * 查詢全部資料,使用sql語句
     * return array Info
     *
     * 調用方式:RdbManager.queryAllInfoBySql(function (result) {});
     */
    queryAllInfoBySql(callback) {
        dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
            let datas = [];
            rdbStore.querySql("SELECT * FROM " + TABLE_NAME, [], function (err, resultSet) {
                console.log(TAG + "  queryAllInfoBySql table done: " + resultSet.rowCount + "   resultSet.isEnded:" + resultSet.isEnded);
                //rowCount 代表查詢結果總數量
                if (resultSet.rowCount === 0) {
                    resultSet.close()
                    resultSet = null;
                    callback(datas);
                }
                while (!resultSet.isEnded) {
                    console.log(TAG + "  queryAllInfoBySql  resultSet.rowIndex:" + resultSet.rowIndex);
                    //rowIndex 預設角标是-1
                    if (resultSet.rowIndex < 0) {
                        resultSet.goToFirstRow();
                    } else {
                        resultSet.goToNextRow();
                    }
                    var name = resultSet.getString((resultSet.getColumnIndex("NAME")));
                    var age = resultSet.getLong((resultSet.getColumnIndex("AGE")));
                    var score = resultSet.getBlob((resultSet.getColumnIndex("SCORE")));
                    let info = {}
                    info.name = name;
                    info.age = age;
                    info.score = score;
                    datas.push(info);
                    if (resultSet.isAtLastRow) {
                        resultSet.close()
                        resultSet = null;
                        callback(datas);
                    }
                }
            })
        })
    }
    /**
     * 查詢全部資料,使用查詢api
     * return array Info
     *
     * 調用方式:RdbManager.queryAllInfo(function (result) {});
     */
    queryAllInfo(callback) {
        dataRdb.getRdbStore(STORE_CONFIG, STORE_VERSION, function (err, rdbStore) {
            let datas = [];
            let predicates = new dataRdb.RdbPredicates(TABLE_NAME);
            rdbStore.query(predicates, ["NAME", "AGE", "SCORE"],
                function (err, resultSet) {
                    console.log(TAG + "  queryAllInfo table done: " + resultSet.rowCount);
                    if (resultSet.rowCount === 0) {
                        resultSet.close()
                        resultSet = null;
                        callback(datas);
                    }
                    while (!resultSet.isEnded) {
                        if (resultSet.rowIndex < 0) {
                            resultSet.goToFirstRow();
                        } else {
                            resultSet.goToNextRow();
                        }
                        var name = resultSet.getString((resultSet.getColumnIndex("NAME")));
                        var age = resultSet.getLong((resultSet.getColumnIndex("AGE")));
                        var score = resultSet.getBlob((resultSet.getColumnIndex("SCORE")));
                        let info = {
                            name: name,
                            age: age,
                            score: score,
                        }
                        datas.push(info);
                        if (resultSet.isAtLastRow) {
                            resultSet.close()
                            resultSet = null;
                            callback(datas);
                        }
                    }
                })
        })
    }
}
           

調用示例

import RdbManager from '../../RdbManager.js';

const TAG = "rdbDemo";
let mRdbManager = new RdbManager();

export default {
    data: {
       
    },
    createRdb: function () {
        mRdbManager.createRdb();
    },
    inseatRdb: function () {
        let info = {
            name: "張三",
            age: 26,
            score: new Uint8Array([100, 99, 100]),
        }
        let info2 = {
            name: "李四",
            age: 22,
            score: new Uint8Array([60, 88, 70]),
        }
        mRdbManager.insertInfo(info, function (result) {
            console.log(TAG + " insertInfo1  result:" + result)
        });
        mRdbManager.insertInfo(info2, function (result) {
            console.log(TAG + " insertInfo2  result:" + result)
        });
    },
    deleteRdb: function () {
        mRdbManager.deleteInfo("張三", function (result) {
            console.log(TAG + " deleteInfo  result:" + result)
        });
    },
    updateRdb: function () {
        let oldInfo = {
            name: "李四",
            age: 22,
        }
        let newInfo = {
            age: 18,
            score: new Uint8Array([100, 100, 100]),
        }
        mRdbManager.updateInfo(oldInfo, newInfo, function (result) {
            console.log(TAG + " deleteInfo  result:" + result)
        });
    },
    queryRdb: function () {
        mRdbManager.queryAllInfo(function (result) {
            console.log(TAG + "  queryRdb result.length:" + result.length);
            result.forEach(item => {
                console.log(TAG + " queryRdb  item.name:" + item.name + "  item.age:" + item.age + "  item.score:" + item.score)
            })
        });
    },
}
           

總結

以上代碼示例可在DevEco Studio 3.0 Beta1 使用Remote Emulator P40 Pro API7版本示範

最後跟大家分享一些開發過程中的注意事項

1、目前針對于資料庫版本更新,沒有提供對應接口可以直接調用。如有需要,可以嘗試通過手寫sql語句實作版本更新功能。

2、在資料庫表格中插入資料時,支援的資料字段類型包括ValueType(number、string、boolean)、Uint8Array、null 。

但是在查詢結果的結果集ResultSet中,未提供getBoolean方法,不推薦插入boolean類型資料。

3、在插入string類型資料時,注意類型比對,不要直接将number資料存入資料庫中string字段下。

已知問題:将number 類型 99存入string類型字段後,資料庫自動将該資料變更為“99.00”。通過ResultSet.getString()傳回值為“99.00”

參考資料

關系型資料庫

更多原創内容請關注:深開鴻技術團隊

入門到精通、技巧到案例,系統化分享HarmonyOS開發技術,歡迎投稿和訂閱,讓我們一起攜手前行共建鴻蒙生态。