From 9022c405d9311f7b8f7a98563347d318630ade4f Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 26 Jun 2025 07:17:04 +0000 Subject: [PATCH] Update README.md --- README.md | 234 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 122 insertions(+), 112 deletions(-) diff --git a/README.md b/README.md index 51e9adb..0b762ec 100644 --- a/README.md +++ b/README.md @@ -1,112 +1,122 @@ -#### [B2C在线商城版本演示地址](https://shop.frsimple.cn) -#### [企业级中后台解决方案 pro版本演示地址](https://pro.frsimple.cn) - -#### [SpringBoot 单体服务中后台解决方案传送门](https://gitee.com/frsimple/springboot) - -#### 官网地址 - -[官网地址](http://frsimple.cn) - -#### 前端源码地址 - -[vue3](https://gitee.com/frsimple/view) - -#### 系统截图 - - - - - - - - - - - - - -
- - - -#### 演示地址 - -[vue3版本](http://vue.frsimple.cn) - -#### 软件架构 - - -基础框架：SpringBoot 2| Spring Gateway | Spring Cloud Alibaba | Feign - -授权认证：Spring Security Oauth2.0 (支持自定义手机验证码登录) - -配置/注册中心: nacos - -熔断：Hystrix - -限流：Gateway令牌桶 - -分布式事务：Seata - -高可用缓存：Redis - -持久层：MyBatis Plus （支持动态数据源） - -数据库连接池：Alibaba.druid - -文件存储：阿里oss ｜ 腾讯cos ｜ minio - -短信服务： 阿里云 ｜ 腾讯云 - -邮件服务： hutool工具类-MailUtil - - -#### 开发部署 - -开发工具：idea -数据库版本： mysql8.0 -redis版本： 5.0.14 -nacos版本： 2.x.x - - -- 启动redis - - ![输入图片说明](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/3271658990350_.pic.jpg) - -- 启动nacos（需要修改数据库连接的配置文件） - - ![输入图片说明](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/3281658990468_.pic.jpg) - -- 下载并且解压缩代码，打开idea导出 - -![输入图片说明](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/3261658990023_.pic.jpg) - -- 启动服务 - - 依次启动服务 - RouteApp,GrantApp,CenterApp - - -#### 目录结构 -```shell -│ -├─ simple-base //框架基础模块 -│ │ ├─ simple-cache //redis缓存 -│ │ ├─ simple-common //公共模块(短信发送，邮件发送，文件存储工具类等) -│ │ ├─ simple-datasource //mybatis-plus持久层，数据池，动态数据源 -│ │ ├─ simple-security //spring security公共模块(所有微服务必须依赖) -│ │ ├─ simple-xxljob //分布式任务调度(要用到任务调度的必须依赖) -│ -├─ simple-center //中台服务模块 -│ -├─ simple-grant //oauth2.0授权认证模块 -│ -├─ simple-route //gateway网关模块 -│ -├─ simple-plan //二次开发demo模块 -│ -├─ simple-code //代码生成模块 -│ -├─ simple-job //分布式任务调度 -│ -``` \ No newline at end of file +# SpringBoot 单体服务中后台解决方案 + +这是一个基于 SpringBoot 的企业级中后台解决方案，适用于快速搭建后台管理系统。该解决方案集成了权限管理、日志记录、任务调度、文件存储、短信/邮件通知等常用功能模块。 + +## 功能特性 + +- **权限管理**：支持角色、菜单、按钮级别的权限控制 +- **日志记录**：完整记录用户操作日志 +- **任务调度**：集成 XXL-JOB 实现分布式任务调度 +- **多租户支持**：支持多机构/多租户管理模式 +- **统一认证**：支持短信验证码、第三方登录等多种认证方式 +- **文件存储**：支持阿里云OSS、腾讯云COS、MinIO等多种存储方式 +- **消息通知**：集成短信、邮件通知功能 +- **代码生成**：提供数据库表结构自动生成代码功能 + +## 技术栈 + +- Spring Boot +- MyBatis Plus +- Spring Security / OAuth2 +- Redis +- XXL-JOB +- Spring Cloud Alibaba +- MySQL / PostgreSQL / Oracle 等多种数据库支持 + +## 模块说明 + +- `simple-center`: 核心中后台模块，包含用户、角色、权限、日志等基础功能 +- `simple-grant`: 认证授权模块，实现统一的认证中心 +- `simple-job`: 任务调度模块，集成 XXL-JOB +- `simple-code`: 代码生成模块，支持数据库表结构自动生成代码 +- `simple-security`: 安全相关模块，包含权限控制、日志记录等功能 +- `simple-datasource`: 数据源配置模块 +- `simple-common`: 公共工具类模块 +- `simple-cache`: Redis 缓存集成模块 + +## 快速开始 + +### 环境要求 + +- JDK 1.8+ +- Maven 3.5+ +- MySQL 5.7+ 或其他支持的数据库 +- Redis 3.0+ + +### 启动步骤 + +1. 克隆项目到本地 +2. 修改各模块的 `application.yml` 配置文件，配置数据库和 Redis 连接信息 +3. 执行数据库脚本创建所需表结构 +4. 使用 Maven 构建项目：`mvn clean install` +5. 启动各个模块： + - `simple-center`: `mvn spring-boot:run` + - `simple-grant`: `mvn spring-boot:run` + - `simple-job`: `mvn spring-boot:run` + +### 系统截图 + +![系统截图](service/simple-center/src/main/resources/static/screenshot.png) + +## 使用文档 + +### 接口文档 + +- 用户管理：`/user/*` +- 角色管理：`/role/*` +- 菜单管理：`/menu/*` +- 日志管理：`/logs/*` +- 文件存储：`/oss/*` +- 短信服务：`/sms/*` +- 邮件服务：`/email/*` +- 任务调度：访问 `/admin/xxl-job` + +### 配置说明 + +- 数据库配置：`application.yml` 中的 `spring.datasource` 配置项 +- Redis 配置：`application.yml` 中的 `spring.redis` 配置项 +- 文件存储配置：`application.yml` 中的 `oss` 配置项 +- 短信配置：`application.yml` 中的 `sms` 配置项 +- 邮件配置：`application.yml` 中的 `email` 配置项 + +## 开发部署 + +### 数据库设计 + +项目使用 MyBatis Plus 进行数据库操作，主要表结构包括： +- 用户表：`center_user` +- 角色表：`center_role` +- 菜单表：`center_menu` +- 日志表：`center_logs` +- 文件存储配置表：`center_oss` +- 短信配置表：`center_sms` +- 邮件配置表：`center_email` + +### 目录结构 + +``` +service/ +├── simple-base/ # 基础模块 +│ ├── simple-cache/ # Redis 缓存集成 +│ ├── simple-common/ # 公共类库 +│ ├── simple-datasource/# 数据源配置 +│ ├── simple-security/ # 安全框架 +│ └── simple-xxljob/ # XXL-JOB 集成 +├── simple-center/ # 核心中后台模块 +├── simple-grant/ # 认证授权模块 +├── simple-job/ # 任务调度模块 +└── simple-code/ # 代码生成模块 +``` + +## 演示地址 + +- [B2C在线商城版本演示地址](https://shop.frsimple.cn) +- [企业级中后台解决方案 pro版本演示地址](https://pro.frsimple.cn) + +## 联系我们 + +如需技术支持或商务合作，请访问官网或发送邮件至项目维护团队。 + +## 许可协议 + +本项目遵循 [MIT License](LICENSE) 协议。 \ No newline at end of file -- Gitee