# ghostmice-demo

**Repository Path**: ghostmice/ghostmice-demo

## Basic Information

- **Project Name**: ghostmice-demo
- **Description**: 启动工程
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-09
- **Last Updated**: 2025-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GhostMice Demo 项目说明文档

## 项目简介
这是一个基于 Spring Boot 3 的后端服务项目，集成了 MyBatis-Plus、SaToken、Knife4j 等常用开发组件，提供了用户管理相关的基础功能，包括登录、权限控制、数据持久化等。

## 主要功能
- **用户管理**：支持用户创建、更新、删除、查询（包括单个查询、列表查询、分页查询）。
- **登录认证**：使用 SaToken 实现登录认证与会话管理。
- **权限控制**：集成 SaToken 实现权限与角色控制。
- **接口文档**：通过 Knife4j 提供可视化的 API 文档。
- **统一返回格式**：使用 `Result<T>` 对象封装统一的返回结果。
- **全局异常处理**：捕获并处理运行时异常、权限异常、资源未找到异常等。

## 技术栈
- **Spring Boot 3**：提供快速开发框架。
- **MyBatis-Plus**：简化数据库操作。
- **SaToken**：轻量级 Java 权限认证框架。
- **Knife4j**：API 文档生成与管理。
- **Redis**：集成 Redis 缓存支持。
- **Lombok**：简化 Java Bean 开发。

## 项目结构
- **`com.ghostmice.controller`**：API 控制器，处理 HTTP 请求。
- **`com.ghostmice.service`**：业务逻辑接口及实现。
- **`com.ghostmice.mapper`**：数据库操作接口。
- **`com.ghostmice.entity`**：数据库实体类。
- **`com.ghostmice.dto`**：数据传输对象。
- **`com.ghostmice.vo`**：视图输出对象。
- **`com.ghostmice.config`**：配置类，包括 SaToken、MyBatis-Plus、Redis 等配置。
- **`com.ghostmice.exception`**：全局异常处理器。
- **`com.ghostmice.common`**：通用工具类或返回结构。

## 快速启动
1. 确保已安装 JDK 17 或更高版本。
2. 安装并启动 Redis。
3. 导入 `db.sql` 到数据库。
4. 修改 `application.yml` 中的数据库和 Redis 配置。
5. 执行 `Boot3SpringbootApplication.java` 启动项目。

## 接口文档
访问 `/doc.html` 查看 API 接口文档，支持在线测试。

## 使用说明
- 用户登录：`POST /api/user/login`
- 用户登出：`POST /api/user/logout`
- 创建用户：`POST /api/user`
- 更新用户：`PUT /api/user`
- 删除用户：`DELETE /api/user/{id}`
- 查询用户：`GET /api/user/{id}`
- 用户列表：`GET /api/user/list`
- 分页查询：`GET /api/user/page`
- 当前用户信息：`GET /api/user/info`

## 异常处理
统一返回格式为：
```json
{
  "code": 200,
  "message": "success",
  "data": {}
}
```

常见错误码：
- 500：系统异常
- 401：未登录
- 403：权限不足
- 404：资源未找到

## 扩展建议
- 可以扩展其他模块（如角色管理、菜单管理）。
- 可以集成更多中间件（如 RabbitMQ、Elasticsearch）。
- 可以对接前端项目进行完整系统开发。

## 开源协议
本项目采用 MIT 协议，请遵循相关开源协议进行使用和修改。