From dcfb953ebea48b0fbe7885b0b9d080b62a22aa17 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 19 Sep 2025 07:17:58 +0000 Subject: [PATCH] Update README.md --- README.md | 103 +++++++++++++++++++++++++++++------------------------- 1 file changed, 55 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 527b9bd..6889e01 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,48 @@ # FrSimple 项目文档 +FrSimple 是一个基于 SpringBoot 的企业级开发框架，旨在提供一套完整的权限管理及后台支撑系统。该项目采用现代化的技术栈，支持多版本 UI 框架，并提供丰富的功能模块和良好的扩展性。 + +## 演示环境 -## pro版本演示环境 - [tdesign版本](https://pro.frsimple.com) - [element plus版本](https://el.frsimple.com) - [antdesign版本](https://antd.frsimple.com) - [naive ui版本](https://naive.frsimple.com) ## 官网地址 + [官方网站](http://frsimple.com) ## 系统预览 - - - - - - - - - - - - -
- +![系统预览图1](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/v1.png) +![系统预览图2](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/v2.png) +![系统预览图3](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/v3.png) +![系统预览图4](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/v4.png) +![系统预览图5](https://pengpengyu-test.oss-cn-zhangjiakou.aliyuncs.com/image/v5.png) ## 软件架构 -- 基础框架：SpringBoot 3.2.7 -- 授权认证：sa-token（轻量级的Java权限认证框架 1.43.0） -- 高可用缓存：Redis -- 持久层：MyBatis Plus -- 数据库连接池：Alibaba Druid -- 文件存储：MinIO -- 在线接口文档：SpringDoc -- 短信服务：阿里云 | 腾讯云 -- 工具类：HuTool | IdGenerator + +- **基础框架**：SpringBoot 3.2.7 +- **授权认证**：sa-token（轻量级的Java权限认证框架 1.43.0） +- **高可用缓存**：Redis +- **持久层**：MyBatis Plus +- **数据库连接池**：Alibaba Druid +- **文件存储**：MinIO +- **在线接口文档**：SpringDoc +- **短信服务**：阿里云 | 腾讯云 +- **工具类**：HuTool | IdGenerator ## 开发部署 + ### 开发工具 + - IDE：IntelliJ IDEA - 数据库：MySQL 8.0 - Redis版本：5.0.14 ## 目录结构 + ``` ├─ simple-boot // 父级工程 │ ├─ simple-base // 基础公共模块 @@ -53,22 +51,26 @@ ``` ## 功能特性 + ### 用户权限管理 + - 基于sa-token实现的权限认证 -- 支持多级权限控制（@SaCheckPermission注解） +- 支持多级权限控制（`@SaCheckPermission`注解） - 完善的登录/注销功能 - 用户信息管理（头像、密码、手机号、邮箱等） - 支持管理员踢人下线功能 ### 系统管理 -- 菜单管理：支持菜单树形结构，权限分配 -- 字典管理：支持系统级字典配置 -- 日志管理：记录系统操作日志 -- 数据源管理：支持多数据源配置 -- 角色管理：支持角色权限分配 -- 组织管理：机构组织架构维护 + +- **菜单管理**：支持菜单树形结构，权限分配 +- **字典管理**：支持系统级字典配置 +- **日志管理**：记录系统操作日志 +- **数据源管理**：支持多数据源配置 +- **角色管理**：支持角色权限分配 +- **组织管理**：机构组织架构维护 ### 文件存储 + - 支持多种存储方式： - 阿里云OSS - 腾讯云COS @@ -77,35 +79,40 @@ - 文件链接生成与管理 ### 短信&邮件 + - 支持多云短信服务： - 阿里云短信 - 腾讯云短信 - 完整的邮件发送功能 - 短信/邮件配置管理 -## 代码生成 +### 代码生成 + - 支持根据数据库表结构自动生成代码 - 提供代码模板管理 - 支持ZIP打包下载生成的代码 -## 异常处理 -- 统一的异常处理机制（GlobalExceptionHandler） +### 异常处理 + +- 统一的异常处理机制（`GlobalExceptionHandler`） - 支持多种异常类型： - - WorkFlowException - - CustomException - - FileException - - NotLoginException - - NotPermissionException - - IllegalArgumentException - -## 特色功能 + - `WorkFlowException` + - `CustomException` + - `FileException` + - `NotLoginException` + - `NotPermissionException` + - `IllegalArgumentException` + +### 特色功能 + - Redis数据初始化：自动加载OSS、邮件、短信、字典等配置信息 - XXL-JOB定时任务支持：包含演示任务和分片任务 -- 数据库字段自动填充：使用CustomMetaObjectHandler -- 雪花算法ID生成：SnowFlakeConfig -- 动态数据源：支持MyBatis Plus的@DS注解 +- 数据库字段自动填充：使用`CustomMetaObjectHandler` +- 雪花算法ID生成：`SnowFlakeConfig` +- 动态数据源：支持MyBatis Plus的`@DS`注解 + +### 接口文档 -## 接口文档 - 集成SpringDoc API文档 -- 自定义文档配置（SpringDocConfig） -- 支持OpenAPI 3规范 +- 自定义文档配置（`SpringDocConfig`） +- 支持OpenAPI 3规范 \ No newline at end of file -- Gitee