中国 帮助

项目结构

工作区里多个 git 仓库各装什么、同名目录分别指哪一处、应用产物经过哪几步才进到宿主里。

项目结构
封面

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

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

改代码前先确认自己动的是哪个仓库,装完应用前端却看不到变化时也先确认路径。这两件事都要求先把工作区布局看清。本页写的是当前工作区的真实状态,每条结论旁边给出查证方式。

一个项目根,多个 git 仓库

wujies/ 根目录没有 .git,下面每一项各自成仓,分支和提交互不相干,改一个功能经常要跨仓提交两三次。

wujies/
├── wujies-platform/     后端宿主(Java 17 / Spring Boot 3.5.15 / revision 5.6.2)
├── wujies-admin/        管理端前端(Vue 3 / Vite)
├── wujies-web/          PC 用户端
├── wujies-uniapp/       移动端(uni-app:H5 / App / 小程序)
├── wujies-ui/           前端 SDK(@wujies/*,发 npm)
├── wujies-site/         本站(官网 + 文档站,Next.js 静态导出)
├── wujies-market/       中心上架服务:目录与上架的唯一维护处(私有仓)
├── wujies-deploy/       部署侧真实值:各机 env 与两把公钥(私有仓)
├── plugins/             十三个应用仓库的容器,本身不是仓库
├── wujies-plugins/      旧单体仓,本机留着当打包脚本母本与历史内容,新应用不要往里加
├── tools/               create-plugin 脚手架、bump-app-version
├── plugins-dist/        后端 jar 落位目录(宿主从本根启动时的实际落点)
└── .plugin-dist/        打包产物暂存,仓库之外
仓库顶层标志物公开
wujies-platformpom.xml、AGENTS.md、script/sql/platform_init.sql是,MIT
wujies-adminvite.config.ts、src/、app-market-dist/是
wujies-uipackages/ 四件套是
wujies-marketpom.xml、sql/market_schema.sql、web/ 控制台否
wujies-deploykeys/、local/、servers/否
plugins/wujies-<code>-pluginapp.json + pom.xml + frontend/视各仓 LICENSE

开源仓里不带任何部署侧真实值:application-prod.yml 只剩 ${WUJIES_DB_HOST} 这类占位符,两把公钥靠环境变量注入,真实值待在私有仓那一行里。文档与示例统一写 <host>、YOUR_*。仓库边界用 git rev-parse --show-toplevel 判,plugins/ 下的应用仓库另按「目录里有没有 app.json」判定,同级杂项目录不会被宿主加载,也不会被打包脚本对账收录。

wujies-admin 这个名字指三处

这个坑误导过两次排查,读任何路径前先判一下有没有 pom.xml 或 package.json。

写法实际指判据
wujies-platform/wujies-admin/后端启动模块,产物 wujies-admin.jar有 pom.xml、src/main/resources/application.yml
wujies/wujies-admin/宿主前端仓库,package.json 里 name 恰好也叫 wujies-admin有 vite.config.ts、src/、app-market-dist/
项目根的上一级里那个 wujies-admin/前端产物落位的空目录,历史遗留,不是仓库里面只有 app-market-dist/,没有 package.json

出现 src/views/、app-market-dist/ 指的是宿主前端;出现 src/main/resources/**、-pl wujies-admin 指的是后端启动模块。

后端仓 wujies-platform/

根 pom.xml 的 <modules> 只挂四个聚合模块,全反应堆 39 个 pom.xml。

wujies-platform/
├── AGENTS.md                      不变量与已知坑的权威清单,改代码前扫一遍
├── wujies-admin/                  启动模块:PluginClassPathLoader 在这里,Spring 之前执行
├── wujies-common/                 基础设施 27 个子模块
│   ├── wujies-common-core/        PluginServiceProvider / MenuOwnershipProvider 等宿主反查 SPI
│   ├── wujies-common-web/         GlobalExceptionHandler,异常到前端的唯一出口
│   ├── wujies-common-plugin-sdk/  宿主向插件暴露的能力契约,插件唯一应依赖的宿主入口
│   └── wujies-common-phone-verify/ 号码认证服务商适配
├── wujies-modules/                app-market、market-core、system、workflow、plugin-probe 五个
├── wujies-extend/                 monitor-admin、snailjob-server 两个独立进程
├── script/sql/                    platform_init.sql(权威初始化)、app_market_schema.sql、update/ 增量
├── deploy/                        1panel 应用模板、docker/、host/(宿主在线更新的 apply 脚本)、tools/*.mjs
└── docs/                          平台侧文档与 docs/removed/(已移出 reactor 的存档源码)

平台里没有 *-api 契约模块,也没有 wujies-job / wujies-generator / wujies-demo。配置项 plugin-dir 的默认值 plugins-dist 按启动 cwd 解析,见下面那个红框。一条命令复核:

Get-ChildItem .\wujies-modules -Directory | Select-Object -ExpandProperty Name
(Get-ChildItem -Recurse -Filter pom.xml | Where-Object FullName -notmatch '\\target\\').Count
Get-ChildItem -Recurse -Directory -Filter '*-api' | Where-Object FullName -notmatch '\\target\\'

应用仓:plugins/wujies-<code>-plugin/

一个应用一个仓库,后端、前端、迁移、清单、打包脚本全在自己仓里,平台不引用它的类。

章节导览
THE END

喜欢就支持以下吧

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

回到内容