# magee-boot-simple

**Repository Path**: magee-qs/magee-boot-simple

## Basic Information

- **Project Name**: magee-boot-simple
- **Description**: spring-boot快速开发框架，用于小程序、网站等小型应用的用户管理、权限控制
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-03
- **Last Updated**: 2026-01-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# magee-boot-simple

## 介绍
`magee-boot-simple` 是一个基于 Spring Boot 的快速开发框架，专为小程序和小型网站设计，提供用户管理、权限控制等基础功能。该框架简化了开发流程，适用于需要快速搭建基础服务的场景。

## 软件架构
- **Spring Boot 2.6.6**：基于 Spring Boot 框架，提供现代化的 Java 开发体验。
- **Apache Shiro**：集成 Shiro，用于安全认证和权限管理。
- **Redis**：用于缓存用户信息和 Token。
- **MyBatis Plus**：数据库访问层使用 MyBatis Plus，简化数据库操作。
- **Swagger2**：提供 API 文档支持，方便接口调试。
- **Kaptcha**：验证码生成工具。
- **JWT**：用于无状态的 Token 认证。

## 功能模块
- **用户管理**：提供用户注册、登录、修改密码、修改头像等功能。
- **权限控制**：基于 Shiro 实现角色和权限管理。
- **Token 认证**：支持 JWT 生成与验证，适用于无状态认证场景。
- **限流控制**：通过 `@RateLimit` 注解实现接口限流，防止接口滥用。
- **通用功能**：包括文件上传、下载、验证码生成等通用功能。
- **异常处理**：统一的异常处理机制，支持多种异常类型的捕获与响应。
- **多环境配置**：支持开发（dev）和生产（prod）环境的配置切换。
- **日志管理**：集成日志记录功能，方便调试与问题追踪。

## 主要技术栈
- **Spring Boot**：快速构建微服务。
- **Spring Security / Shiro**：安全认证与权限控制。
- **JWT**：用于 Token 生成与验证。
- **Redis**：缓存用户信息和 Token。
- **MyBatis Plus**：增强型 ORM 框架，简化数据库操作。
- **Swagger2**：API 接口文档生成。
- **Kaptcha**：验证码生成。
- **Lombok**：简化 Java Bean 编写。
- **Logback**：日志框架。
- **Hutool**：工具类库，简化开发。

## 快速开始

### 环境要求
- JDK 1.8 或更高版本
- Maven 3.x
- Redis
- MySQL（或其他支持的数据库）

### 项目结构
```
magee-boot-simple/
├── magee-admin/               # 核心业务模块
│   └── src/main/java/          # Java 源码
│   └── src/main/resources/     # 配置文件
├── magee-common/              # 通用工具类、配置、异常处理等
│   └── src/main/java/          # 工具类、拦截器、配置类等
├── vue-simple-ai/             # 前端 Vue 项目（可选）
```

### 启动后端
1. 修改数据库配置：
   在 `magee-admin/src/main/resources/application.yml` 中配置数据库连接信息。

2. 启动应用：
   ```bash
   cd magee-admin
   mvn spring-boot:run
   ```

3. 访问接口文档：
   启动后访问 `http://localhost:8080/swagger-ui.html` 查看 API 文档。

### 前端配置（Vue）
1. 安装依赖：
   ```bash
   cd vue-simple-ai
   npm install
   ```

2. 启动开发服务器：
   ```bash
   npm run dev
   ```

3. 访问前端页面：
   打开浏览器访问 `http://localhost:3000`。

## API 示例
### 用户登录
```http
POST /sys/login
Content-Type: application/json

{
  "username": "admin",
  "password": "123456",
  "code": "1234"
}
```

### 获取验证码
```http
GET /sys/getCode
```

### 获取用户信息
```http
GET /sys/getUserInfo
Authorization: Bearer <token>
```

## 限流机制
使用 `@RateLimit(value = 1.0)` 注解对方法进行限流控制，例如每秒最多允许 1 次请求。

## 异常处理
统一返回格式：
```json
{
  "code": 200,
  "message": "操作成功",
  "data": {}
}
```

## 许可证
本项目采用 MIT 许可证。详情请查看仓库中的 `LICENSE` 文件。

## 贡献指南
欢迎贡献代码！请参考以下步骤：
1. Fork 本项目
2. 创建新分支 (`git checkout -b feature/new`)
3. 提交代码 (`git commit -am 'Add new feature'`)
4. 推送分支 (`git push origin feature/new`)
5. 创建 Pull Request

## 联系方式
- 作者：Magee
- 邮箱：magee@example.com
- 项目地址：https://gitee.com/magee-qs/magee-boot-simple

---

本 README 提供了项目的整体介绍、技术栈、快速启动指南以及部分核心功能说明，帮助开发者快速上手并使用该框架。