中国 帮助

框架设计

这一页回答"分成几块、谁依赖谁、为什么这么分"。它不列目录(那是 [仓库目录](/docs/wujies/1.x/design/repolayout) 的事),也不列硬约束(那是 [必须遵守的不变量](/docs/wujies/1.x

框架设计
封面

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

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

> 这一页回答"分成几块、谁依赖谁、为什么这么分"。它不列目录(那是 > [仓库目录](/docs/wujies/1.x/design/repo-layout) 的事),也不列硬约束(那是 > [必须遵守的不变量](/docs/wujies/1.x/plugin-dev/basics/invariants) 的事)。 > > 全文的技术断言都给了落点(路径 / 类名 / 配置键 / 建表脚本)。结构变了请重读文件系统再改这一页, > 不要凭记忆补。

一句话

把上游 RuoYi-Vue-Plus 的"一套系统服务一个客户"形态改造成 平台 + 应用:平台提供多租户底座 与应用市场机制,业务能力做成可后装、不重启、从市场拉下来直接跑的应用;宿主前端退化成一层壳, 业务页面由应用在运行期交付。

术语:平台 / 宿主 / 宿主前端 / 应用

说法指什么判据
平台(后端)wujies-platform/,Java / Spring Boot + SQL 脚本有 pom.xml;产物 wujies-admin.jar
宿主运行插件的那一个 JVM 进程 —— 就是平台后端插件子上下文的 parent 就是它
宿主前端plus-ui/,Vue 3 / Vite有 vite.config.ts / src/;package.json 的 name 是 wujies-admin
应用wujies/wujies-plugins/wujies-<app>/,一个应用一个目录含 app.json、migrations/、src/main/java/cn/wujies/<app>/

"宿主"与"平台后端"是同一份进程的两个视角:讲类加载器与 Spring 父子上下文时叫宿主, 讲多租户底座与市场机制时叫平台。两者不是两个进程。

本项目源自上游 RuoYi-Vue-Plus,但自己的模块名、包名一律是 wujies-* / cn.wujies.*。 源码或旧文档里出现上游的旧前缀与旧包名,那是历史遗留 —— 改的时候换成 wujies-* / cn.wujies.*。

一、三个仓库

仓库内容默认分支
wujies-platform后端(Java / Spring Boot)+ 平台 SQL 脚本feature/app-market
wujies/wujies-plugins插件本体 + 插件前端工程(pnpm workspace)+ 打包器 + docs/master
plus-ui宿主前端(Vue 3 / Vite)feature/app-market

三者没有共同 git 根,各自分支、各自提交、各自推送 —— 加一个应用经常要跨仓库提交两到三次。 目录级细节见 [仓库目录](/docs/wujies/1.x/design/repo-layout)。

⚠️ wujies-admin 这一个名字指三处不同地方(历史上已经因此误导过两次排查):

写法实际指判据
wujies-platform/wujies-admin/后端启动模块(Java)有 pom.xml / src/main / Dockerfile;产物 wujies-admin.jar
工作区顶层的 wujies-admin/前端产物落位目录里面只有 app-market-dist/,没有 package.json、没有 src/
plus-ui/宿主前端仓库有 vite.config.ts / src/;package.json 的 name = wujies-admin

记法:路径里出现 src/plugins/、src/views/、app-market-dist/ → 说的是 plus-ui/; 出现 src/main/resources/、wujies-admin.jar、mvn -pl wujies-admin → 说的是 wujies-platform/wujies-admin/。

二、三者各负责什么

平台(宿主)应用(插件)宿主前端(plus-ui/)
用户与权限用户 / 角色 / 部门 / 岗位 / 租户 / 菜单的授权只声明自己的权限标识(app.json 的 menus[].perms)按登录返回的菜单树渲染侧边栏
数据平台表(sys_* / app_* …),并保护它们不被误删自己的业务表,建表语句放 migrations/—
加载与隔离类加载器、子 Spring 上下文、独立的 PluginHandlerMapping、宿主拦截器链只写普通 Spring 代码—
生命周期部署 / 安装 / 升级 / 卸载 / 停用的编排与任务记录(app_install_task)无感装完 / 升级 / 停用后调 refreshMenus() 刷新菜单树
前端页面一层壳:布局、登录、工作台自己的视图,产出独立 ESM远程应用装载器 + 静态路由兜底
包安全产物白名单 + 签名校验(app-market.security.mode,当前 enforce)发布时签名—

关键类是单向的,别记反:

component = remote:<appCode>/<视图键> 只是视图键,入口 JS 由运行期问后端得到: AppRuntimeController 的 GET /app/runtime/remote-apps。见 [前端远程应用](/docs/wujies/1.x/advanced/remote-app)。

  • 插件能注入宿主,宿主不能注入插件(插件子上下文以宿主为 parent)。
  • 宿主前端在构建期不可能知道租户装了哪些应用。菜单里的

三、为什么前端必须先改造

后端把业务做成插件还不够 —— 起点约束在前端。改造前,页面是构建期用 glob 静态打进来的 (今天仍是这条,见 plus-ui/src/store/modules/permission.ts 第 17 行):

const modules = import.meta.glob('./../../views/**/*.vue');

于是 sys_menu.component 只能指向构建时已存在的 .vue 文件,第三方页面在物理上无法热加载。 所以"应用外置"必须先把前端运行时改出来:让菜单能指向一份运行期才知道在哪的独立 ESM。

宿主前端为此做了两件事:

1. plus-ui/src/plugins/appmarket/ 里的装载器(loader.ts / bootstrap.ts / runtime.ts / menuRefresh.ts / edition.ts / appAvailability.ts)在运行期问后端要入口并执行; 2. 不靠菜单驱动的页面(详情页、编辑页这类静态路由)也收藏到同一条路: plus-ui/src/router/index.ts 里大量使用 createRemoteViewComponent('<视图键>', '<appCode>'), 否则菜单能点开、手打 URL 却打不开。

四、契约随插件走:平台里没有 *-api 模块

这是决定整个仓库结构的一条约定,也是最容易照着旧文档写错的一条。

现状:平台里 wujies-modules/*-api 数量为 0;平台对 cn.wujies.<app>.* 的 Java 引用为 0 (只允许出现在注释里)。每个应用自包含:

内容位置
实体 / BO / VO / 枚举wujies/wujies-plugins/wujies-<app>/src/main/java/cn/wujies/<app>/domain/**
Mapper 接口 与 Mapper XML同上的 mapper/ 包,

本文导览

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

章节导览
THE END

喜欢就支持以下吧

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

回到内容