【鸿蒙应用开发——数据库调试】推荐一款最新的HarmonyOS应用数据库调试工 ...

什么是 HarmonyOS Debug Database？

HarmonyOS Debug Database (debug-db) 是一款功能强大的鸿蒙应用开发三方库，方便开发职员在应用步伐 Debug 版本下快速调试应用的关系型数据库 (RdbStore)、用户首选项 (Preferences) 、键值数据库 (KVStore)

你可以点击下面的链接直接使用和获取 HarmonyOS Debug Database：
OpenHarmony：https://ohpm.openharmony.cn/#/cn/detail/@hadss%2Fdebug-db
gitee：https://gitee.com/ohadss/debug-database
与 Android-Debug-Database 相似， HarmonyOS Debug Database
可使开发者以非常简单的方式在欣赏器中直接查看和操纵三种 HarmonyOS 数据库，提升调试效率。
HarmonyOS Debug Database (debug-db) 具有什么功能？

在 debug-db 中，以下所有的功能都可以在不需要对装备进行 Root 操纵（无需Root装备）的环境下使用：

• 查看所有的RdbStore数据库
  
• 查看指定RdbStore数据库中的所有表
  
• 查看RdbStore数据库中指定表的所有数据
  
• 在指定的RdbStore数据库上运行任何SQL查询来创建、删除数据库，或增删改查数据库数据
  
• 直接对RdbStore数据进行增删改查
  
• 下载指定RdbStore对应的数据库文件
  
• 查看所有的Preferences
  
• 查看指定Preferences中所有首选项数据
  
• 直接对Preferences数据进行增删改查
  
• 查看所有的KVStore
  
• 查看指定KVStore中所有键值对数据
  
• 直接对KVStore数据进行增删改查
  

怎样使用 debug-db?

debug-db 的使用非常简单，分为简单使用和进阶使用两种，你可以根据本身的需要进行配置：
下载安装

首先需要对 debug-db 进行下载安装，在 Terminal 中输入以下命令：
ohpm install @hadss/debug-db
若安装乐成，应用的 oh-package.json5文件中会出现：

1. "devDependencies": {
2.     "@hadss/debug-db" : "1.0.0-rc.0"
3. }

复制代码

简单使用

假如你只是想应用 debug-db 的强大功能，可以参考下面的使用方法：

1. import {DebugDB} from @hadss/debug-db;
3. ...
4. const context = getContext(this) as common.UIAbilityContext;
5. DebugDB.initialize(context); // 在Log中访问 http://XXX.XXX.XXX.XXX:8080/index.html

复制代码

进阶使用

当你不渴望在应用的 Release 包中加入 debug-db 的冗余代码，或者期望自定义服务端的启动端口时，可以参考进阶使用：
1、开启条件编译
为了在项目打包时通常不渴望将 Debug 版本使用的三方库打包进 Release 版本的 HAP 包中，首先需要在项目的build-profile.json5 配置文件中加入条件编译 参数，并设置：

1. "buildOption":{
2.     "arkOptions":{
3.         "branchElimination":true
4.     }
5. }

复制代码

关于编译选项的配置，详情可参考：https://developer.huawei.com/consumer/cn/doc/harmonyos-guides-V5/ide-hvigor-build-profile-V5
2、在应用中导入 debug-db，设置 UIAbilityContext 及服务器运行的端口 (默以为8080)
下面为在应用中 ability 的 aboutToApper 阶段动态导入并启动 debug-db 的一个完整示例。你也可以在应用步伐的其他位置启动服务：

1. import {common} from '@kit.AbilityKit';
2. import {DEBUG} from 'BuildProfile';
4. ...
5. aboutToApper():void{
6.     if(DEBUG){
7.         const context = getContext(this) as common.UIAbilityContext;
8.         const port = 8080;
9.         import('@hadss/debug-db').then(async ns => {
10.             await ns.DebugDB.initialize(context,port); // context为必要参数，port为可选参数
11.         })
12.     }
13. }

复制代码

由于已开启了条件编译，编译器会对 BuildProfile 中的 DEBUG 字段进行判断，并根据当前打包的环境 (Debug 或 Release) 对未生效的代码进行编译剪枝，编译天生的 HAP 包中仅包含开发者的项目代码。
3、在欣赏器中访问 DebugDB
当开发者启动应用步伐后，应用后台会自动启动 DebugDB 服务器，若服务乐成启动，则可以在DevEco Studio的Log界面查看到以下日志：

1. You can access DebugDB through http://XXX.XXX.XXX.XXX:8080/index.html

复制代码

日志中的网址即为 DebugDB 运行时的界面首页，另外，你也可以通过 await DebugDB.getDebugDBAddress() 直接获取到 DebugDB 的运行地址。
当应用步伐处于运行状态时，你可以在欣赏器中输入上述地址直接访问服务器，假如你渴望手动开启和关闭服务器，你可以通过 await DebugDB.start() 和 await DebugDB.stop() 直接开启和关闭服务器。
使用 debug-db 时需要关注的点：

• 真机和使用欣赏器的装备需要处于同一个网络环境 (Wifi 或 LAN)
  
• 目前DevEco Studio 中集成的 HarmonyOS 模仿器暂不支持联网，若应用在模仿器启动则无法在外部装备的欣赏器中直接访问 Debug 服务器。
  

以下是 debug-db 的使用效果

RdbStore

Preferences

KVStore

你可以在欣赏器直接观察和操纵HarmonyOS的数据库！