Skip to content

目录结构

顶层目录与 mms-modules 子模块顺序,与仓库根 pom.xmlmms-modules/pom.xml<modules> 一致,便于对照「改哪个目录、依赖谁」。更细的职责表见 项目简介 — Maven 子模块职责

管理端前端

mms-ui独立前端仓库Gitee)。mms 根目录不含 内嵌 mms-ui,请 另克隆 mms-ui 并与 mms 同级目录 放置后联调,详见 开始 — 获得项目

本地可在主仓根目录执行(需已安装 tree):

bash
tree -L 2 -d

顶层目录(概要)

text
.
├── mms-admin/              # 管理端聚合启动(Spring Boot 入口,如 MmsAdminApplication;个别分支目录名可能为 mms-api-admin)
├── mms-modules/            # 业务与框架子模块(多数为 jar)
├── mms-plugins/          # JAR 插件工程聚合(不随 admin fatjar;由插件宿主 lib 加载)
├── mms-zoom/             # 三方扩展:监控、定时任务等
├── script/                 # 数据库脚本、Docker、辅助脚本等
├── version/                # 版本/基线说明等(可选,随仓维护)
├── logs/                   # 运行日志目录(本地常见,是否纳入版本管理以 .gitignore 为准)
├── pom.xml                 # 根聚合与 dependencyManagement
├── README.md
├── LICENSE
├── .editorconfig
└── ...                     # 如 .cursor、IDE 配置等

全栈工作区:在 mms 之外、与其 同级 再建 mms-ui/(克隆 mms-ui),见 获得项目。上表仅描述 mms 仓库根内容。

mms-modules/(与 pom 声明顺序一致)

text
mms-modules/
├── mms-common/             # 公共枚举、工具、配置属性等
├── mms-plugin-api/         # 插件契约:plugin.json、SPI(无 Spring 强依赖)
├── mms-plugin-host/        # 插件宿主:扫描 lib、ClassLoader、运维接口
├── mms-framework/          # 业务基类、与框架协作
├── mms-mq/                 # 消息队列
├── mms-wx/                 # 微信生态
├── mms-aliyun/             # 阿里云相关
├── mms-oss/                # 对象存储抽象
├── mms-sms/                # 短信
├── mms-email/              # 邮件
├── mms-redis/              # Redis 封装
├── mms-demo/               # 演示
├── mms-websocket/          # WebSocket
├── mms-authority/          # Sa-Token、登录对象等
├── mms-datasource/         # MyBatis-Plus、多数据源、租户等
├── mms-gen/                # 代码生成
├── mms-ai/                 # 推理/对话接入(可选)
├── mms-thymeleaf/          # 模板侧能力
├── mms-log/                # 操作日志
└── mms-system/             # 用户、角色、菜单、字典、租户等系统域

mms-plugins/

text
mms-plugins/
├── pom.xml
└── mms-plugin-sample-health/   # 示例健康检查插件(可按需增加业务插件子模块)

mms-zoom/

text
mms-zoom/
├── mms-powerjob/           # 分布式定时任务
└── mms-monitor/            # 健康监控(Spring Boot Admin 等)

说明:历史上若存在注释掉的扩展子模块,以当前 mms-zoom/pom.xml<modules> 为准。

script/(常见结构)

text
script/
├── db/
│   ├── mms.sql             # 主库初始化(路径以仓库为准)
│   └── servers/            # 分业务、演示或区域的 SQL 片段等
├── docker/                 # compose、nginx、mysql、redis 等示例
├── README.md
└── ...

文档修订(2026-04-01)

与主仓当前 pom.xml / mms-modules/pom.xml / mms-zoom/pom.xml 及目录名为准;本地若增减模块,以各层 pom.xml<modules> 为权威。

Released under the MIT License.