mirror of
https://gitee.com/mmsAdmin/mms
synced 2025-12-06 08:58:55 +08:00
28 KiB
28 KiB
模块化管理系统
⚡️系统介绍
🔥🔥🔥 mms（模块化管理系统，Modular Management System）基于Spring Boot 3.x构建，采用前后端分离的现代化架构设计。该系统集成了用户管理、商品管理、支付系统、订单处理、分销体系、日志监控、定时任务、通信服务、直播支持、广告管理与内容发布等多个功能模块，致力于为开发者提供高效、稳定且可扩展的开发脚手架，显著提升项目开发效率，助力各类应用快速落地与迭代。
🚀🚀🚀 我们将作为持续更新迭代，定期发布功能更新、Bug修复和技术栈升级，确保系统始终处于技术前沿，打造最有价值的开源项目，为开发者社区贡献力量。
项目代码和文档完全开源免费，支持商业使用。🚀 我们秉承"活到老，写到老"的开源精神，为兴趣而开源，为学习而开源。🚀
🍃系统演示: 传送门
🍃MMS文档: mms
🧩系统版本
| 名称 | 别名 | 项目地址 | 注意事项 |
|---|---|---|---|
| mms | 标准版 | -Gitee | 🙋功能齐全的手架系统 📢完全具备高效的项目开发 📢完多租户模式灵活开启 📢支持低代码自动生成模式 |
| mms-ui | 标准版 | -Gitee | 🙋适配mms后端系统的管理界面项目 |
📦开发语言与技术栈
🙋高效安全、组件解耦、灵活扩展 模块化扩展内置代码生成引擎加速后台系统构建。
核心特性
- 模块化设计：采用 Maven 多模块架构，各功能模块独立开发、部署和维护
- 多租户支持：灵活的多租户架构，支持数据隔离和资源共享
- 权限管理：基于 Sa-Token 的 RBAC 权限控制，支持菜单、按钮级别权限
- 代码生成：内置低代码生成引擎，支持前后端代码一键生成
- 多数据源：支持 MySQL、Oracle、PostgreSQL、SQL Server 等多种数据库
- 对象存储：集成 x-file-storage，支持阿里云、腾讯云、华为云等主流云存储
- 消息队列：支持 RabbitMQ、RocketMQ、Kafka 等消息中间件
- 定时任务：集成 PowerJob，支持分布式定时任务调度
- 监控管理：集成 Spring Boot Admin，提供应用健康监控
- 安全防护：支持 XSS、SQL 注入防护，接口加签验签等安全机制
- 国际化支持：支持多语言切换
- 数据字典：统一数据字典管理，支持动态配置
- 操作日志：完善的操作日志记录和查询功能
- 通知公告：系统公告和消息通知功能
- 个人中心：用户个人信息管理、密码修改、头像设置等
功能模块
-
系统管理
- 用户管理：用户增删改查、导入导出、密码重置
- 角色管理：角色权限分配、角色用户管理
- 菜单管理：菜单配置、权限标识设置
- 部门管理：组织架构管理
- 岗位管理：岗位信息维护
- 字典管理：数据字典配置
- 配置管理：系统参数配置
- 通知公告：系统消息发布
-
系统监控
- 操作日志：用户操作记录查询
- 登录日志：用户登录信息查询
- 服务监控：服务器状态监控
- 缓存监控：Redis 缓存信息查看
-
工具箱
- 代码生成：数据库表结构自动生成前后端代码
- 系统接口：Swagger API 文档
- 定时任务：任务调度管理
- 对象存储：文件上传和管理
-
扩展功能
- 短信服务：短信发送和配置
- 邮件服务：邮件发送和配置
- 微信集成：微信公众号、小程序接入
- 阿里云服务：阿里云相关服务集成
🍃部署方式
环境要求
- JDK 17+
- MySQL 8.0+
- Redis 6.x+
- Node.js 16+ (前端项目)
- Docker (可选，用于容器化部署)
部署步骤
-
数据库初始化
- 执行
script/db/mms.sql脚本创建数据库表结构和初始数据 - 根据实际环境修改数据库连接配置
- 执行
-
后端服务部署
- 修改
mms-admin/src/main/resources/application.yml配置文件 - 根据不同环境激活对应的 profile (local/dev/prod)
- 执行 Maven 命令打包：
mvn clean package -DskipTests - 运行 jar 包：
java -jar mms-admin.jar
- 修改
-
前端服务部署
- 进入前端项目目录
- 安装依赖：
pnpm install - 构建生产环境：
pnpm build - 部署构建产物到 Web 服务器
-
Docker 部署
- 使用
script/docker/docker-compose.yml文件一键部署 - 根据实际环境修改配置文件中的参数
- 执行
docker-compose up -d启动所有服务
- 使用
配置文件说明
项目支持多种环境配置：
application-local.yml：本地开发环境application-dev.yml：开发环境application-prod.yml：生产环境
配置主要包括：
- 数据源配置（MySQL、Oracle、PostgreSQL等）
- Redis 配置
- Sa-Token 权限配置
- MyBatis-Plus 配置
- 多租户配置
- 对象存储配置
🤝模块介绍
| 序号 | 目录 | 子模块名称 | 模块名称 | 备注 |
|---|---|---|---|---|
| 1 | mms-admin | 系统管理启动模块 | 已完成 | |
| 1 | mms-docs | VitePress会员主题（知识付费） MMS适配接口服务 |
已完成 | |
| 5 | ｜________ | mms-doc-admin | 会员主题后端模块 | 已完成 |
| 6 | ｜________ | mms-doc-api | 会员主题接口模块 | 已完成 |
| 2 | mms-malls | 商城 | 开发中 | |
| 5 | ｜________ | mms-mall-admin | 商城后端模块 | 开发中 |
| 6 | ｜________ | mms-mall-api | 商城接口模块 | 开发中 |
| 5 | ｜________ | mms-mall-merchant | 商城商户模块 | 开发中 |
| 6 | ｜________ | mms-doc-uni-x | 商城移动模块 | 开发中 |
| 4 | mms-modules | MMS模块集 | 持续增加中 | |
| 5 | ｜________ | mms-ai | 大模型模块 | 已完成 |
| 5 | ｜________ | mms-aliyun | 阿里云模块 | 已完成 |
| 5 | ｜________ | mms-authority | 安全认证模块 | 已完成 |
| 5 | ｜________ | mms-common | 公共模块 | 已完成 |
| 5 | ｜________ | mms-datasource | 数据源模块 | 已完成 |
| 5 | ｜________ | mms-demo | 演示模块 | 已完成 |
| 5 | ｜________ | mms-email | 邮箱模块 | 已完成 |
| 6 | ｜________ | mms-framework | 核心模块 | 已完成 |
| 5 | ｜________ | mms-gen | 代码生成模块 | 已完成 |
| 7 | ｜________ | mms-mq | 消息队列 | 已完成 |
| 5 | ｜________ | mms-oss | 对象存储模块 | 已完成 |
| 5 | ｜________ | mms-redis | 缓存模块 | 已完成 |
| 5 | ｜________ | mms-sms | 短信模块 | 已完成 |
| 5 | ｜________ | mms-thymeleaf | 模版引擎渲染模块 | 已完成 |
| 8 | ｜________ | mms-websocket | 长连接通信管理 | 已完成 |
| 5 | ｜________ | mms-wx | 微信模块 | 已完成 |
| 9 | mms-zoom | 快速激增模块集 | 已完成 | |
| 10 | ｜________ | mms-monitor | 安全监控 | 已完成 |
| 11 | ｜________ | mms-powerjob | 定时任务 | 已完成 |
| 12 | script | 项目配置文件 | 已完成 |
📄软件架构与核心技术栈
软件架构说明
| 框架 | 说明 | 版本 | 说明 |
|---|---|---|---|
| SpringBoot | 后端主框架 | 3.X | 3.2.6 |
| Undertow | 基于 XNIO 的高性能容器 | 2.7.6 | |
| Sa-Token | Sa-Token、Jwt(强解耦、强扩展) | 1.35.0.RC | |
| MySQL | 关系数据库 | 适配 8.X 最低 5.7 | |
| Redis | 缓存数据库 | 适配 6.X 最低 4.X | |
| Mybatis-Plus | 快速 CRUD 增加开发效率 | 3.5.7 | |
| Vue | vue 框架 | 3.2.45 | |
| Vite | 开发与构建工具 | 4.0.4 | |
| Element Plus | Element Plus | 2.2.28 | |
| TypeScript | JavaScript 的超集 | 4.9.4 | |
| pinia | Vue 存储库 替代 vuex5 | 2.0.28 | |
| vueuse | 常用工具集 | 9.10.0 | |
| vxe-table | vue 最强表单 | 4.3.7 | |
| vue-i18n | 国际化 | 9.2.2 | |
| vue-router | vue 路由 | 4.1.6 | |
| windicss | 下一代工具优先的 CSS 框架 | 3.5.6 | |
| iconify | 在线图标库 | 3.0.1 | |
| wangeditor | 富文本编辑器 | 5.1.23 |
🏗️项目架构说明
整体架构
MMS（模块化管理系统）采用前后端分离的架构设计，后端基于 Spring Boot 3.x 构建，前端使用 Vue 3.x 技术栈。
后端架构特点
- 多模块 Maven 项目结构：项目采用 Maven 多模块结构，便于模块化开发和维护
- Spring Boot 3.x：基于最新稳定版本的 Spring Boot 框架
- 多数据源支持：集成 dynamic-datasource-spring-boot-starter，支持多数据源切换
- 权限认证：使用 Sa-Token 进行权限控制，支持 JWT
- ORM 框架：集成 MyBatis-Plus，提供强大的 CRUD 操作能力
- 缓存支持：集成 Redis，支持分布式缓存
- 多租户架构：支持多租户模式，可灵活开启或关闭
- 代码生成：内置低代码生成引擎，加速后台系统构建
- 对象存储：集成 x-file-storage，支持多种云存储平台
- 消息队列：支持多种消息队列中间件
- 定时任务：集成 PowerJob，支持分布式定时任务
- 监控管理：集成 Spring Boot Admin，提供应用监控能力
核心模块说明
- mms-admin：系统管理启动模块，整合各业务模块
- mms-modules：核心业务模块集合
- mms-common：公共模块，包含通用工具类和枚举
- mms-framework：核心框架模块，包含基础配置和工具
- mms-datasource：数据源模块，包含基础实体类和分页工具
- mms-authority：安全认证模块，基于 Sa-Token 实现
- mms-gen：代码生成模块，支持低代码开发
- mms-oss：对象存储模块，支持多种云存储
- mms-redis：Redis 缓存模块
- mms-sms：短信服务模块
- mms-email：邮件服务模块
- mms-zoom：扩展模块集合
- mms-monitor：系统监控模块
- mms-powerjob：分布式定时任务模块
👨💻开发指南
开发环境搭建
- 安装 JDK 17+ 并配置环境变量
- 安装 Maven 3.6+ 并配置环境变量
- 安装 MySQL 8.0+ 并创建数据库
- 安装 Redis 6.x+ 并启动服务
- 导入 IDE (推荐 IntelliJ IDEA)
项目结构说明
mms
├── mms-admin # 系统管理启动模块
├── mms-modules # 核心业务模块集合
│ ├── mms-common # 公共模块
│ ├── mms-framework # 核心框架模块
│ ├── mms-datasource # 数据源模块
│ ├── mms-authority # 安全认证模块
│ ├── mms-gen # 代码生成模块
│ └── ... # 其他业务模块
├── mms-zoom # 扩展模块集合
│ ├── mms-monitor # 系统监控模块
│ └── mms-powerjob # 定时任务模块
└── script # 脚本文件
├── db # 数据库脚本
└── docker # Docker 部署文件
代码规范
- 遵循阿里巴巴 Java 开发手册
- 使用 Lombok 简化代码
- 统一使用 MapStruct 进行对象转换
- 控制器层统一返回 R 格式
- 服务层统一处理业务逻辑
- 数据访问层使用 MyBatis-Plus
新增业务模块步骤
- 在
mms-modules目录下创建新模块 - 在模块中创建对应的 entity、mapper、service、controller 层
- 在
mms-admin的 pom.xml 中添加模块依赖 - 在数据库中创建对应的表结构
- 在菜单管理中添加对应的菜单和权限
🤝如何贡献
我们欢迎任何形式的贡献，包括但不限于：
- 提交 Issue：报告 bug 或提出新功能建议
- 提交 Pull Request：修复 bug、添加新功能或改进文档
- 完善文档：补充使用说明、开发指南等文档
- 代码优化：优化现有代码结构和性能
贡献流程
- Fork 项目到自己的 GitHub 账户
- Clone 到本地开发环境
- 创建新的分支进行开发
- 提交代码并推送至 GitHub
- 发起 Pull Request
代码规范
- 遵循项目现有的代码风格
- 添加必要的单元测试
- 确保代码通过所有测试
- 编写清晰的提交信息
🎳演示图例
登录页面 |
后台首页 |
|---|---|
 |
 |
用户管理 |
新增用户 |
 |
 |
角色管理 |
添加角色 |
 |
 |
菜单管理 |
部门管理 |
 |
 |
字典管理 |
添加字典 |
 |
 |
系统设置 |
消息公告 |
 |
 |
代码生成1 |
代码生成2 |
 |
 |
代码生成3 |
代码生成4 |
 |
 |
定时任务 |
对象存储 |
 |
 |
扩展工具 |
个人中心 |
 |
 |
😎 LICENSE
::: tip MIT License https://gitee.com/mmsAdmin/mms/blob/master/LICENSE :::
❌免责条款
您充分了解并同意，您必须为自己使用本服务及注册帐号下的一切行为负责，包括您所发表的任何内容以及由此产生的任何后果。您应对本服务中的内容自行加以判断，并自行承担因使用内容而引起的所有风险。
mms,mms-ui 对网站上所显示的信息或资料的准确性、内容、完整性、合法性、可靠性、可操作性或可用性不承担任何责任。
mms,mms-ui 二次开发使用者因为违法而触犯中华人民共和国法律的，一切后果自己负责，mms 作者 不承担任何责任。
本声明未涉及的问题参见国家有关法律法规，当本声明与国家法律法规冲突时，以国家法律法规为准。
🧪学习 & 商用
mms,mms-ui 是免费和开源的，可免费用于 学习、商业使用 。
🔧 技术架构与核心组件
核心技术栈
MMS基于Spring Boot 3.x构建，采用Maven多模块架构，整合了众多优秀的开源技术框架：
| 技术框架 | 说明 | 版本 |
|---|---|---|
| Spring Boot | 后端主框架 | 3.2.6 |
| MyBatis-Plus | ORM框架 | 3.5.7 |
| Sa-Token | 权限认证框架 | 1.35.0.RC |
| Redisson | Redis客户端 | 3.31.0 |
| Dynamic-Datasource | 多数据源支持 | 4.3.1 |
| MapStruct Plus | 对象映射工具 | 1.4.3 |
| Hutool | Java工具库 | 5.8.32 |
| Lombok | Java简化工具 | 1.8.32 |
| EasyExcel | Excel处理 | 4.0.3 |
| SpringDoc | API文档 | 2.5.0 |
| X-File-Storage | 对象存储 | 2.1.0 |
| PowerJob | 分布式任务调度 | 4.3.9 |
| SMS4J | 短信服务 | 3.2.0 |
数据库支持
系统支持多种主流数据库：
- MySQL 8.0+
- Oracle
- PostgreSQL
- SQL Server
- 达梦数据库
- 人大金仓
消息队列支持
系统支持多种消息队列中间件：
- RabbitMQ
- RocketMQ
- Kafka
对象存储支持
系统集成了X-File-Storage，支持多种云存储平台：
- 阿里云OSS
- 腾讯云COS
- 华为云OBS
- 七牛云Kodo
- 百度云BOS
- Amazon S3
- MinIO
📦 项目模块结构
mms
├── mms-admin # 系统管理启动模块
├── mms-modules # 核心业务模块集合
│ ├── mms-common # 公共模块
│ ├── mms-framework # 核心框架模块
│ ├── mms-datasource # 数据源模块
│ ├── mms-authority # 安全认证模块
│ ├── mms-gen # 代码生成模块
│ └── ... # 其他业务模块
├── mms-zoom # 扩展模块集合
│ ├── mms-monitor # 系统监控模块
│ └── mms-powerjob # 定时任务模块
└── script # 脚本文件
├── db # 数据库脚本
└── docker # Docker 部署文件
🔐 安全特性
- 权限控制：基于Sa-Token实现RBAC权限模型，支持菜单、按钮级别权限控制
- 数据加密：支持AES/RSA加密算法，对敏感数据进行加密存储
- 密码安全：MD5加盐加密，支持密码强度检测
- 接口安全：支持接口签名验证，防止数据篡改
- XSS防护：内置XSS攻击防护机制
- SQL注入防护：通过MyBatis-Plus和参数绑定防止SQL注入
- CSRF防护：支持CSRF攻击防护
🌐 多租户架构
系统采用多租户架构设计，支持以下特性：
- 数据隔离：不同租户数据完全隔离
- 资源共享：可灵活配置租户间资源共享策略
- 租户管理：支持租户创建、配置、停用等管理功能
- 套餐管理：支持租户套餐配置，限制功能权限
📊 系统监控
- 健康检查：集成Spring Boot Actuator，提供应用健康监控
- 性能监控：支持接口调用统计、响应时间分析
- 日志管理：完善的操作日志和登录日志记录
- 服务监控：集成Spring Boot Admin，提供可视化监控界面
🛠️ 开发工具
- 代码生成：内置低代码生成引擎，支持前后端代码一键生成
- API文档：集成SpringDoc，自动生成Swagger API文档
- 数据字典：统一数据字典管理，支持动态配置
- 定时任务：集成PowerJob，支持分布式定时任务调度
- 消息队列：支持多种消息队列中间件
- 缓存管理：集成Redis，支持分布式缓存
📱 前端技术栈
| 技术框架 | 说明 | 版本 |
|---|---|---|
| Vue | 前端框架 | 3.2.45 |
| Vite | 构建工具 | 4.0.4 |
| Element Plus | UI组件库 | 2.2.28 |
| TypeScript | 编程语言 | 4.9.4 |
| Pinia | 状态管理 | 2.0.28 |
| Vue Router | 路由管理 | 4.1.6 |
| Windi CSS | CSS框架 | 3.5.6 |
🚀 部署架构
系统支持多种部署方式：
- 传统部署：直接运行jar包
- Docker部署：使用Docker容器化部署
- Kubernetes部署：支持K8s集群部署
- 微服务部署：支持拆分为微服务架构
📈 性能优化
- 数据库优化：支持读写分离、分库分表
- 缓存优化：多级缓存设计，提升系统响应速度
- 连接池优化：使用HikariCP高性能连接池
- 异步处理：支持异步任务处理，提升系统吞吐量
- 压缩传输：支持GZIP压缩，减少网络传输数据量
📞 技术支持
如有问题可以通过以下方式联系技术支持：
- 官方网站：https://www.mmsadmin.cn
- Gitee仓库：https://gitee.com/mmsAdmin/mms
- 邮箱：sxpcwlkj@163.com
- QQ群：待定
📄 更新日志
v1.0.6 (2025-02-03)
- [新增] 微信二维码扫描登录
- [新增] 个人中心手机号绑定
- [新增] 个人中心邮箱绑定
- [修复] 个人中心微信号绑定
- [预告] 修复已知BUG
v1.0.5 (2024-11-14)
- [新增] mms-admin整合easyexcel支持数据的导入/导出（支持字典的自动翻译和导入的逆翻译）
- [新增] mms-ui对Table列表页面进行工具栏的封装（表格数据的导出，导入，打印）等功能
- [优化] 系统整体的架构布局优化
- [预告] 接口加密，接口防抖，接口限流等技术
v1.0.4 (2024-10-20)
- [更新] mms-ui sass文件的引入方式，由
@import换为@use - [注意] （Dart Sass originally used an API based on the one used by Node Sass, but replaced it with a new, modern API in Dart Sass 1.45.0. The legacy JS API is now deprecated and will be removed in Dart Sass 2.0.0.）
v1.0.3 (2024-08-02)
- [升级] mms-generator代码生产模块
- [新增] mms-power job分布式定时任务模块
- [新增] mms-mq消息队列模块
- [新增] mms-monitor健康检测扩展模块
- [优化] mms-ui优化适配
v1.0.2 (2024-05-10)
- [新增] mms-aliyun阿里云生态模块
- [新增] mms-wx微信生态模块
- [新增] mms-demo Demo模块
v1.0.1 (2024-02-10)
- [新增] mms-system管理系统模块
- [新增] mms-common公共模块抽取
- [新增] mms-redis独立redis模块
- [新增] mms-framework系统核心模块
- [新增] mms-sms短信模块
- [新增] mms-email邮件模块
- [新增] mms-oss对象存储模块
v1.0.0 (2023-12-01)
- [发布] MMS模块化管理系统正式开源发布