# springboot-template

**Repository Path**: zk3171476310/springboot-template

## Basic Information

- **Project Name**: springboot-template
- **Description**: 基础模板包含mysql、redis、sa-token
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-20
- **Last Updated**: 2025-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🌱 SpringBoot RBAC 权限管理系统模板

<div align="center">

![Spring Boot](https://img.shields.io/badge/Spring%20Boot-2.3.3.RELEASE-brightgreen?logo=springboot)
![Sa-Token](https://img.shields.io/badge/Sa--Token-1.44.0-orange?logo=apache)
![MySQL](https://img.shields.io/badge/MySQL-8.0.33-blue?logo=mysql)
![Redis](https://img.shields.io/badge/Redis-white?logo=redis)
![License](https://img.shields.io/badge/license-MIT-blue.svg)

**一个基于 SpringBoot + Sa-Token 的现代化、轻量级 RBAC（基于角色的访问控制）后端模板**

</div>

---

## 📖 项目介绍

这是一个开箱即用的 Spring Boot 后端项目模板，专门为需要精细化权限管理的系统而设计。它整合了 `Sa-Token` 作为权限认证框架，`MyBatis-Plus` 作为数据访问层，提供了完整且易于扩展的 **用户-角色-权限** 模型。

无论是用于毕业设计、个人项目还是企业级应用的快速原型开发，这个模板都能为你提供一个坚实的基础。

### ✨ 项目特点

- 🎯 **完备的 RBAC 模型**: 内置用户、角色、权限、用户-角色、角色-权限五张核心表。
- 🔐 **强大的权限认证**: 基于 `Sa-Token`，支持登录认证、角色认证、权限码认证等多种鉴权方式。
- 🚀 **高效的开发体验**: 整合 `MyBatis-Plus` 和 `Lombok`，极大简化了数据操作和模型代码。
- 📄 **清晰的 API 文档**: 集成 `Knife4j`，自动生成美观且强大的 API 交互文档。
- ⚙️ **全局统一处理**: 包含全局异常处理器和统一的响应结果封装，规范后端接口。
- 🌱 **易于扩展**: 代码结构清晰，遵循最佳实践，方便你在其上进行二次开发。

## 🛠️ 技术栈

|          | 技术栈                  | 说明                     |
| :------- | :--------------------- | :----------------------- |
| **核心框架** | Spring Boot            | 构建应用的基础             |
| **安全框架** | Sa-Token               | 负责用户认证与权限控制     |
| **数据库**   | MySQL                  | 关系型数据库存储           |
| **数据访问** | MyBatis-Plus           | `MyBatis` 增强工具，简化 CRUD |
| **缓存**     | Redis                  | 用于 Sa-Token 会话存储     |
| **API 文档** | Knife4j                | Swagger 增强版，界面更美观 |
| **工具库**   | Hutool, Lombok         | 提高开发效率的工具集       |


## 🚀 快速开始

### 1. 环境准备

- JDK 1.8+
- Maven 3.5+
- MySQL 5.7+
- Redis

### 2. 克隆项目

```bash
git clone https://github.com/your-username/springboot-template.git
cd springboot-template
```

### 3. 配置

① **创建数据库**

在你的 MySQL 中创建一个新的数据库，例如 `rbac_db`。

② **导入表结构**

将项目根目录下的 `init.sql` 文件导入到你刚创建的数据库中，这会创建所有必需的表。

③ **修改配置文件**

打开 `src/main/resources/application.yml`，根据你的本地环境修改以下配置：

- `spring.datasource`: 配置 MySQL 数据库的地址、用户名和密码。
- `spring.redis`: 配置 Redis 的地址、端口和密码。

### 4. 运行项目

直接运行 `src/main/java/com/pj/RbacApplication.java` 的 `main` 方法即可启动项目。

当控制台输出 `Tomcat started on port(s): 8888 (http)` 时，表示项目已成功启动。


## 📄 API 文档

项目启动后，访问以下地址即可查看由 Knife4j 生成的 API 文档：

[http://localhost:8888/doc.html](http://localhost:8888/doc.html)

你可以在此页面上方便地浏览所有 API 接口、模型定义，并进行在线调试。

## 🤝 贡献

欢迎提交 Pull Request 或 Issue 来帮助我们改进这个项目！

## 📝 开源协议

本项目采用 [MIT 许可证](LICENSE)。