开始
简述
准备 JDK / 数据库 / Redis / Maven(及前端所需 Node)。请从 Gitee 克隆 mms(后端)与 mms-ui(管理端前端);本地目录怎么排布随意,放在同一父目录下时联调最省事。
前言
关于组件
项目虽然二次封装了一些组件,但是可能不能满足大部分的要求。 所以,如果组件不满足你的要求,完全可以不用甚至删除代码自己写,不必坚持使用项目自带的组件。
环境准备
注意
- JDK 21(与主仓根
pom.xml中java.version一致) - 数据库建议 8.0 及以上版本
- Redis 建议 3.0 及以上版本
- Maven 建议 3.6 及以上版本
- IDEA 建议 2023 及以上版本
- HBuildX 保持最新版本
- VsCode 保持最新版本
获得项目
这里推荐一款顺手的 Git 客户端:UGIT。
推荐:并列克隆 mms 与 mms-ui
mkdir mms-work && cd mms-work
git clone https://gitee.com/mmsAdmin/mms.git
git clone https://gitee.com/mmsAdmin/mms-ui.git典型目录结构:
mms-work/
├── mms/ # 后端 Maven 工程
└── mms-ui/ # 管理端前端(独立仓库)联调时在 mms-ui 中配置后端地址(.env.* / Vite 代理),与 MMS-UI 使用指南 一致。
日常分别进入对应目录执行 git pull / git commit / git push 即可(两仓版本互不绑定)。
仅克隆后端
git clone https://gitee.com/mmsAdmin/mms.git
cd mms需要管理端时再 另行 克隆 mms-ui(建议仍与 mms 同级,便于后续联调)。
仅克隆前端
git clone https://gitee.com/mmsAdmin/mms-ui.git需自行准备可访问的后端实例(本地或远程),见 项目导入与启动。
历史截图(旧版目录示意,仅供对照)


前端 mms-ui:日常 Git(双仓并列)
以下适用于 mms 与 mms-ui 两个独立仓库、且置于同一父目录的常见工作流。若团队另有内部聚合仓用子模块等方式固定多仓指针,按其内部规范执行即可(本文不展开)。
1. 更新到远程最新
后端:
cd mms
git pull前端:
cd mms-ui
git pull(路径以你本机父目录名为 mms-work 为例时可写为 mms-work/mms、mms-work/mms-ui。)
2. 提交并推送
在各自仓库根目录内与普通 Git 项目相同:
git add .
git commit -m "feat: 说明"
git push3. 合并冲突与 detached HEAD
- 冲突处理与单仓项目相同;前端与后端各自在对应目录内解决后推送。
- 避免长期停留在 detached HEAD:开发前
git checkout <分支>。
4. 常用操作速查
| 场景 | 后端目录 mms/ | 前端目录 mms-ui/ |
|---|---|---|
| 更新代码 | git pull | git pull |
| 查看当前提交 | git rev-parse HEAD | git rev-parse HEAD |
| 推送改动 | git push | git push |
更多说明:项目导入与启动、MMS-UI 使用指南。
在 IDEA 里怎么打开工程?
- 只用后端:在 IDEA 中选择 Open,打开你克隆的
mms/pom.xml作为 Maven 工程根。 - 全栈:后端窗口打开
mms目录;前端在mms-ui根目录用 VS Code / WebStorm 另开窗口。联调依赖接口地址与代理配置(见 MMS-UI 使用指南)。
模块介绍
说明:顶层 Maven 模块与主仓根
pom.xml中<modules>一致;mms-modules内顺序与mms-modules/pom.xml一致。子模块职责摘要见 项目简介 — Maven 子模块职责。树形目录说明见 目录结构(tree)。
非 Maven、随工作区维护:mms-ui/(管理端前端,独立仓库 mms-ui,常与 mms/ 同级目录 克隆)、script/(SQL、Docker 等,在 mms 仓内)。mms-plugins/ 在扩展工作区中常与 mms/ 同级。仅克隆 mms 时其根下无 mms-ui。
顶层模块(根 pom.xml)
| 目录 | 说明 |
|---|---|
mms-admin | 管理端 Spring Boot 启动(如 MmsAdminApplication,artifactId mms-admin) |
mms-modules | 业务与框架子模块(jar)聚合 |
mms-zoom | 扩展能力(如 mms-powerjob、mms-monitor,以 mms-zoom/pom.xml 为准) |
mms-modules 子模块一览(与 pom 声明顺序一致)
| 子模块 | 职责摘要 |
|---|---|
mms-common | 通用枚举、工具、配置属性等 |
mms-plugin-api | 插件契约:plugin.json、MmsPlugin SPI 等 |
mms-plugin-host | 插件宿主:扫描 lib、ClassLoader、/system/pluginHost 等 |
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、LoginObject、权限 |
mms-datasource | MyBatis-Plus、多数据源、多租户等 |
mms-gen | 代码生成 |
mms-ai | 推理接入(可选) |
mms-thymeleaf | Thymeleaf |
mms-log | 操作日志 |
mms-system | 用户、角色、菜单、字典、租户等系统域 |
文档修订(2026-04-02)
与主仓当前根模块及 mms-modules 列表对齐;去除已无对应根 pom 条目的历史行(如 mms-docs / mms-malls);启动目录统一为 mms-admin(个别分支或旧称可能写作 mms-api-admin,以仓库内实际目录名为准)。
