CloudBeaver插件开发指南：解决模块引用问题与插件创建流程

插件开发环境准备

在开始CloudBeaver插件开发前，需要确保开发环境已正确配置。项目采用Monorepo结构，所有插件都位于webapp/packages目录下。开发前需安装Node.js和Yarn包管理工具，并确保已克隆最新版本的CloudBeaver仓库。

创建新插件的标准流程

1. 插件目录创建 在webapp/packages目录下创建新的插件文件夹，如plugin-new。该目录应包含以下核心文件：

   • package.json：定义插件元数据和依赖
   • manifest.ts：声明插件基本信息
   • src目录：存放插件核心代码
   • tsconfig.json：TypeScript配置文件

2. 插件清单配置 manifest.ts文件是插件的入口声明，需导出一个符合PluginManifest类型的对象。典型配置包括：

   export const manifest: PluginManifest = {
     info: {
       name: 'plugin-new',
       version: '1.0.0',
     },
     providers: [
       () => import('./PluginNewBootstrap').then(m => m.PluginNewBootstrap),
     ],
   };
   

3. 插件引导类实现 创建PluginNewBootstrap.ts文件，实现插件初始化逻辑：

   import { Bootstrap } from '@cloudbeaver/core-di';
   
   export class PluginNewBootstrap extends Bootstrap {
     register() {
       // 插件初始化代码
     }
   }
   

解决模块引用问题的关键技术

在开发过程中常见的"Cannot find module"错误通常由以下原因导致：

1. TypeScript引用未更新 添加新插件后必须执行引用更新命令：

   yarn run update-ts-references
   

2. tsconfig配置缺失 确保product-default/src/tsconfig.json中包含对新插件的引用：

   {
     "references": [
       {
         "path": "../plugin-new/tsconfig.json"
       }
     ]
   }
   

3. 构建系统缓存问题 有时需要清理构建缓存并重新安装依赖：

   yarn clean
   yarn install
   

插件集成最佳实践

1. 模块化设计 将插件功能拆分为独立的服务类，通过依赖注入系统管理

2. 生命周期管理 合理使用Bootstrap类的load和register方法处理初始化顺序

3. 类型安全 为插件API定义清晰的TypeScript接口，确保类型检查有效性

4. 调试技巧 在开发过程中，可通过在register方法中添加日志输出来验证插件加载情况

常见问题排查

当遇到模块加载问题时，建议按以下步骤检查：

1. 确认package.json中的name字段与引用路径完全匹配
2. 检查所有相关的tsconfig.json文件引用关系
3. 验证yarn.lock文件是否包含预期的依赖版本
4. 确保构建系统已正确识别新插件目录

通过遵循这些开发规范和问题解决方法，可以高效地开发CloudBeaver插件并解决模块引用相关问题。