中国 帮助

插件开发

在 Wujies 无界平台上,一个业务应用就是一个插件。 平台本身不包含业务代码,只负责把插件装进来、跑起来、卸下去。 这一章从「新建一个插件」讲到「打出一个能安装的包」。读完之后,你应该能独立完成: 新建骨架 → 构建产物 → 本地安装

插件开发
封面

> 本文整理自平台文档 docs/wujies/5.x/platform/plugin/index.mdx,用于站点内容演示。

(https://console.wujies.cn/remote-apps/cms-assets/doc-989f1d66714b-cover.svg)

在 Wujies 无界平台上,一个业务应用就是一个插件。 平台本身不包含业务代码,只负责把插件装进来、跑起来、卸下去。

这一章从「新建一个插件」讲到「打出一个能安装的包」。读完之后,你应该能独立完成: 新建骨架 → 构建产物 → 本地安装 → 开发调试 → 打包发布。

直接看 [快速开始](/docs/wujies/5.x/platform/plugin/quickstart),10 分钟做出第一个能调通的插件。 已经装好平台、只想换个方式开发的,看 [可视化开发台](/docs/wujies/5.x/platform/plugin/console)。

为什么是插件

装卸全程不重启宿主。

  • 平台极小,应用外置。 新增业务模块不需要改平台一行 Java 代码,也不需要在平台里新建 *-api 契约模块。
  • 一个应用就是一个自包含工程。 实体、Mapper、Service、Controller、建表脚本、app.json、前端页面,
  • 运行期装载。 宿主用独立的 PluginClassLoader 和子 Spring 上下文加载插件,支持热加载与卸载;

一个插件由四部分组成

wujies/plugins/wujies-demo-plugin/      ① 一个插件一个独立 git 仓库
├── app.json                            ② 应用清单:编码、版本、产物、菜单
├── pom.xml                             后端工程(父 POM 由 Maven 仓库提供)
├── migrations/                         ③ 数据库迁移:建表 / 种子数据
│   └── 01-create-demo-item.sql
├── src/main/java/cn/wujies/demo/
│   ├── controller/                     HTTP 接口,挂在 /demo/**
│   ├── domain/ + bo/ + vo/             实体与出入参
│   ├── mapper/                         Mapper 接口(XML 随产物走)
│   └── service/ + impl/                业务逻辑
└── frontend/                           ④ 前端远程应用(独立 npm 工程)
    ├── vite.config.ts                  defineRemoteApp({ appCode: 'demo' })
    └── src/
        ├── index.ts                    入口契约:install(runtime) → { manifest, views }
        └── views/                      页面组件
部分事实来源说明
后端wujies-<code>-plugin/pom.xml依赖平台构件时一律 provided,不要打进 jar
清单wujies-<code>-plugin/app.json版本、产物路径、菜单与权限的唯一权威描述
迁移wujies-<code>-plugin/migrations/*.sql文件名排序即执行顺序,已执行的脚本不要修改
前端wujies-<code>-plugin/frontend/src/index.ts构建成 ESM,由宿主在运行期 import()

命名只有一条规则:目录名、app.json.code、vite.config.ts 的 appCode、菜单里的 remote:<code>/<viewKey>,四处必须是同一个 <code>。

从零到可安装:五步

#做什么从哪开始
1新建插件骨架(后端 + 前端 + 清单 + 迁移)node tools/create-plugin/create-plugin.mjs
2启动开发:点「一键开发」一次完成编译 + 加载 + 监听 + 前端 watch;也可用两条轨道分别点「启动后端」「启动前端」[快速开始](/docs/wujies/5.x/platform/plugin/quickstart)
3本地安装:落位、建表、登记 -dev 版本、同步菜单、直接加载 target/classes[可视化开发台 · 本地安装](/docs/wujies/5.x/platform/plugin/console#本地安装)
4开发调试:改 Java 编译后自动热加载;改 Vue 保存自动重建,刷新页面[可视化开发台](/docs/wujies/5.x/platform/plugin/console)
5打包发布:组装 zip → 下载 → 到上架中心(wujies-market)上传发布[打包应用](/docs/wujies/5.x/platform/package/build)

以前要先走完整上架流程(打包 → 上传 → 发布 → 安装)才能看到菜单。现在开发台的 「本地安装」会直接把开发包落位到宿主,执行迁移并同步菜单,同时只登记一个 <版本号>-dev 的开发版本 —— 不会污染应用市场。

装完后端直接加载插件工程的 target/classes(Halo 模型),宿主不重启; 之后点一次 一键开发(编译 + 加载 + 监听 + 前端 watch 构建),就进入 「编译 Java / 保存 Vue → 刷新页面」的日常回路。迁移、菜单与前端落位仍由「本地安装」负责。详见 [开发与安装的边界](/docs/wujies/5.x/platform/plugin/console#热加载--监听不做什么)。

两种创建方式

### 方式一:生成器(推荐)

在项目根执行 tools/create-plugin,它从官方 hello 模板复制并改好包名 / 类名 / 表名 / 权限前缀 / 清单,默认输出到 plugins/wujies-<code>-plugin/:

# 前后端完整骨架
node tools/create-plugin/create-plugin.mjs --code demo --name "演示应用"

# 只要后端(表 + 五个接口)
node tools/create-plugin/create-plugin.mjs --code demo --name "演示应用" --backend-only

# 只要前端(一个静态页面 + 菜单)
node tools/create-plugin/create-plugin.mjs --code demo --name "演示应用" --frontend-only

生成后的下一步、构建命令和目录说明会直接打印在终端里。完整的参数与产物说明见 [快速开始 · 新建插件](/docs/wujies/5.x/platform/plugin/quickstart#1-新建插件)。

### 方式二:复制 hello 模板

想照着现成代码改,就把 plugins/wujies-hello-plugin 复制成 plugins/wujies-<code>-plugin, 再改四处:pom.xml 的 artifactId、app.json 的 code/name/version/menus、Java 包名、表名前缀。 这条路的对照索引见[跟着 hello 读源码](/docs/wujies/5.x/platform/plugin/demo)。

> 两种方式产物结构一致。不要从业务插件(mall / im / exam)复制——它们带了很多历史包袱, > 新应用用 hello 或生成器即可。

拉一个已发布的应用来改

上面三种是「从零新建」。还有一种更常见的起点:应用已经发布,你要在本地改它。 一个应用一个仓库,仓库名 wujies-<code>-plugin(与 Maven artifactId 一致),后端在仓库根、 前端在 frontend/:

git clone git@gitee.com:wujies/wujies-enterprise-plugin.git

把仓库放在项目根的 plugins/ 下(plugins/wujies-<code>-plugin/)即可 —— 宿主留空 fixed-plugin-path 时默认扫描这里,启动就直接加载它;放在别处则把仓库根写进 app-market.plugin-runtime.fixed-plugin-path。之后的启动、编译、热加载、打包用的都是你手上这一份, 显式配置的优先级压过默认扫描。 改后端和改前端的路径与下面的「日常开发循环」完全一样。

全程命令行的版本(不用打开页面,每一步一条命令)单独成页: [手动开发与本地运行](/docs/wujies/5.x/platform/plugin/manual-run)。

日常开发循环

本文导览

(https://console.wujies.cn/remote-apps/cms-assets/doc-989f1d66714b-guide.svg)

章节导览
THE END

喜欢就支持以下吧

评论区需要浏览器启用 JavaScript 才能加载。

回到内容