Skip to content

开始

简述

准备 JDK / 数据库 / Redis / Maven(及前端所需 Node)。请从 Gitee 克隆 mms(后端)与 mms-ui(管理端前端);本地目录怎么排布随意,放在同一父目录下时联调最省事。

前言

关于组件

项目虽然二次封装了一些组件,但是可能不能满足大部分的要求。 所以,如果组件不满足你的要求,完全可以不用甚至删除代码自己写,不必坚持使用项目自带的组件。

环境准备

本地环境建议安装 npmNode.jsGit

注意

  • JDK 21(与主仓根 pom.xmljava.version 一致)
  • 数据库建议 8.0 及以上版本
  • Redis 建议 3.0 及以上版本
  • Maven 建议 3.6 及以上版本
  • IDEA 建议 2023 及以上版本
  • HBuildX 保持最新版本
  • VsCode 保持最新版本

获得项目

这里推荐一款顺手的 Git 客户端:UGIT

当前仓库布局(与早期文档差异)

mms 仓库根目录默认不包含内嵌的 mms-ui。全栈开发请 再克隆 mms-ui,与 mms 放在同一父目录(兄弟目录),在 mms-ui 内配置后端接口地址后联调。

推荐:并列克隆 mms 与 mms-ui

bash
mkdir mms-work && cd mms-work
git clone https://gitee.com/mmsAdmin/mms.git
git clone https://gitee.com/mmsAdmin/mms-ui.git

典型目录结构:

text
mms-work/
├── mms/          # 后端 Maven 工程
└── mms-ui/       # 管理端前端(独立仓库)

联调时在 mms-ui 中配置后端地址(.env.* / Vite 代理),与 MMS-UI 使用指南 一致。

日常分别进入对应目录执行 git pull / git commit / git push 即可(两仓版本互不绑定)。

仅克隆后端

bash
git clone https://gitee.com/mmsAdmin/mms.git
cd mms

需要管理端时再 另行 克隆 mms-ui(建议仍与 mms 同级,便于后续联调)。

仅克隆前端

bash
git clone https://gitee.com/mmsAdmin/mms-ui.git

需自行准备可访问的后端实例(本地或远程),见 项目导入与启动

历史截图(旧版目录示意,仅供对照)

前端 mms-ui:日常 Git(双仓并列)

以下适用于 mmsmms-ui 两个独立仓库、且置于同一父目录的常见工作流。若团队另有内部聚合仓用子模块等方式固定多仓指针,按其内部规范执行即可(本文不展开)。

1. 更新到远程最新

后端:

bash
cd mms
git pull

前端:

bash
cd mms-ui
git pull

(路径以你本机父目录名为 mms-work 为例时可写为 mms-work/mmsmms-work/mms-ui。)

2. 提交并推送

在各自仓库根目录内与普通 Git 项目相同:

bash
git add .
git commit -m "feat: 说明"
git push

3. 合并冲突与 detached HEAD

  • 冲突处理与单仓项目相同;前端与后端各自在对应目录内解决后推送。
  • 避免长期停留在 detached HEAD:开发前 git checkout <分支>

4. 常用操作速查

场景后端目录 mms/前端目录 mms-ui/
更新代码git pullgit pull
查看当前提交git rev-parse HEADgit rev-parse HEAD
推送改动git pushgit 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-powerjobmms-monitor,以 mms-zoom/pom.xml 为准)

mms-modules 子模块一览(与 pom 声明顺序一致)

子模块职责摘要
mms-common通用枚举、工具、配置属性等
mms-plugin-api插件契约:plugin.jsonMmsPlugin SPI 等
mms-plugin-host插件宿主:扫描 lib、ClassLoader、/system/pluginHost
mms-framework业务基类与框架协作
mms-mq消息队列抽象与实现
mms-wx微信生态
mms-aliyun阿里云相关
mms-oss对象存储
mms-sms短信
mms-email邮件
mms-redisRedis 封装
mms-demo演示 / 示例
mms-websocketWebSocket
mms-authoritySa-Token、LoginObject、权限
mms-datasourceMyBatis-Plus、多数据源、多租户等
mms-gen代码生成
mms-ai推理接入(可选)
mms-thymeleafThymeleaf
mms-log操作日志
mms-system用户、角色、菜单、字典、租户等系统域

文档修订(2026-04-02)

与主仓当前根模块及 mms-modules 列表对齐;去除已无对应根 pom 条目的历史行(如 mms-docs / mms-malls);启动目录统一为 mms-admin(个别分支或旧称可能写作 mms-api-admin,以仓库内实际目录名为准)。

文档修订(2026-04-02)

对外获取方式mmsmms-ui 双仓克隆为准;mms 根下不含 内嵌 mms-ui。环境与 JDK 21、revision 等见 项目简介。示例分支名 master 若与你远程默认分支不一致请替换。

Released under the MIT License.