# quickSpringboot

**Repository Path**: creepzzart/quick-springboot

## Basic Information

- **Project Name**: quickSpringboot
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-01-14
- **Last Updated**: 2026-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# QuickSpringBoot - 轻量级后台管理脚手架

基于 Spring Boot 3 + Vue 3 + Element Plus 的通用后台管理系统脚手架，定位介于极简模板和 RuoYi 重型框架之间，开箱即用。

## 技术栈

### 后端
| 技术 | 版本 | 说明 |
|------|------|------|
| Spring Boot | 3.2.5 | 主框架 |
| MyBatis-Plus | 3.5.7 | ORM 框架 |
| Sa-Token | 1.39.0 | 权限认证 |
| MySQL | 8.0+ | 数据库 |
| Hutool | 5.8.27 | 工具集 |
| Lombok | - | 代码简化 |

### 前端
| 技术 | 版本 | 说明 |
|------|------|------|
| Vue | 3.4+ | 前端框架 |
| Element Plus | 2.7+ | UI 组件库 |
| Vite | 5.0+ | 构建工具 |
| Pinia | 3.0+ | 状态管理 |
| Vue Router | 4.6+ | 路由管理 |
| Axios | 1.13+ | HTTP 请求 |
| ECharts | 6.0+ | 图表库 |

## 功能模块

### 系统管理
- **用户管理** - 用户 CRUD、状态控制、密码重置、部门关联、角色分配
- **角色管理** - 角色 CRUD、菜单权限分配（树形勾选）
- **菜单管理** - 目录/菜单/按钮三级结构，关联路由和权限标识
- **部门管理** - 树形组织架构 CRUD
- **字典管理** - 字典类型 + 字典项，支持前端缓存

### 系统监控
- **操作日志** - 基于 @OperLog 注解 + AOP 自动记录操作行为
- **文件管理** - 本地存储 + 预览 + 删除

### 通用能力
- Sa-Token 登录认证（JWT 状态模式、踢人下线）
- RBAC 权限模型（用户-角色-菜单）
- 全局异常处理（含 Sa-Token 异常拦截）
- MyBatis-Plus 分页 + 自动填充
- 操作日志 AOP 切面
- 响应统一封装 `Result<T>`

## 项目结构

```
├── quickspringboot/                # 后端项目
│   └── src/main/
│       ├── java/com/qx/springboot/
│       │   ├── common/             # 通用：Result、PageResult、注解、AOP
│       │   ├── config/             # 配置：MyBatis-Plus、Sa-Token、跨域
│       │   ├── controller/         # 控制器层
│       │   ├── mapper/             # 数据访问层
│       │   ├── model/              # 实体类
│       │   └── service/            # 业务逻辑层
│       └── resources/
│           ├── application.yml     # 配置文件
│           ├── mapper/             # MyBatis XML
│           └── sql/init.sql        # 数据库初始化脚本
│
└── quickfront/                     # 前端项目
    └── src/
        ├── layouts/                # 布局组件
        ├── mock/                   # Mock 数据
        ├── router/                 # 路由配置
        ├── store/                  # Pinia 状态管理
        ├── utils/                  # 工具函数（axios 封装）
        └── views/
            ├── dashboard/          # 控制台
            ├── system/             # 系统管理
            │   ├── user/           # 用户管理
            │   ├── role/           # 角色管理
            │   ├── menu/           # 菜单管理
            │   ├── dept/           # 部门管理
            │   └── dict/           # 字典管理
            ├── monitor/            # 系统监控
            │   ├── operlog/        # 操作日志
            │   └── file/           # 文件管理
            └── example/            # 示例页面（可作为新页面模板）
```

## 快速开始

### 1. 数据库

```sql
CREATE DATABASE quick_boot DEFAULT CHARACTER SET utf8mb4;
```

执行初始化脚本：`quickspringboot/src/main/resources/sql/init.sql`

### 2. 启动后端

修改 `application.yml` 中的数据库连接信息，然后：

```bash
cd quickspringboot
mvn spring-boot:run
# 或在 IDEA 中运行 SpringbootApplication.java
```

后端启动在 http://localhost:8080

### 3. 启动前端

```bash
cd quickfront
npm install
npm run dev
```

前端启动在 http://localhost:5173

### 4. 登录

- 账号：`admin`
- 密码：`admin123`

## 数据库表

| 表名 | 说明 |
|------|------|
| sys_dept | 部门表 |
| sys_user | 用户表 |
| sys_role | 角色表 |
| sys_user_role | 用户角色关联表 |
| sys_menu | 菜单表 |
| sys_role_menu | 角色菜单关联表 |
| sys_dict_type | 字典类型表 |
| sys_dict_data | 字典数据表 |
| sys_oper_log | 操作日志表 |
| sys_file | 文件表 |

## 开发指南

### 添加新页面

1. 在 `quickfront/src/views/` 创建页面组件
2. 在 `quickfront/src/router/index.js` 添加路由配置
3. 路由 meta 配置：`title`（菜单标题）、`icon`（图标）、`hidden`（是否隐藏）

### 参考模板

`quickfront/src/views/example/index.vue` 包含完整的搜索 + 表格 + 分页 + 弹窗模板，可直接复制作为新页面起点。

## 部署

### 后端打包

```bash
cd quickspringboot
mvn clean package
java -jar target/springboot-0.0.1-SNAPSHOT.jar
```

### 前端打包

```bash
cd quickfront
npm run build
```

打包产物在 `quickfront/dist/` 目录，部署到 Nginx 或其他 Web 服务器。

## 许可证

MIT