HarmonyOS 數據庫系列之對象關系映射數據庫

作者：陳建朋 2021-09-03 15:41:00

數據庫其他數據庫 OpenHarmony

HarmonyOS對象關系映射(Object Relational Mapping，ORM)數據庫是一款基于SQLite的數據庫框架，屏蔽了底層SQLite數據庫的SQL操作，針對實體和關系提供了增刪改查等一系列的面向對象接口。

[[421543]]

想了解更多內容，請訪問：

51CTO和華為官方合作共建的鴻蒙技術社區

https://harmonyos.51cto.com

前言

鴻蒙提供了非常強大的數據庫操作功能，前面講到了關系型數據庫，是基于關系模型來管理數據的數據庫。

其實鴻蒙還有一種體驗更好，操作更方便的數據庫，對象關系映射數據庫，這種數據庫的好處是直接基于sqlite數據庫架構的，操作sql語句的操作更簡單，可以直接配置進行。

其實這種配置更像做web后臺系統的開發，一個類就是一個表，如果需要添加信息直接更新實體類就行。

簡介

先了解一下概念，概念是一切功能的使用總結。

HarmonyOS對象關系映射(Object Relational Mapping，ORM)數據庫是一款基于SQLite的數據庫框架，屏蔽了底層SQLite數據庫的SQL操作，針對實體和關系提供了增刪改查等一系列的面向對象接口。應用開發者不必再去編寫復雜的SQL語句，以操作對象的形式來操作數據庫，提升效率的同時也能聚焦于業務開發。

在我看來對象關系映射數據庫非常重要的三個組件：

數據庫：被開發者用@Database注解，且繼承了OrmDatabase的類，對應關系型數據庫。
實體對象：被開發者用@Entity注解，且繼承了OrmObject的類，對應關系型數據庫中的表。
對象數據操作接口：包括數據庫操作的入口OrmContext類和謂詞接口(OrmPredicate)。

肯定還有更多的其它方面，以后繼續補充吧。

運作機制

運作機制我查看了一下官網的說明，說了一大堆。其實主要的還是對關系型數據庫的擴展：

對象關系映射數據庫操作是基于關系型數據庫操作接口完成的，實際是在關系型數據庫操作的基礎上又實現了對象關系映射等特性。

全部介紹如下：

對象關系映射數據庫操作是基于關系型數據庫操作接口完成的，實際是在關系型數據庫操作的基礎上又實現了對象關系映射等特性。因此對象關系映射數據庫跟關系型數據庫一樣，都使用SQLite作為持久化引擎，底層使用的是同一套數據庫連接池和數據庫連接機制。
使用對象關系映射數據庫的開發者需要先配置實體模型與關系映射文件。應用數據管理框架提供的類生成工具會解析這些文件，生成數據庫幫助類，這樣應用數據管理框架就能在運行時，根據開發者的配置創建好數據庫，并在存儲過程中自動完成對象關系映射。開發者再通過對象數據操作接口，如OrmContext接口和謂詞接口等操作持久化數據庫。
對象數據操作接口提供一組基于對象映射的數據操作接口，實現了基于SQL的關系模型數據到對象的映射，讓用戶不需要再和復雜的 SQL語句打交道，只需簡單地操作實體對象的屬性和方法。對象數據操作接口支持對象的增刪改查操作，同時支持事務操作等。

對象關系映射數據庫運作機制：

HarmonyOS 數據庫系列之對象關系映射數據庫-鴻蒙HarmonyOS技術社區

從上圖運行機制可以看出，對象關系型數據庫是在關系型數據庫基礎上做了一部分擴展，就是將數據庫的庫和表的創建給簡化了，不需要我們自己去做添加了，配置就行。

這也是數據庫的一種很好的擴展，讓開發更簡單方便。

創建數據庫及其表

數據庫的創建可以根據自己需求，如果在項目啟動就需要創建數據庫，建議在 application中執行啟動操作。

這里我們在每一個 ability中的 onStart 函數中執行如下創建操作：

DatabaseHelper helper = new DatabaseHelper(this); 
OrmContext connect = helper.getOrmContext("UserDatabase", "UserDatabase.db", UserDatabase.class);

getOrmContext 參數說明：

1、別名

2、數據庫名

3、對象-對應關系型數據庫。

還有一點需要注意，最后的參數就是表的創建，如果要創建多張表，可以添加多個實體類。

來看看如下的對象關系：

package com.hadiidbouk.databasemanager.database.object; 
import ohos.data.orm.OrmDatabase; 
import ohos.data.orm.annotation.Database; 
/** 
 * Database 
 */ 
@Database( 
        entities = {User.class}, 
        version = 1) 
public abstract class UserDatabase extends OrmDatabase { }

@Database注解，繼承了OrmDatabase的類，對應關系型數據庫。

數據對象：

每一個數據對象就是一個表，字段信息可以根據需求更新變化。

/** 
 * user Table 
 */ 
@Entity(tableName = "user") 
public class User extends OrmObject { 
    @PrimaryKey() 
    private Long formId; 
    private String formName; 
    private Integer dimension; 
 
    public User(Long formId, String formName, Integer dimension) { 
        this.formId = formId; 
        this.formName = formName; 
        this.dimension = dimension; 
    } 
 
    public User() { } 
 
    public Integer getDimension() { 
        return dimension; 
    } 
 
    public void setDimension(Integer dimension) { 
        this.dimension = dimension; 
    } 
 
    public Long getFormId() { 
        return formId; 
    } 
 
    public void setFormId(Long formId) { 
        this.formId = formId; 
    } 
 
    public String getFormName() { 
        return formName; 
    } 
 
    public void setFormName(String formName) { 
        this.formName = formName; 
    } 
}

用@Entity注解，且繼承了OrmObject的類，對應關系型數據庫中的表。

數據庫使用

在使用數據庫之前最好是整理一個工具類，所有的操作都放在工具類中，這樣調用和擴展都方便了。

我就對數據庫的有關操作做了一個封裝，目前也是比較簡單的，只是做了增，刪，改，查等操作。

關系對象型數據庫的操作工具類：

/** 
 * Database Operations 
 * 
 * @since 2021-06-23 
 */ 
public class DatabaseUtils { 
    /** 
     * add card info 
     * 
     * @param form card object 
     * @param connect data connection 
     */ 
    public static void insertForm(User form, OrmContext connect) { 
        connect.insert(form); 
        connect.flush(); 
    } 
 
    /** 
     * query database 
     * 
     * @param connect data connection 
     * @return database 
     */ 
    public static List<User> queryForm(OrmContext connect){ 
        // 從數據庫中獲取信息 
        OrmPredicates ormPredicates = new OrmPredicates(User.class);// 搜索實例 
        List<User> formList = connect.query(ormPredicates); 
        if (formList.size() <= 0) { 
            return formList; 
        } 
        for (User form : formList) { 
            // 遍歷 
            System.out.println("FormId = "+form.getFormId()+" = FormName"+form.getFormName()+" = Dimension"+form.getDimension()); 
        } 
        return formList; 
    } 
 
    /** 
     * update database 
     * 
     * @param connect 數據庫實體 
     * @param user user 
     */ 
    public static void updateForms(OrmContext connect,User user) { 
        // 從數據庫中獲取信息 
        ValuesBucket valuesBucket = new ValuesBucket(); 
        valuesBucket.putString("formName", user.getFormName()); 
        valuesBucket.putInteger("dimension", user.getDimension()); 
        OrmPredicates update = connect.where(User.class).equalTo("formId", user.getFormId()); 
        connect.update(update, valuesBucket); 
    } 
 
    /** 
     * delete data 
     * 
     * @param formId form id 
     * @param connect data connection 
     */ 
    public static void deleteFormData(long formId, OrmContext connect) { 
        OrmPredicates where = connect.where(User.class); 
        where.equalTo("formId", formId); // 在數據庫的“user”表中查詢formId為“”的User對象列表 
        List<User> query = connect.query(where); 
        if (!query.isEmpty()) { 
            connect.delete(query.get(0)); 
            connect.flush(); 
        } 
    } 
}

1、數據庫操作的入口OrmContext類 ,進行數據庫操作

2、謂詞接口(OrmPredicate)，進行實例的制定(例如：條件查詢，條件刪除)

3、ValuesBucket 實例

操作使用：

創建一個 ability，該類是需求操作界面類。

public class DatabaseObjectAbility extends Ability implements Component.ClickedListener { 
    private DatabaseHelper helper = new DatabaseHelper(this); 
    private OrmContext connect; 
 
    @Override 
    public void onStart(Intent intent) { 
        super.onStart(intent); 
        super.setUIContent(ResourceTable.Layout_ability_database_object); 
        connect = helper.getOrmContext("UserDatabase", "UserDatabase.db", UserDatabase.class); 
        findComponentById(ResourceTable.Id_xinzeng_db).setClickedListener(this); 
        findComponentById(ResourceTable.Id_chaxun_db).setClickedListener(this); 
        findComponentById(ResourceTable.Id_xiugai_db).setClickedListener(this); 
        findComponentById(ResourceTable.Id_shagnchu_db).setClickedListener(this); 
    } 
 
    @Override 
    public void onClick(Component component) { 
        switch (component.getId()){ 
            case ResourceTable.Id_xinzeng_db: 
                insertDB(); 
                break; 
            case ResourceTable.Id_chaxun_db: 
                DatabaseUtils.queryForm(connect); 
                break; 
            case ResourceTable.Id_xiugai_db: 
                User form = new User(100l, "陳建朋", 101); 
                DatabaseUtils.updateForms(connect,form); 
                break; 
            case ResourceTable.Id_shagnchu_db: 
                DatabaseUtils.deleteFormData(100l,connect); 
                break; 
            default: 
        } 
    } 
    private void insertDB(){ 
        // 存儲卡片信息 
        User form = new User(100l, "陳建朋", 101); 
        try { 
            DatabaseUtils.insertForm(form, connect); 
        } catch (Exception e) { 
            DatabaseUtils.deleteFormData(form.getFormId(), connect); 
        } 
    }

注意：如果使用注解處理器的模塊為“com.huawei.ohos.hap”模塊，則需要在模塊的“build.gradle”文件的“ohos”節點中添加以下配置：

ohos { 
   compileSdkVersion 5 
   defaultConfig { 
       compatibleSdkVersion 5 
   } 
   buildTypes { 
       release { 
           proguardOpt { 
               proguardEnabled false 
               rulesFiles 'proguard-rules.pro' 
           } 
       } 
   } 
   compileOptions { annotationEnabled true } // 數據庫使用必備 
}