NocoBase插件开发入门：从零构建你的第一个业务插件

无代码平台NocoBase（NocoBase是一个极易扩展的无代码/低代码开发平台）的强大之处在于其插件化架构。通过自定义插件，你可以为系统添加业务逻辑、数据处理规则或UI组件，满足企业个性化需求。本文将带你从零开始，通过3个核心步骤完成业务插件开发，并以工作流插件packages/plugins/@nocobase/plugin-workflow/为参考模板，掌握插件开发的标准范式。

一、环境准备与项目结构

1.1 开发环境配置

确保本地已安装Node.js（v16+）和Yarn。通过以下命令克隆项目并安装依赖：

git clone https://gitcode.com/GitHub_Trending/no/nocobase
cd GitHub_Trending/no/nocobase
yarn install

1.2 插件目录结构解析

NocoBase插件采用标准化目录结构，核心文件如下：

packages/plugins/@nocobase/plugin-demo/
├── src/                  # 源代码目录
│   ├── server/           # 服务端代码
│   │   ├── Plugin.ts     # 插件主类
│   │   └── index.ts      # 导出入口
│   └── client/           # 客户端代码（可选）
├── package.json          # 插件配置
└── README.md             # 插件说明文档

官方插件模板提供了基础框架，可通过CLI工具快速生成。

二、插件核心开发步骤

2.1 使用CLI创建插件

通过NocoBase CLI工具生成插件骨架：

yarn nocobase create-plugin plugin-demo

该命令会在packages/plugins/目录下创建插件文件夹，并自动配置依赖关系packages/core/cli/src/plugin-generator.js#L68-L72。

2.2 实现插件主类

插件主类需继承Plugin基类，并重写生命周期方法。以工作流插件为例：

import { Plugin } from '@nocobase/server';

export default class PluginDemoServer extends Plugin {
  async load() {
    // 注册触发器
    this.initTriggers();
    // 注册指令
    this.initInstructions();
    // 注册数据库模型
    this.db.registerModels(this.getModels());
  }

  async beforeLoad() {
    // 初始化数据库连接
    await this.db.authenticate();
  }
}

工作流插件主类展示了完整实现，包括触发器注册、事件监听等高级功能。

2.3 注册业务功能

根据插件类型，可注册以下功能：

• 数据库模型：定义新的数据结构
• API接口：通过this.app.resourcer.define()添加HTTP端点
• 权限规则：使用this.app.acl.registerSnippet()配置权限
• 前端组件：在client目录下开发React组件

三、插件调试与部署

3.1 本地调试

通过以下命令启动开发服务器，插件会自动加载：

yarn dev

修改插件代码后，系统会热重载packages/core/server/src/application.ts#L123-L128。

3.2 打包与发布

执行构建命令生成生产版本：

yarn build:plugin plugin-demo

打包后的插件可通过NocoBase市场安装，或手动复制到plugins/目录。

四、高级实践与资源

4.1 插件间依赖管理

在package.json中声明依赖插件：

{
  "nocobase": {
    "dependencies": ["@nocobase/plugin-users"]
  }
}

确保依赖插件在当前插件加载前初始化packages/core/server/src/plugin-manager.ts#L89-L94。

4.2 官方资源推荐

• 开发文档：README.md
• 插件示例：工作流插件
• API参考：packages/core/sdk/src/index.ts

通过以上步骤，你已掌握NocoBase插件开发的基础流程。建议从简单功能入手，逐步探索触发器、定时任务等高级特性。插件开发完成后，可提交至NocoBase插件市场，与社区共享你的解决方案。