主题
模块手册
本页回答三个问题:有哪些模块、各有多大、从哪开始读。规模数字全部可复算(口径见 1.3 节),接口路径只取自动生成物 接口索引,功能卡只取 功能卡索引。
结论先说:
modules/下 14 个 Maven 业务模块 + 1 个规划中的 PM 业务域 = 15 个业务域;14 个业务模块与build/pmforge-bom、framework、apps/pmforge-server一起共 17 个一级模块参与构建,且已全部装配进apps/pmforge-server的运行时。表结构方面,system/infra 走正式 DDL,其余 12 个模块走骨架 DDL(316 张,见 1.3 节),尚未做业务数据初始化。
1. 模块全景
1.1 业务模块(15 个业务域)
| Maven 模块 | 状态 | 控制器数 | 接口数 | 表数 | 功能卡数 | 一句话职责 |
|---|---|---|---|---|---|---|
pmforge-module-system | ✅ | 35 | 212 | 32 | 27 | 认证、用户、权限、组织、租户、字典、消息、日志 |
pmforge-module-infra | ✅ | 16 | 116 | 16 | 13 | 代码生成、文件存储、任务、配置、日志监控 |
pmforge-module-bpm | ✅ | 12 | 77 | 8 | 0 | BPMN / 仿钉钉流程设计、审批、待办 |
pmforge-module-pay | ✅ | 19 | 60 | 14 | 0 | 支付渠道、支付/退款单、钱包 |
pmforge-module-member | ✅ | 20 | 72 | 11 | 0 | 会员、等级、积分、签到 |
pmforge-module-mall | ✅ | 72 | 316 | 49 | 0 | 商品/交易/营销/统计,含 4 个业务子模块 |
pmforge-module-crm | ✅ | 24 | 167 | 21 | 0 | 客户、联系人、商机、合同、回款 |
pmforge-module-erp | ✅ | 23 | 146 | 33 | 0 | 采购、销售、库存、财务、往来账 |
pmforge-module-wms | ✅ | 17 | 77 | 16 | 0 | 仓库、出入库、盘点、调拨 |
pmforge-module-mes | ✅ | 127 | 762 | 133 | 0 | 工单、生产、质量、设备、条码 |
pmforge-module-iot | ✅ | 19 | 106 | 15 | 0 | 设备接入、物模型、规则引擎,含 3 个子模块 |
pmforge-module-im | ✅ | 30 | 126 | 17 | 0 | 单聊、群聊、消息、会话 |
pmforge-module-report | ✅ | 1 | 5 | 1 | 0 | GoView 数据报表项目管理 |
pmforge-module-mp | ✅ | 12 | 52 | 8 | 0 | 微信公众号接入 |
| PM 业务域(规划) | 🚧 | 0 | 0 | 0 | 0 | 项目/迭代/任务/工时/风险,暂无 Maven 模块 |
| 合计 | — | 427 | 2 294 | 374 | 40 | — |
说明:mall 的 72 个控制器来自 product / promotion / trade / statistics 四个子模块;iot 的 19 个来自 iot-biz(iot-core、iot-gateway 无控制器)。PM 业务域只在能力地图中规划,仓库无代码,故计数为 0。
report 的 5 个接口对应 /report/go-view/project/*(GoView 项目集成);PRD 09-02 数据报表 里的积木报表设计器与大屏属规划形态,未实现。
1.2 底座(不提供业务功能)
| Maven 模块 | 状态 | 控制器数 | 接口数 | 表数 | 功能卡数 | 一句话职责 |
|---|---|---|---|---|---|---|
framework(15 个子模块) | ✅ | 0 | 0 | 0 | 0 | pmforge-common + 14 个 starter:web/security/mybatis/redis/job/mq/monitor/excel/tenant/数据权限/IP/websocket/protection/测试 |
apps/pmforge-server | ✅ | 1 | 1 | 0 | 0 | 启动类 + DefaultController(/test 连通性自测)+ 内嵌前端静态资源 |
build/pmforge-bom | ✅ | 0 | 0 | 0 | 0 | 仅版本管理(BOM) |
apps/pmforge-server 现在装配了全部 14 个业务模块(17 个业务依赖,mall 展 4 项、iot 展 1 项),是一个可以单端口跑全系统的「单体网关 + 控制台」;不再为未启用模块提供兜底 404。
1.3 统计口径
| 指标 | 口径(可复算) |
|---|---|
| 控制器数 | 带 @RestController 且至少含一个方法级 HTTP 映射的类数 |
| 接口数 | @GetMapping / @PostMapping / @PutMapping / @DeleteMapping / @PatchMapping 注解数(方法级,多路径按路径数计) |
| 表数 | dal/dataobject(IoT 为 dataobject)下 *DO.java 的数量;与生成物一致:system 32、infra 16 |
| 功能卡数 | 功能卡索引 按模块归并:INF 13 + SYS 27 = 40 |
| Java 文件数 | 全仓 *.java(含 src/test):5 380,其中 main 5 118、test 262 |
| DDL 覆盖 | 正式 DDL 只覆盖 system 32 + infra 16 = 48 张;其余 12 个模块(326 张,去重后 316 个 CREATE TABLE)由 sql/mysql/pmforge-modules-skeleton.sql 提供骨架,需人工核对后转正 |
注意:上表数字全部来自
tools/docs/scan-knowledge.mjs的静态解析(docs/code/api|data/*.md每模块一页),属源码统计值;运行期只在demoprofile 做过冒烟(登录 + 各模块列表接口),没有逐接口回归。
1.4 功能点分布
数字取自能力地图的统计口径,与上表的模块规模对照可以看出「代码量大 ≠ 功能点多」:
| 范围 | 功能点 | 后端已实现 | 预留 | 规划 |
|---|---|---|---|---|
| 系统管理 + 基础设施 | 40 | 40 | 0 | 0 |
| 工作流 / 支付 / 会员 / 商城 | 54 | 0 | 54 | 0 |
| 企业应用 5 个模块 + 支撑 2 个模块 | 未拆分计数 | 0 | 全部 | 0 |
| PM 业务域 | 6 | 0 | 0 | 6 |
| 合计 | 94+ | 40 | 54 | 6 |
所以「40 张功能卡」不是随意定的:它正好等于已实现的 40 个功能点(24 + 16)。4 个预留模块(BPM 20、PAY 10、MBR 8、MALL 16)合计 54 个功能点,写在各自的模块卡里;其余 8 个预留模块没有逐条功能点,只登记接口规模。12 个预留模块各有一张 <模块码>-00 卡,/cards/ 共 52 张。
2. 构建拓扑
text
pom.xml(root,17 个 <module>,全部启用)
├── build/pmforge-bom # BOM,版本集中管理
├── framework/ # pmforge-common + 14 个 starter
├── apps/pmforge-server # 装配全部 14 个业务模块,单端口 48080
└── modules/
├── system infra member bpm pay crm erp wms mes im mp report
├── mall/{product,promotion,trade,trade-api,statistics}
└── iot/{iot-biz,iot-core,iot-gateway}| 事实 | 位置 | 影响 |
|---|---|---|
| 根 pom 启用 17 个一级模块(含 14 个业务模块) | pom.xml 的 <modules> | 全部参与 mvn package,约 2.5 分钟 / 41 个 reactor 项目 |
| server 依赖 17 个业务 artifact(mall 展 4、iot 展 1) | apps/pmforge-server/pom.xml | 容器里能看到全部 Controller;jar 约 327 MB |
| mall、iot 是聚合模块 | modules/mall/pom.xml、modules/iot/pom.xml | 子模块目录名与 artifactId 不同(pmforge-module-* 保留) |
| 前端产物写入 server 静态目录 | web/pmforge-ui-web/vite.config.ts | 生产只需一个端口、一份 jar;静态产物不入库 |
| 演示环境开关 | application-demo.yaml | 关闭验证码、关闭 demo 写拦截、iot.message-bus.type=local、tdengine.enable=false |
3. 增减模块
3.1 新增一个业务模块
- 在
modules/<name>建 Maven 模块(artifactId 用pmforge-module-<name>),<parent>指向根pmforge(relativePath按目录深度算)。 - 根
pom.xml的<modules>加一行modules/<name>。 apps/pmforge-server/pom.xml加依赖;若是聚合模块(mall/iot),按子模块展开。- 补
sql/mysql/pmforge.sql的system_menu行与权限点,并在 8 套库脚本同步;否则前端菜单不出现、按钮 403。 - 补生产 DDL(或先归入
pmforge-modules-skeleton.sql);多租户表必须有tenant_id,否则租户拦截器拼出的 SQL 会报Unknown column。 npm run docs:gen会自动识别新模块(modules/*扫描 +@RestController/DO 注解),生成/code/api、/code/data页面。
3.2 移除一个业务模块
- 从
apps/pmforge-server/pom.xml与根pom.xml移除依赖与 module。 - 删除
modules/<name>;若模块有自己的菜单/字典/权限,同步删除 8 套 SQL 里的对应行(参考 AI 模块移除:57 行菜单 + 11 类字典)。 - 删除
docs/prd下对应 PRD、tools/docs/cards.reserved.mjs里的模块卡数据,跑npm run docs:gen && npm run docs:check。 - 检查
tools/docs/scan-knowledge.mjs的MODULE_ORDER、MODULE_LABEL是否还引用该模块。
3.3 风险
| 风险 | 具体表现 | 规避 |
|---|---|---|
| 依赖漂移 | server 用子模块 artifactId(如 pmforge-module-product),根 pom 只声明聚合模块 modules/mall | 以 apps/pmforge-server/pom.xml 为准;先 mvn -pl modules/<name> -am 验证单模块 |
| 隐藏依赖 | 只开 mall 会因缺 member/pay 编译失败;只开 crm 会因缺 bpm 失败 | 按 member → pay → mall、bpm → crm、iot-core → iot-biz 的顺序 |
| 骨架 DDL 不等于正式表 | 316 张骨架表字段类型是推断的,缺索引/唯一约束/注释 | 上线前逐表 review,用 sql/mysql/pmforge.sql 的写法补索引与注释 |
| 菜单与权限是数据 | 新模块的 Controller 有 @PreAuthorize,但 system_menu 没行 | 补菜单 SQL 并分配角色;否则接口 403(docs 的权限差集检查只保证「代码有、菜单无 = 0」) |
| 文档索引不覆盖 | 扫描脚本按 @RestController/@TableName 识别,不按目录 | 新模块要真的写注解;纯 XML/手写 SQL 的模块不会被索引 |
4. 从哪个模块入手
| 想搞清楚 | 从这里读 | 理由 |
|---|---|---|
| 一个请求如何进来 | framework 的 web/security starter → system 认证 | 全局返回、异常、拦截器、登录态都在 framework,业务侧只写 Controller |
| 权限如何计算 | system 模块 PermissionServiceImpl + framework 数据权限 | 菜单权限走 Redis 缓存,数据权限走 DeptDataPermissionRule |
| 代码如何被生成 | infra 模块 CodegenEngine | 101 个 Velocity 模板,是「约定式开发」的放大器 |
| 文件如何落盘 | infra 模块 FileClientFactoryImpl | 5 种存储实现按枚举分派,是理解策略模式的现成样本 |
| 任务如何调度 | infra 模块 JobServiceImpl + framework job starter | Quartz 封装与 JobHandler 约定 |
| 公共能力有哪些 | framework/pmforge-common | CommonResult、PageResult、异常、工具类 |
读码顺序建议:先看一个功能卡(如 SYS-USER-01)的「接口 → 权限 → 代码 → 表」四段,再回到本页对照模块规模;不要从 framework 逐类读,容易陷进基础设施细节。
5. 相关页面
6. 前端工程
前端在本仓库 web/pmforge-ui-web,Vue 3.5 + Vite 6 + TypeScript + Tailwind 3.4(shadcn 风格自绘组件)+ Pinia + vue-router(hash);构建产物写入 apps/pmforge-server/src/main/resources/static,随 jar 一起发布。本地开发时 npm run dev 通过 Vite 代理把 /admin-api 转到 http://localhost:48080。
| 目录 | 内容 |
|---|---|
src/views/PortalView.vue、LoginView.vue | 门户(模块卡/搜索/状态徽标)与登录 |
src/views/system/*.vue | 用户、角色、菜单、部门、字典、租户、公告、日志 |
src/views/infra/*.vue | 文件、参数、定时任务、代码生成 |
src/components/CrudPage.vue、DataTable.vue | 配置化 CRUD、可排序可导出的表格 |
src/components/ui/*.vue | Btn、Field、Modal、Badge、Toast |
src/directives/permission.ts | v-perm 指令,按钮级权限 |
原型与取舍见 架构说明 - 前端。