mirror of
https://gitee.com/mmsAdmin/mms
synced 2025-12-06 08:58:55 +08:00
更新系统介绍
This commit is contained in:
parent
a01d3d6ef4
commit
7647bd8701
303
README.md
303
README.md
@ -9,13 +9,9 @@
|
|||||||
|
|
||||||
## ⚡️系统介绍
|
## ⚡️系统介绍
|
||||||
|
|
||||||
🔥🔥🔥mmsAdmin(模块化管理系统,Modular Management System)是一款面向企业级应用开发的全方位开源解决方案。作为一款十年磨一剑的精品工程,mmsAdmin致力于为开发者提供高效、稳定、可扩展的开发脚手架,助力各类项目快速落地。
|
🔥🔥🔥 mmsAdmin(模块化管理系统,Modular Management System,Admin代表系统核心管理功能)基于Spring Boot 3.x构建,采用前后端分离的现代化架构设计。该系统集成了用户管理、商品管理、支付系统、订单处理、分销体系、日志监控、定时任务、通信服务、直播支持、广告管理与内容发布等多个功能模块,致力于为开发者提供高效、稳定且可扩展的开发脚手架,显著提升项目开发效率,助力各类应用快速落地与迭代。
|
||||||
|
|
||||||
**命名由来**:MMS代表Modular Management System(模块化管理系统),Admin代表管理系统核心功能,体现了我们打造模块化、可管理、易扩展的企业级应用开发平台的初心。
|
🚀🚀🚀 我们将作为持续更新迭代,定期发布功能更新、Bug修复和技术栈升级,确保系统始终处于技术前沿,打造最有价值的开源项目,为开发者社区贡献力量。
|
||||||
|
|
||||||
系统基于Spring Boot 3.x构建,采用前后端分离的现代化架构设计,集成了用户管理、商品管理、支付系统、订单处理、分销体系、日志监控、定时任务、通信服务、直播支持、广告管理、内容发布等丰富功能模块。无论是初创企业还是大型组织,都能通过mmsAdmin快速搭建符合业务需求的应用系统。
|
|
||||||
|
|
||||||
作为持续更新迭代的开源项目,我们定期发布功能更新、Bug修复和技术栈升级,确保系统始终处于技术前沿。我们的目标是打造最有价值的开源项目,为开发者社区贡献力量。
|
|
||||||
|
|
||||||
> 项目代码和文档完全开源免费,支持商业使用。我们秉承"活到老,写到老"的开源精神,为兴趣而开源,为学习而开源。
|
> 项目代码和文档完全开源免费,支持商业使用。我们秉承"活到老,写到老"的开源精神,为兴趣而开源,为学习而开源。
|
||||||
|
|
||||||
@ -23,60 +19,15 @@
|
|||||||
|
|
||||||
🍃MMS文档: [mmsAdmin](https://mmsadmin.cn/)
|
🍃MMS文档: [mmsAdmin](https://mmsadmin.cn/)
|
||||||
|
|
||||||
### 核心特性
|
|
||||||
1. **模块化设计**:采用 Maven 多模块架构,各功能模块独立开发、部署和维护
|
|
||||||
2. **多租户支持**:灵活的多租户架构,支持数据隔离和资源共享
|
|
||||||
3. **权限管理**:基于 Sa-Token 的 RBAC 权限控制,支持菜单、按钮级别权限
|
|
||||||
4. **代码生成**:内置低代码生成引擎,支持前后端代码一键生成
|
|
||||||
5. **多数据源**:支持 MySQL、Oracle、PostgreSQL、SQL Server 等多种数据库
|
|
||||||
6. **对象存储**:集成 x-file-storage,支持阿里云、腾讯云、华为云等主流云存储
|
|
||||||
7. **消息队列**:支持 RabbitMQ、RocketMQ、Kafka 等消息中间件
|
|
||||||
8. **定时任务**:集成 PowerJob,支持分布式定时任务调度
|
|
||||||
9. **监控管理**:集成 Spring Boot Admin,提供应用健康监控
|
|
||||||
10. **安全防护**:支持 XSS、SQL 注入防护,接口加签验签等安全机制
|
|
||||||
11. **国际化支持**:支持多语言切换
|
|
||||||
12. **数据字典**:统一数据字典管理,支持动态配置
|
|
||||||
13. **操作日志**:完善的操作日志记录和查询功能
|
|
||||||
14. **通知公告**:系统公告和消息通知功能
|
|
||||||
15. **个人中心**:用户个人信息管理、密码修改、头像设置等
|
|
||||||
|
|
||||||
### 功能模块
|
|
||||||
1. **系统管理**
|
|
||||||
- 用户管理:用户增删改查、导入导出、密码重置
|
|
||||||
- 角色管理:角色权限分配、角色用户管理
|
|
||||||
- 菜单管理:菜单配置、权限标识设置
|
|
||||||
- 部门管理:组织架构管理
|
|
||||||
- 岗位管理:岗位信息维护
|
|
||||||
- 字典管理:数据字典配置
|
|
||||||
- 配置管理:系统参数配置
|
|
||||||
- 通知公告:系统消息发布
|
|
||||||
|
|
||||||
2. **系统监控**
|
|
||||||
- 操作日志:用户操作记录查询
|
|
||||||
- 登录日志:用户登录信息查询
|
|
||||||
- 服务监控:服务器状态监控
|
|
||||||
- 缓存监控:Redis 缓存信息查看
|
|
||||||
|
|
||||||
3. **工具箱**
|
|
||||||
- 代码生成:数据库表结构自动生成前后端代码
|
|
||||||
- 系统接口:Swagger API 文档
|
|
||||||
- 定时任务:任务调度管理
|
|
||||||
- 对象存储:文件上传和管理
|
|
||||||
|
|
||||||
4. **扩展功能**
|
|
||||||
- 短信服务:短信发送和配置
|
|
||||||
- 邮件服务:邮件发送和配置
|
|
||||||
- 微信集成:微信公众号、小程序接入
|
|
||||||
- 阿里云服务:阿里云相关服务集成
|
|
||||||
|
|
||||||
## 🧩系统版本
|
## 🧩系统版本
|
||||||
|
|
||||||
<img src="https://img.shields.io/badge/MMS-V1.X-green"/>
|
<img src="https://img.shields.io/badge/MMS-V1.X-green"/>
|
||||||
|
|
||||||
| 名称 | 别名 | 项目地址 | 注意事项 |
|
|
||||||
|--------|:---:|:--------------------------------------------:|---------------------------------------------------------------------|
|
| 名称 | 别名 | 项目地址 | 注意事项 |
|
||||||
| mms | 标准版 | - [Gitee](https://gitee.com/mmsAdmin/mms) | 🙋功能齐全的手架系统 <br/> 📢完全具备高效的项目开发<br/> 📢完多租户模式灵活开启<br/>📢支持低代码自动生成模式 |
|
| ------ | :----: | :-----------------------------------------: | ----------------------------------------------------------------------------------------------------------- |
|
||||||
| mms-ui | 标准版 | - [Gitee](https://gitee.com/mmsAdmin/mms-ui) | 🙋适配mms后端系统的管理界面项目 |
|
| mms | 标准版 | -[Gitee](https://gitee.com/mmsAdmin/mms) | 🙋功能齐全的手架系统<br/> 📢完全具备高效的项目开发<br/> 📢完多租户模式灵活开启<br/>📢支持低代码自动生成模式 |
|
||||||
|
| mms-ui | 标准版 | -[Gitee](https://gitee.com/mmsAdmin/mms-ui) | 🙋适配mms后端系统的管理界面项目 |
|
||||||
|
|
||||||
## 📦开发语言与技术栈
|
## 📦开发语言与技术栈
|
||||||
|
|
||||||
@ -96,10 +47,61 @@
|
|||||||
|
|
||||||
🙋高效安全、组件解耦、灵活扩展 模块化扩展内置代码生成引擎加速后台系统构建。
|
🙋高效安全、组件解耦、灵活扩展 模块化扩展内置代码生成引擎加速后台系统构建。
|
||||||
|
|
||||||
|
### 核心特性
|
||||||
|
|
||||||
|
1. **模块化设计**:采用 Maven 多模块架构,各功能模块独立开发、部署和维护
|
||||||
|
2. **多租户支持**:灵活的多租户架构,支持数据隔离和资源共享
|
||||||
|
3. **权限管理**:基于 Sa-Token 的 RBAC 权限控制,支持菜单、按钮级别权限
|
||||||
|
4. **代码生成**:内置低代码生成引擎,支持前后端代码一键生成
|
||||||
|
5. **多数据源**:支持 MySQL、Oracle、PostgreSQL、SQL Server 等多种数据库
|
||||||
|
6. **对象存储**:集成 x-file-storage,支持阿里云、腾讯云、华为云等主流云存储
|
||||||
|
7. **消息队列**:支持 RabbitMQ、RocketMQ、Kafka 等消息中间件
|
||||||
|
8. **定时任务**:集成 PowerJob,支持分布式定时任务调度
|
||||||
|
9. **监控管理**:集成 Spring Boot Admin,提供应用健康监控
|
||||||
|
10. **安全防护**:支持 XSS、SQL 注入防护,接口加签验签等安全机制
|
||||||
|
11. **国际化支持**:支持多语言切换
|
||||||
|
12. **数据字典**:统一数据字典管理,支持动态配置
|
||||||
|
13. **操作日志**:完善的操作日志记录和查询功能
|
||||||
|
14. **通知公告**:系统公告和消息通知功能
|
||||||
|
15. **个人中心**:用户个人信息管理、密码修改、头像设置等
|
||||||
|
|
||||||
|
### 功能模块
|
||||||
|
|
||||||
|
1. **系统管理**
|
||||||
|
|
||||||
|
- 用户管理:用户增删改查、导入导出、密码重置
|
||||||
|
- 角色管理:角色权限分配、角色用户管理
|
||||||
|
- 菜单管理:菜单配置、权限标识设置
|
||||||
|
- 部门管理:组织架构管理
|
||||||
|
- 岗位管理:岗位信息维护
|
||||||
|
- 字典管理:数据字典配置
|
||||||
|
- 配置管理:系统参数配置
|
||||||
|
- 通知公告:系统消息发布
|
||||||
|
2. **系统监控**
|
||||||
|
|
||||||
|
- 操作日志:用户操作记录查询
|
||||||
|
- 登录日志:用户登录信息查询
|
||||||
|
- 服务监控:服务器状态监控
|
||||||
|
- 缓存监控:Redis 缓存信息查看
|
||||||
|
3. **工具箱**
|
||||||
|
|
||||||
|
- 代码生成:数据库表结构自动生成前后端代码
|
||||||
|
- 系统接口:Swagger API 文档
|
||||||
|
- 定时任务:任务调度管理
|
||||||
|
- 对象存储:文件上传和管理
|
||||||
|
4. **扩展功能**
|
||||||
|
|
||||||
|
- 短信服务:短信发送和配置
|
||||||
|
- 邮件服务:邮件发送和配置
|
||||||
|
- 微信集成:微信公众号、小程序接入
|
||||||
|
- 阿里云服务:阿里云相关服务集成
|
||||||
|
|
||||||
## 🍃部署方式
|
## 🍃部署方式
|
||||||
|
|
||||||
<img src="https://img.shields.io/docker/automated/tsund/tianchi_docker_practice.svg" alt=""/>
|
<img src="https://img.shields.io/docker/automated/tsund/tianchi_docker_practice.svg" alt=""/>
|
||||||
|
|
||||||
### 环境要求
|
### 环境要求
|
||||||
|
|
||||||
- JDK 17+
|
- JDK 17+
|
||||||
- MySQL 8.0+
|
- MySQL 8.0+
|
||||||
- Redis 6.x+
|
- Redis 6.x+
|
||||||
@ -107,34 +109,39 @@
|
|||||||
- Docker (可选,用于容器化部署)
|
- Docker (可选,用于容器化部署)
|
||||||
|
|
||||||
### 部署步骤
|
### 部署步骤
|
||||||
|
|
||||||
1. **数据库初始化**
|
1. **数据库初始化**
|
||||||
|
|
||||||
- 执行 `script/db/mms.sql` 脚本创建数据库表结构和初始数据
|
- 执行 `script/db/mms.sql` 脚本创建数据库表结构和初始数据
|
||||||
- 根据实际环境修改数据库连接配置
|
- 根据实际环境修改数据库连接配置
|
||||||
|
|
||||||
2. **后端服务部署**
|
2. **后端服务部署**
|
||||||
|
|
||||||
- 修改 `mms-admin/src/main/resources/application.yml` 配置文件
|
- 修改 `mms-admin/src/main/resources/application.yml` 配置文件
|
||||||
- 根据不同环境激活对应的 profile (local/dev/prod)
|
- 根据不同环境激活对应的 profile (local/dev/prod)
|
||||||
- 执行 Maven 命令打包:`mvn clean package -DskipTests`
|
- 执行 Maven 命令打包:`mvn clean package -DskipTests`
|
||||||
- 运行 jar 包:`java -jar mms-admin.jar`
|
- 运行 jar 包:`java -jar mms-admin.jar`
|
||||||
|
|
||||||
3. **前端服务部署**
|
3. **前端服务部署**
|
||||||
|
|
||||||
- 进入前端项目目录
|
- 进入前端项目目录
|
||||||
- 安装依赖:`pnpm install`
|
- 安装依赖:`pnpm install`
|
||||||
- 构建生产环境:`pnpm build`
|
- 构建生产环境:`pnpm build`
|
||||||
- 部署构建产物到 Web 服务器
|
- 部署构建产物到 Web 服务器
|
||||||
|
|
||||||
4. **Docker 部署**
|
4. **Docker 部署**
|
||||||
|
|
||||||
- 使用 `script/docker/docker-compose.yml` 文件一键部署
|
- 使用 `script/docker/docker-compose.yml` 文件一键部署
|
||||||
- 根据实际环境修改配置文件中的参数
|
- 根据实际环境修改配置文件中的参数
|
||||||
- 执行 `docker-compose up -d` 启动所有服务
|
- 执行 `docker-compose up -d` 启动所有服务
|
||||||
|
|
||||||
### 配置文件说明
|
### 配置文件说明
|
||||||
|
|
||||||
项目支持多种环境配置:
|
项目支持多种环境配置:
|
||||||
|
|
||||||
- `application-local.yml`:本地开发环境
|
- `application-local.yml`:本地开发环境
|
||||||
- `application-dev.yml`:开发环境
|
- `application-dev.yml`:开发环境
|
||||||
- `application-prod.yml`:生产环境
|
- `application-prod.yml`:生产环境
|
||||||
|
|
||||||
配置主要包括:
|
配置主要包括:
|
||||||
|
|
||||||
- 数据源配置(MySQL、Oracle、PostgreSQL等)
|
- 数据源配置(MySQL、Oracle、PostgreSQL等)
|
||||||
- Redis 配置
|
- Redis 配置
|
||||||
- Sa-Token 权限配置
|
- Sa-Token 权限配置
|
||||||
@ -144,70 +151,74 @@
|
|||||||
|
|
||||||
## 🤝模块介绍
|
## 🤝模块介绍
|
||||||
|
|
||||||
| 序号 | 目录 | 子模块名称 | 模块名称 | 备注 |
|
|
||||||
|----|-------------|-------------------|----------------------------------|-------|
|
| 序号 | 目录 | 子模块名称 | 模块名称 | 备注 |
|
||||||
| 1 | mms-admin | | 系统管理启动模块 | 已完成 |
|
| ---- | ----------- | ----------------- | ------------------------------------------------ | ---------- |
|
||||||
| 1 | mms-docs | | VitePress会员主题(知识付费)<br>MMS适配接口服务 | 已完成 |
|
| 1 | mms-admin | | 系统管理启动模块 | 已完成 |
|
||||||
| 5 | |________ | mms-doc-admin | 会员主题后端模块 | 已完成 |
|
| 1 | mms-docs | | VitePress会员主题(知识付费)<br>MMS适配接口服务 | 已完成 |
|
||||||
| 6 | |________ | mms-doc-api | 会员主题接口模块 | 已完成 |
|
| 5 | |________ | mms-doc-admin | 会员主题后端模块 | 已完成 |
|
||||||
| 2 | mms-malls | | 商城 | 开发中 |
|
| 6 | |________ | mms-doc-api | 会员主题接口模块 | 已完成 |
|
||||||
| 5 | |________ | mms-mall-admin | 商城后端模块 | 开发中 |
|
| 2 | mms-malls | | 商城 | 开发中 |
|
||||||
| 6 | |________ | mms-mall-api | 商城接口模块 | 开发中 |
|
| 5 | |________ | mms-mall-admin | 商城后端模块 | 开发中 |
|
||||||
| 5 | |________ | mms-mall-merchant | 商城商户模块 | 开发中 |
|
| 6 | |________ | mms-mall-api | 商城接口模块 | 开发中 |
|
||||||
| 6 | |________ | mms-doc-uni-x | 商城移动模块 | 开发中 |
|
| 5 | |________ | mms-mall-merchant | 商城商户模块 | 开发中 |
|
||||||
| 4 | mms-modules | | MMS模块集 | 持续增加中 |
|
| 6 | |________ | mms-doc-uni-x | 商城移动模块 | 开发中 |
|
||||||
| 5 | |________ | mms-ai | 大模型模块 | 已完成 |
|
| 4 | mms-modules | | MMS模块集 | 持续增加中 |
|
||||||
| 5 | |________ | mms-aliyun | 阿里云模块 | 已完成 |
|
| 5 | |________ | mms-ai | 大模型模块 | 已完成 |
|
||||||
| 5 | |________ | mms-authority | 安全认证模块 | 已完成 |
|
| 5 | |________ | mms-aliyun | 阿里云模块 | 已完成 |
|
||||||
| 5 | |________ | mms-common | 公共模块 | 已完成 |
|
| 5 | |________ | mms-authority | 安全认证模块 | 已完成 |
|
||||||
| 5 | |________ | mms-datasource | 数据源模块 | 已完成 |
|
| 5 | |________ | mms-common | 公共模块 | 已完成 |
|
||||||
| 5 | |________ | mms-demo | 演示模块 | 已完成 |
|
| 5 | |________ | mms-datasource | 数据源模块 | 已完成 |
|
||||||
| 5 | |________ | mms-email | 邮箱模块 | 已完成 |
|
| 5 | |________ | mms-demo | 演示模块 | 已完成 |
|
||||||
| 6 | |________ | mms-framework | 核心模块 | 已完成 |
|
| 5 | |________ | mms-email | 邮箱模块 | 已完成 |
|
||||||
| 5 | |________ | mms-gen | 代码生成模块 | 已完成 |
|
| 6 | |________ | mms-framework | 核心模块 | 已完成 |
|
||||||
| 7 | |________ | mms-mq | 消息队列 | 已完成 |
|
| 5 | |________ | mms-gen | 代码生成模块 | 已完成 |
|
||||||
| 5 | |________ | mms-oss | 对象存储模块 | 已完成 |
|
| 7 | |________ | mms-mq | 消息队列 | 已完成 |
|
||||||
| 5 | |________ | mms-redis | 缓存模块 | 已完成 |
|
| 5 | |________ | mms-oss | 对象存储模块 | 已完成 |
|
||||||
| 5 | |________ | mms-sms | 短信模块 | 已完成 |
|
| 5 | |________ | mms-redis | 缓存模块 | 已完成 |
|
||||||
| 5 | |________ | mms-thymeleaf | 模版引擎渲染模块 | 已完成 |
|
| 5 | |________ | mms-sms | 短信模块 | 已完成 |
|
||||||
| 8 | |________ | mms-websocket | 长连接通信管理 | 已完成 |
|
| 5 | |________ | mms-thymeleaf | 模版引擎渲染模块 | 已完成 |
|
||||||
| 5 | |________ | mms-wx | 微信模块 | 已完成 |
|
| 8 | |________ | mms-websocket | 长连接通信管理 | 已完成 |
|
||||||
| 9 | mms-zoom | | 快速激增模块集 | 已完成 |
|
| 5 | |________ | mms-wx | 微信模块 | 已完成 |
|
||||||
| 10 | |________ | mms-monitor | 安全监控 | 已完成 |
|
| 9 | mms-zoom | | 快速激增模块集 | 已完成 |
|
||||||
| 11 | |________ | mms-powerjob | 定时任务 | 已完成 |
|
| 10 | |________ | mms-monitor | 安全监控 | 已完成 |
|
||||||
| 12 | script | | 项目配置文件 | 已完成 |
|
| 11 | |________ | mms-powerjob | 定时任务 | 已完成 |
|
||||||
|
| 12 | script | | 项目配置文件 | 已完成 |
|
||||||
|
|
||||||
## 📄软件架构与核心技术栈
|
## 📄软件架构与核心技术栈
|
||||||
|
|
||||||
软件架构说明
|
软件架构说明
|
||||||
|
|
||||||
| 框架 | 说明 | 版本 | 说明 |
|
|
||||||
|----------------------------------------------------------------------|-----------------------|---------------|-------|
|
| 框架 | 说明 | 版本 | 说明 |
|
||||||
| [SpringBoot](https://spring.io/projects/spring-boot/#learn) | 后端主框架 | 3.X | 3.2.6 |
|
| -------------------------------------------------------------------- | ----------------------------- | ----------------- | ----- |
|
||||||
| [Undertow](https://undertow.io/) | 基于 XNIO 的高性能容器 | 2.7.6 | |
|
| [SpringBoot](https://spring.io/projects/spring-boot/#learn) | 后端主框架 | 3.X | 3.2.6 |
|
||||||
| [Sa-Token](https://sa-token.dev33.cn/) | Sa-Token、Jwt(强解耦、强扩展) | 1.35.0.RC | |
|
| [Undertow](https://undertow.io/) | 基于 XNIO 的高性能容器 | 2.7.6 | |
|
||||||
| [MySQL](https://dev.mysql.com/) | 关系数据库 | 适配 8.X 最低 5.7 | |
|
| [Sa-Token](https://sa-token.dev33.cn/) | Sa-Token、Jwt(强解耦、强扩展) | 1.35.0.RC | |
|
||||||
| [Redis](https://redis.io/) | 缓存数据库 | 适配 6.X 最低 4.X | |
|
| [MySQL](https://dev.mysql.com/) | 关系数据库 | 适配 8.X 最低 5.7 | |
|
||||||
| [Mybatis-Plus](https://baomidou.com/guide/) | 快速 CRUD 增加开发效率 | 3.5.7 | |
|
| [Redis](https://redis.io/) | 缓存数据库 | 适配 6.X 最低 4.X | |
|
||||||
| [Vue](https://staging-cn.vuejs.org/) | vue 框架 | 3.2.45 | |
|
| [Mybatis-Plus](https://baomidou.com/guide/) | 快速 CRUD 增加开发效率 | 3.5.7 | |
|
||||||
| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 4.0.4 | |
|
| [Vue](https://staging-cn.vuejs.org/) | vue 框架 | 3.2.45 | |
|
||||||
| [Element Plus](https://element-plus.org/zh-CN/) | Element Plus | 2.2.28 | |
|
| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 4.0.4 | |
|
||||||
| [TypeScript](https://www.typescriptlang.org/docs/) | JavaScript 的超集 | 4.9.4 | |
|
| [Element Plus](https://element-plus.org/zh-CN/) | Element Plus | 2.2.28 | |
|
||||||
| [pinia](https://pinia.vuejs.org/) | Vue 存储库 替代 vuex5 | 2.0.28 | |
|
| [TypeScript](https://www.typescriptlang.org/docs/) | JavaScript 的超集 | 4.9.4 | |
|
||||||
| [vueuse](https://vueuse.org/) | 常用工具集 | 9.10.0 | |
|
| [pinia](https://pinia.vuejs.org/) | Vue 存储库 替代 vuex5 | 2.0.28 | |
|
||||||
| [vxe-table](https://vxetable.cn/) | vue 最强表单 | 4.3.7 | |
|
| [vueuse](https://vueuse.org/) | 常用工具集 | 9.10.0 | |
|
||||||
| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.2.2 | |
|
| [vxe-table](https://vxetable.cn/) | vue 最强表单 | 4.3.7 | |
|
||||||
| [vue-router](https://router.vuejs.org/) | vue 路由 | 4.1.6 | |
|
| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.2.2 | |
|
||||||
| [windicss](https://cn.windicss.org/) | 下一代工具优先的 CSS 框架 | 3.5.6 | |
|
| [vue-router](https://router.vuejs.org/) | vue 路由 | 4.1.6 | |
|
||||||
| [iconify](https://icon-sets.iconify.design/) | 在线图标库 | 3.0.1 | |
|
| [windicss](https://cn.windicss.org/) | 下一代工具优先的 CSS 框架 | 3.5.6 | |
|
||||||
| [wangeditor](https://www.wangeditor.com/) | 富文本编辑器 | 5.1.23 | |
|
| [iconify](https://icon-sets.iconify.design/) | 在线图标库 | 3.0.1 | |
|
||||||
|
| [wangeditor](https://www.wangeditor.com/) | 富文本编辑器 | 5.1.23 | |
|
||||||
|
|
||||||
## 🏗️项目架构说明
|
## 🏗️项目架构说明
|
||||||
|
|
||||||
### 整体架构
|
### 整体架构
|
||||||
|
|
||||||
MMS(模块化管理系统)采用前后端分离的架构设计,后端基于 Spring Boot 3.x 构建,前端使用 Vue 3.x 技术栈。
|
MMS(模块化管理系统)采用前后端分离的架构设计,后端基于 Spring Boot 3.x 构建,前端使用 Vue 3.x 技术栈。
|
||||||
|
|
||||||
### 后端架构特点
|
### 后端架构特点
|
||||||
|
|
||||||
1. **多模块 Maven 项目结构**:项目采用 Maven 多模块结构,便于模块化开发和维护
|
1. **多模块 Maven 项目结构**:项目采用 Maven 多模块结构,便于模块化开发和维护
|
||||||
2. **Spring Boot 3.x**:基于最新稳定版本的 Spring Boot 框架
|
2. **Spring Boot 3.x**:基于最新稳定版本的 Spring Boot 框架
|
||||||
3. **多数据源支持**:集成 dynamic-datasource-spring-boot-starter,支持多数据源切换
|
3. **多数据源支持**:集成 dynamic-datasource-spring-boot-starter,支持多数据源切换
|
||||||
@ -222,6 +233,7 @@ MMS(模块化管理系统)采用前后端分离的架构设计,后端基
|
|||||||
12. **监控管理**:集成 Spring Boot Admin,提供应用监控能力
|
12. **监控管理**:集成 Spring Boot Admin,提供应用监控能力
|
||||||
|
|
||||||
### 核心模块说明
|
### 核心模块说明
|
||||||
|
|
||||||
1. **mms-admin**:系统管理启动模块,整合各业务模块
|
1. **mms-admin**:系统管理启动模块,整合各业务模块
|
||||||
2. **mms-modules**:核心业务模块集合
|
2. **mms-modules**:核心业务模块集合
|
||||||
- mms-common:公共模块,包含通用工具类和枚举
|
- mms-common:公共模块,包含通用工具类和枚举
|
||||||
@ -240,6 +252,7 @@ MMS(模块化管理系统)采用前后端分离的架构设计,后端基
|
|||||||
## 👨💻开发指南
|
## 👨💻开发指南
|
||||||
|
|
||||||
### 开发环境搭建
|
### 开发环境搭建
|
||||||
|
|
||||||
1. 安装 JDK 17+ 并配置环境变量
|
1. 安装 JDK 17+ 并配置环境变量
|
||||||
2. 安装 Maven 3.6+ 并配置环境变量
|
2. 安装 Maven 3.6+ 并配置环境变量
|
||||||
3. 安装 MySQL 8.0+ 并创建数据库
|
3. 安装 MySQL 8.0+ 并创建数据库
|
||||||
@ -247,6 +260,7 @@ MMS(模块化管理系统)采用前后端分离的架构设计,后端基
|
|||||||
5. 导入 IDE (推荐 IntelliJ IDEA)
|
5. 导入 IDE (推荐 IntelliJ IDEA)
|
||||||
|
|
||||||
### 项目结构说明
|
### 项目结构说明
|
||||||
|
|
||||||
```
|
```
|
||||||
mms
|
mms
|
||||||
├── mms-admin # 系统管理启动模块
|
├── mms-admin # 系统管理启动模块
|
||||||
@ -266,6 +280,7 @@ mms
|
|||||||
```
|
```
|
||||||
|
|
||||||
### 代码规范
|
### 代码规范
|
||||||
|
|
||||||
1. 遵循阿里巴巴 Java 开发手册
|
1. 遵循阿里巴巴 Java 开发手册
|
||||||
2. 使用 Lombok 简化代码
|
2. 使用 Lombok 简化代码
|
||||||
3. 统一使用 MapStruct 进行对象转换
|
3. 统一使用 MapStruct 进行对象转换
|
||||||
@ -274,6 +289,7 @@ mms
|
|||||||
6. 数据访问层使用 MyBatis-Plus
|
6. 数据访问层使用 MyBatis-Plus
|
||||||
|
|
||||||
### 新增业务模块步骤
|
### 新增业务模块步骤
|
||||||
|
|
||||||
1. 在 `mms-modules` 目录下创建新模块
|
1. 在 `mms-modules` 目录下创建新模块
|
||||||
2. 在模块中创建对应的 entity、mapper、service、controller 层
|
2. 在模块中创建对应的 entity、mapper、service、controller 层
|
||||||
3. 在 `mms-admin` 的 pom.xml 中添加模块依赖
|
3. 在 `mms-admin` 的 pom.xml 中添加模块依赖
|
||||||
@ -290,6 +306,7 @@ mms
|
|||||||
4. **代码优化**:优化现有代码结构和性能
|
4. **代码优化**:优化现有代码结构和性能
|
||||||
|
|
||||||
### 贡献流程
|
### 贡献流程
|
||||||
|
|
||||||
1. Fork 项目到自己的 GitHub 账户
|
1. Fork 项目到自己的 GitHub 账户
|
||||||
2. Clone 到本地开发环境
|
2. Clone 到本地开发环境
|
||||||
3. 创建新的分支进行开发
|
3. 创建新的分支进行开发
|
||||||
@ -297,6 +314,7 @@ mms
|
|||||||
5. 发起 Pull Request
|
5. 发起 Pull Request
|
||||||
|
|
||||||
### 代码规范
|
### 代码规范
|
||||||
|
|
||||||
- 遵循项目现有的代码风格
|
- 遵循项目现有的代码风格
|
||||||
- 添加必要的单元测试
|
- 添加必要的单元测试
|
||||||
- 确保代码通过所有测试
|
- 确保代码通过所有测试
|
||||||
@ -413,25 +431,27 @@ mms
|
|||||||
|
|
||||||
MMS基于Spring Boot 3.x构建,采用Maven多模块架构,整合了众多优秀的开源技术框架:
|
MMS基于Spring Boot 3.x构建,采用Maven多模块架构,整合了众多优秀的开源技术框架:
|
||||||
|
|
||||||
| 技术框架 | 说明 | 版本 |
|
|
||||||
|---------|------|------|
|
| 技术框架 | 说明 | 版本 |
|
||||||
| Spring Boot | 后端主框架 | 3.2.6 |
|
| ------------------ | -------------- | --------- |
|
||||||
| MyBatis-Plus | ORM框架 | 3.5.7 |
|
| Spring Boot | 后端主框架 | 3.2.6 |
|
||||||
| Sa-Token | 权限认证框架 | 1.35.0.RC |
|
| MyBatis-Plus | ORM框架 | 3.5.7 |
|
||||||
| Redisson | Redis客户端 | 3.31.0 |
|
| Sa-Token | 权限认证框架 | 1.35.0.RC |
|
||||||
| Dynamic-Datasource | 多数据源支持 | 4.3.1 |
|
| Redisson | Redis客户端 | 3.31.0 |
|
||||||
| MapStruct Plus | 对象映射工具 | 1.4.3 |
|
| Dynamic-Datasource | 多数据源支持 | 4.3.1 |
|
||||||
| Hutool | Java工具库 | 5.8.32 |
|
| MapStruct Plus | 对象映射工具 | 1.4.3 |
|
||||||
| Lombok | Java简化工具 | 1.8.32 |
|
| Hutool | Java工具库 | 5.8.32 |
|
||||||
| EasyExcel | Excel处理 | 4.0.3 |
|
| Lombok | Java简化工具 | 1.8.32 |
|
||||||
| SpringDoc | API文档 | 2.5.0 |
|
| EasyExcel | Excel处理 | 4.0.3 |
|
||||||
| X-File-Storage | 对象存储 | 2.1.0 |
|
| SpringDoc | API文档 | 2.5.0 |
|
||||||
| PowerJob | 分布式任务调度 | 4.3.9 |
|
| X-File-Storage | 对象存储 | 2.1.0 |
|
||||||
| SMS4J | 短信服务 | 3.2.0 |
|
| PowerJob | 分布式任务调度 | 4.3.9 |
|
||||||
|
| SMS4J | 短信服务 | 3.2.0 |
|
||||||
|
|
||||||
### 数据库支持
|
### 数据库支持
|
||||||
|
|
||||||
系统支持多种主流数据库:
|
系统支持多种主流数据库:
|
||||||
|
|
||||||
- MySQL 8.0+
|
- MySQL 8.0+
|
||||||
- Oracle
|
- Oracle
|
||||||
- PostgreSQL
|
- PostgreSQL
|
||||||
@ -442,6 +462,7 @@ MMS基于Spring Boot 3.x构建,采用Maven多模块架构,整合了众多优
|
|||||||
### 消息队列支持
|
### 消息队列支持
|
||||||
|
|
||||||
系统支持多种消息队列中间件:
|
系统支持多种消息队列中间件:
|
||||||
|
|
||||||
- RabbitMQ
|
- RabbitMQ
|
||||||
- RocketMQ
|
- RocketMQ
|
||||||
- Kafka
|
- Kafka
|
||||||
@ -449,6 +470,7 @@ MMS基于Spring Boot 3.x构建,采用Maven多模块架构,整合了众多优
|
|||||||
### 对象存储支持
|
### 对象存储支持
|
||||||
|
|
||||||
系统集成了X-File-Storage,支持多种云存储平台:
|
系统集成了X-File-Storage,支持多种云存储平台:
|
||||||
|
|
||||||
- 阿里云OSS
|
- 阿里云OSS
|
||||||
- 腾讯云COS
|
- 腾讯云COS
|
||||||
- 华为云OBS
|
- 华为云OBS
|
||||||
@ -490,6 +512,7 @@ mms
|
|||||||
## 🌐 多租户架构
|
## 🌐 多租户架构
|
||||||
|
|
||||||
系统采用多租户架构设计,支持以下特性:
|
系统采用多租户架构设计,支持以下特性:
|
||||||
|
|
||||||
1. **数据隔离**:不同租户数据完全隔离
|
1. **数据隔离**:不同租户数据完全隔离
|
||||||
2. **资源共享**:可灵活配置租户间资源共享策略
|
2. **资源共享**:可灵活配置租户间资源共享策略
|
||||||
3. **租户管理**:支持租户创建、配置、停用等管理功能
|
3. **租户管理**:支持租户创建、配置、停用等管理功能
|
||||||
@ -513,19 +536,21 @@ mms
|
|||||||
|
|
||||||
## 📱 前端技术栈
|
## 📱 前端技术栈
|
||||||
|
|
||||||
| 技术框架 | 说明 | 版本 |
|
|
||||||
|---------|------|------|
|
| 技术框架 | 说明 | 版本 |
|
||||||
| Vue | 前端框架 | 3.2.45 |
|
| ------------ | -------- | ------ |
|
||||||
| Vite | 构建工具 | 4.0.4 |
|
| Vue | 前端框架 | 3.2.45 |
|
||||||
|
| Vite | 构建工具 | 4.0.4 |
|
||||||
| Element Plus | UI组件库 | 2.2.28 |
|
| Element Plus | UI组件库 | 2.2.28 |
|
||||||
| TypeScript | 编程语言 | 4.9.4 |
|
| TypeScript | 编程语言 | 4.9.4 |
|
||||||
| Pinia | 状态管理 | 2.0.28 |
|
| Pinia | 状态管理 | 2.0.28 |
|
||||||
| Vue Router | 路由管理 | 4.1.6 |
|
| Vue Router | 路由管理 | 4.1.6 |
|
||||||
| Windi CSS | CSS框架 | 3.5.6 |
|
| Windi CSS | CSS框架 | 3.5.6 |
|
||||||
|
|
||||||
## 🚀 部署架构
|
## 🚀 部署架构
|
||||||
|
|
||||||
系统支持多种部署方式:
|
系统支持多种部署方式:
|
||||||
|
|
||||||
1. **传统部署**:直接运行jar包
|
1. **传统部署**:直接运行jar包
|
||||||
2. **Docker部署**:使用Docker容器化部署
|
2. **Docker部署**:使用Docker容器化部署
|
||||||
3. **Kubernetes部署**:支持K8s集群部署
|
3. **Kubernetes部署**:支持K8s集群部署
|
||||||
@ -542,6 +567,7 @@ mms
|
|||||||
## 📞 技术支持
|
## 📞 技术支持
|
||||||
|
|
||||||
如有问题可以通过以下方式联系技术支持:
|
如有问题可以通过以下方式联系技术支持:
|
||||||
|
|
||||||
- 官方网站:[https://www.mmsadmin.cn](https://www.mmsadmin.cn)
|
- 官方网站:[https://www.mmsadmin.cn](https://www.mmsadmin.cn)
|
||||||
- Gitee仓库:[https://gitee.com/mmsAdmin/mms](https://gitee.com/mmsAdmin/mms)
|
- Gitee仓库:[https://gitee.com/mmsAdmin/mms](https://gitee.com/mmsAdmin/mms)
|
||||||
- 邮箱:sxpcwlkj@163.com
|
- 邮箱:sxpcwlkj@163.com
|
||||||
@ -550,6 +576,7 @@ mms
|
|||||||
## 📄 更新日志
|
## 📄 更新日志
|
||||||
|
|
||||||
### v1.0.6 (2025-02-03)
|
### v1.0.6 (2025-02-03)
|
||||||
|
|
||||||
- [新增] 微信二维码扫描登录
|
- [新增] 微信二维码扫描登录
|
||||||
- [新增] 个人中心手机号绑定
|
- [新增] 个人中心手机号绑定
|
||||||
- [新增] 个人中心邮箱绑定
|
- [新增] 个人中心邮箱绑定
|
||||||
@ -557,16 +584,19 @@ mms
|
|||||||
- [预告] 修复已知BUG
|
- [预告] 修复已知BUG
|
||||||
|
|
||||||
### v1.0.5 (2024-11-14)
|
### v1.0.5 (2024-11-14)
|
||||||
|
|
||||||
- [新增] mms-admin整合easyexcel支持数据的导入/导出(支持字典的自动翻译和导入的逆翻译)
|
- [新增] mms-admin整合easyexcel支持数据的导入/导出(支持字典的自动翻译和导入的逆翻译)
|
||||||
- [新增] mms-ui对Table列表页面进行工具栏的封装(表格数据的导出,导入,打印)等功能
|
- [新增] mms-ui对Table列表页面进行工具栏的封装(表格数据的导出,导入,打印)等功能
|
||||||
- [优化] 系统整体的架构布局优化
|
- [优化] 系统整体的架构布局优化
|
||||||
- [预告] 接口加密,接口防抖,接口限流等技术
|
- [预告] 接口加密,接口防抖,接口限流等技术
|
||||||
|
|
||||||
### v1.0.4 (2024-10-20)
|
### v1.0.4 (2024-10-20)
|
||||||
|
|
||||||
- [更新] mms-ui sass文件的引入方式,由`@import`换为`@use`
|
- [更新] 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.)
|
- [注意] (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)
|
### v1.0.3 (2024-08-02)
|
||||||
|
|
||||||
- [升级] mms-generator代码生产模块
|
- [升级] mms-generator代码生产模块
|
||||||
- [新增] mms-power job分布式定时任务模块
|
- [新增] mms-power job分布式定时任务模块
|
||||||
- [新增] mms-mq消息队列模块
|
- [新增] mms-mq消息队列模块
|
||||||
@ -574,11 +604,13 @@ mms
|
|||||||
- [优化] mms-ui优化适配
|
- [优化] mms-ui优化适配
|
||||||
|
|
||||||
### v1.0.2 (2024-05-10)
|
### v1.0.2 (2024-05-10)
|
||||||
|
|
||||||
- [新增] mms-aliyun阿里云生态模块
|
- [新增] mms-aliyun阿里云生态模块
|
||||||
- [新增] mms-wx微信生态模块
|
- [新增] mms-wx微信生态模块
|
||||||
- [新增] mms-demo Demo模块
|
- [新增] mms-demo Demo模块
|
||||||
|
|
||||||
### v1.0.1 (2024-02-10)
|
### v1.0.1 (2024-02-10)
|
||||||
|
|
||||||
- [新增] mms-system管理系统模块
|
- [新增] mms-system管理系统模块
|
||||||
- [新增] mms-common公共模块抽取
|
- [新增] mms-common公共模块抽取
|
||||||
- [新增] mms-redis独立redis模块
|
- [新增] mms-redis独立redis模块
|
||||||
@ -588,4 +620,5 @@ mms
|
|||||||
- [新增] mms-oss对象存储模块
|
- [新增] mms-oss对象存储模块
|
||||||
|
|
||||||
### v1.0.0 (2023-12-01)
|
### v1.0.0 (2023-12-01)
|
||||||
- [发布] MMS模块化管理系统正式开源发布
|
|
||||||
|
- [发布] MMS模块化管理系统正式开源发布
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user