# quickboot

**Repository Path**: hexlo-dev/quickboot

## Basic Information

- **Project Name**: quickboot
- **Description**: 快速开发平台
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 11
- **Forks**: 2
- **Created**: 2023-09-07
- **Last Updated**: 2026-01-12

## Categories & Tags

**Categories**: backend

**Tags**: None

## README



# Quick-Boot

**🚀 快速开发框架 | 基于 Spring Boot 的现代化企业级解决方案**

## 📖 项目简介

Quick-Boot 是一款基于 Spring Boot 3 构建的现代化快速开发平台。框架集成了业界主流的技术栈，采用模块化设计，旨在帮助开发者快速构建企业级应用，专注于业务逻辑实现，而非重复的基础搭建。

项目结构清晰，划分为 `common` (通用), `core` (核心), `data` (数据增强), `system` (业务系统), `web` (启动入口) 五大模块。

## ✨ 核心特性

1.  **企业级权限体系**：集成 `Sa-Token`，支持注解鉴权、路由拦截、账号Session管理等，提供完善的 RBAC (基于角色的访问控制) 能力。
2.  **数据权限控制**：内置数据权限拦截器 (`DataPermissionInterceptor`)，支持基于部门的行级数据隔离，满足不同角色的数据可见性需求。
3.  **智能代码生成**：提供在线代码生成功能 (`/generator`)，支持根据数据库表结构一键生成 Controller、Service、Mapper、Entity、Vue 前端代码。
4.  **高效数据处理**：
    *   **Excel**：支持百万级数据的 EasyExcel 导出与导入。
    *   **文件存储**：支持本地存储与 MinIO 对象存储，统一接口设计。
5.  **定时任务管理**：基于 `Quartz` 的可视化定时任务管理模块，支持 Cron 表达式，任务执行日志记录。
6.  **完整日志体系**：记录登录日志、操作日志，支持链路追踪 (`traceId`)，便于问题排查。

## 🏗️ 模块架构

| 模块名称 | 包名 | 职责说明 |
| :--- | :--- | :--- |
| **quick-boot-web** | `com.su60.quickboot.web` | 项目启动入口，包含全局配置（跨域、安全头、Sa-Token配置）、全局异常处理器。 |
| **quick-boot-system** | `com.su60.quickboot.system` | 核心业务模块，包含用户(User)、角色(Role)、菜单(Menu)、部门(Dept)、字典(Dict)、配置(Config)、定时任务(Quartz)等模块的 Controller、Service、Entity。 |
| **quick-boot-data** | `com.su60.quickboot.data` | 数据层增强工具集，提供代码生成器、Excel工具类、文件上传下载封装、数据权限切面、MyBatis-Plus 扩展。 |
| **quick-boot-core** | `com.su60.quickboot.core` | 核心配置类，包括 Jackson 序列化配置、MyBatis-Plus 元对象处理器(自动填充)、登录用户实体。 |
| **quick-boot-common** | `com.su60.quickboot.common` | 基础通用层，提供工具类 (`BeanConvertUtils`, `ServletUtil`)、通用响应对象 (`R`)、异常体系 (`BaseException`)、验证码服务 (`CaptchaService`)、密码加密工具 (`PasswordEncoder`)。 |

## 🛠️ 技术栈

*   **核心框架**：Spring Boot 3
*   **ORM**：MyBatis-Plus
*   **安全框架**：Sa-Token
*   **定时任务**：Quartz
*   **Excel处理**：EasyExcel
*   **工具库**：Hutool
*   **数据库**：MySQL / PostgreSQL
*   **文档生成**：Smart-Doc (API文档)

## 🚀 快速开始

### 1. 环境准备
*   JDK 17+
*   Maven 3.6+
*   MySQL 5.7+ / 8.0+

### 2. 数据库初始化
请导入项目目录下的数据库脚本：
`quick-boot/doc/sql/quickboot.pdma.json`
(可使用 PDMan 等工具打开，或查找对应的 SQL 文件执行)

### 3. 编译运行
```bash
# 克隆项目
git clone https://gitee.com/hexlo-dev/quickboot.git

# 进入项目根目录
cd quickboot

# 编译安装
mvn clean install -DskipTests

# 启动项目 (在 quick-boot-web 模块下)
cd quick-boot-web
mvn spring-boot:run
```

### 4. 访问项目
*   **API 文档地址**：`http://localhost:8080/doc.html` (需配置 smart-doc)
*   **默认管理账号**：请查阅数据库初始化脚本中的默认用户数据。

## 📂 项目文档

详细的开发指南、组件文档及二次开发说明请查阅 `docs/` 目录（基于 VitePress 构建）。

## 🤝 贡献指南

1.  Fork 本仓库。
2.  创建您的特性分支 (`git checkout -b feature/AmazingFeature`)。
3.  提交您的改动 (`git commit -m 'Add some AmazingFeature'`)。
4.  推送到分支 (`git push origin feature/AmazingFeature`)。
5.  开启一个 Pull Request。

## 📄 许可证

本项目遵循 [Apache License 2.0](LICENSE) 开源协议。