135 lines
6.8 KiB
Markdown
135 lines
6.8 KiB
Markdown
|
||
<div align="center">
|
||
<img alt="logo" width="100" height="80" src="https://foruda.gitee.com/images/1723523431330022522/d29e7354_716974.png">
|
||
<h2>youlai-boot</h2>
|
||
<img alt="有来技术" src="https://img.shields.io/badge/Java -17-brightgreen.svg"/>
|
||
<img alt="有来技术" src="https://img.shields.io/badge/SpringBoot-3.3.0-green.svg"/>
|
||
<a href="https://gitee.com/youlaiorg/youlai-boot" target="_blank">
|
||
<img alt="有来技术" src="https://gitee.com/youlaiorg/youlai-boot/badge/star.svg"/>
|
||
</a>
|
||
<a href="https://github.com/haoxianrui" target="_blank">
|
||
<img alt="有来技术" src="https://img.shields.io/github/stars/haoxianrui/youlai-boot.svg?style=social&label=Stars"/>
|
||
</a>
|
||
<br/>
|
||
<img alt="有来技术" src="https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg"/>
|
||
<a href="https://gitee.com/youlaiorg" target="_blank">
|
||
<img alt="有来技术" src="https://img.shields.io/badge/Author-有来开源组织-orange.svg"/>
|
||
</a>
|
||
</div>
|
||
|
||
|
||
|
||
<div align="center">
|
||
<a target="_blank" href="https://admin.youlai.tech/">🔍 在线预览</a> | <a target="_blank" href="https://doc.youlai.tech/%E5%89%8D%E5%90%8E%E7%AB%AF%E6%A8%A1%E6%9D%BF/%E5%90%8E%E7%AB%AF%E6%89%8B%E5%86%8C/%E9%A1%B9%E7%9B%AE%E7%AE%80%E4%BB%8B.html">📖 阅读文档</a> | <a href="./README.en-US.md">🌐English</a>
|
||
</div>
|
||
|
||
## 📢 项目简介
|
||
|
||
**在线预览**: [https://vue3.youlai.tech](https://vue3.youlai.tech)
|
||
|
||
基于 JDK 17、Spring Boot 3、Spring Security 6、JWT、Redis、Mybatis-Plus、Knife4j、Vue 3、Element-Plus 构建的前后端分离单体权限管理系统。
|
||
|
||
- **🚀 开发框架**: 使用 Spring Boot 3 和 Vue 3，以及 Element-Plus 等主流技术栈，实时更新。
|
||
|
||
- **🔐 安全认证**: 结合 Spring Security 和 JWT 提供安全、无状态、分布式友好的身份验证和授权机制。
|
||
|
||
- **🔑 权限管理**: 基于 RBAC 模型，实现细粒度的权限控制，涵盖接口方法和按钮级别。
|
||
|
||
- **🛠️ 功能模块**: 包括用户管理、角色管理、菜单管理、部门管理、字典管理等多个功能。
|
||
|
||
- **📘 接口文档**: 自动生成接口文档，支持在线调试，提高开发效率。
|
||
|
||
## 📁 项目目录
|
||
```
|
||
youlai-boot
|
||
├── sql # SQL脚本
|
||
├── mysql5 # MySQL5 脚本
|
||
├── mysql8 # MySQL8 脚本
|
||
├── src # 源码目录
|
||
├── common # 公共模块
|
||
├── config # 自动装配配置
|
||
├── CorsConfig # 跨域共享配置
|
||
├── MybatisConfig # Mybatis 自动装配配置
|
||
├── RedisCacheConfig # Redis 缓存自动装配配置
|
||
├── RedisConfig # Redis 自动装配配置
|
||
├── SecurityConfig # Spring Security 自动装配配置
|
||
├── SwaggerConfig # API 接口文档配置
|
||
├── WebMvcConfig # WebMvc 配置
|
||
├── WebSocketConfig # WebSocket 自动装配配置
|
||
├── XxlJobConfig # XXL-JOB 自动装配配置
|
||
├── controller # 控制层
|
||
├── converter # MapStruct 转换器
|
||
├── filter # 过滤器
|
||
├── RequestLogFilter # 请求日志过滤器
|
||
├── VerifyCodeFilter # 验证码过滤器
|
||
├── model # 模型层
|
||
├── bo # 业务对象
|
||
├── dto # 数据传输对象
|
||
├── entity # 实体对象
|
||
├── form # 表单对象
|
||
├── query # 查询参数对象
|
||
├── vo # 视图对象
|
||
├── mapper # 数据库访问层
|
||
├── plugin # 插件(可选)
|
||
├── captcha # 验证码插件，用于生成验证码
|
||
├── dupsubmit # 防重提交插件，用于防止表单重复提交
|
||
├── mybatis # Mybatis 插件，数据权限、字段填充
|
||
├── easyexcel # EasyExcel 插件，Excel 文件的读写
|
||
├── xxljob # XXL-JOB 插件，分布式任务调度和执行
|
||
├── security # Spring Security 安全配置和扩展
|
||
├── util # 工具类
|
||
├── JwtUtils # JWT 工具类，用于生成和解析 JWT
|
||
├── SecurityUtils # Spring Security 工具类，用于获取当前登录用户
|
||
├── service # 业务逻辑层
|
||
|
||
|
||
└── end
|
||
```
|
||
|
||
## 🌺 前端工程
|
||
| Gitee | Github |
|
||
|-------|------|
|
||
| [vue3-element-admin](https://gitee.com/youlaiorg/vue3-element-admin) | [vue3-element-admin](https://github.com/youlaitech/vue3-element-admin) |
|
||
|
||
|
||
## 🌈 接口文档
|
||
|
||
- `knife4j` 接口文档：[http://localhost:8989/doc.html](http://localhost:8989/doc.html)
|
||
- `swagger` 接口文档：[http://localhost:8989/swagger-ui/index.html](http://localhost:8989/swagger-ui/index.html)
|
||
- `apifox` 在线接口文档：[https://www.apifox.cn/apidoc](https://www.apifox.cn/apidoc/shared-195e783f-4d85-4235-a038-eec696de4ea5)
|
||
|
||
|
||
## 🚀 项目启动
|
||
|
||
1. **数据库初始化**
|
||
|
||
执行 [youlai_boot.sql](sql/mysql8/youlai_boot.sql) 脚本完成数据库创建、表结构和基础数据的初始化。
|
||
|
||
2. **修改配置**
|
||
|
||
[application-dev.yml](src/main/resources/application-dev.yml) 修改MySQL、Redis连接配置；
|
||
|
||
3. **启动项目**
|
||
|
||
执行 [SystemApplication.java](src/main/java/com/youlai/system/SystemApplication.java) 的 main 方法完成后端项目启动；
|
||
|
||
访问接口文档地址 [http://localhost:8989/doc.html](http://localhost:8989/doc.html) 验证项目启动是否成功。
|
||
|
||
## ✅ 项目统计
|
||
|
||
|
||
|
||
Thanks to all the contributors!
|
||
|
||
[](https://github.com/haoxianrui/youlai-boot/graphs/contributors)
|
||
|
||
|
||
## 💖 加交流群
|
||
|
||
> 关注公众号【有来技术】，获取交流群二维码，不想关注公众号或二维码过期欢迎加我微信(`haoxianrui`)备注【有来】即可，拉你进群。
|
||
|
||
|  |
|
||
|---------------------------------------------------------|
|
||
|
||
|