# 云图库

**Repository Path**: qianlonghai/cloud-library

## Basic Information

- **Project Name**: 云图库
- **Description**: 云图库项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-24
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java

## README

根据提供的代码结构和文件信息，以下是一个适用于该项目的 README.md 文件内容：

---

# YuPictureBackend

一个基于 Spring Boot 的后端服务项目，提供用户管理、权限控制、健康检查等功能，适用于图片管理类应用的后端支持。

## 项目简介

YuPictureBackend 是一个 Java 后端项目，使用 Spring Boot 框架构建，集成了 MyBatis Plus、Swagger、JWT 等技术栈，实现了用户注册、登录、权限控制、用户信息管理等核心功能。项目结构清晰，适合用于学习或作为企业级应用的后端模板。

### 主要功能

- 用户注册与登录
- 用户权限管理（管理员与普通用户）
- 用户信息的增删改查
- 健康检查接口
- 全局异常处理
- 分页查询支持

### 技术栈

- Java 17
- Spring Boot
- MyBatis Plus
- Swagger UI
- JWT（用于权限控制）
- Redis（可选，用于缓存）
- MySQL

## 项目结构

```
src/
├── main/
│   ├── java/
│   │   └── com.yupi.yupicturebackend/
│   │       ├── annotation/        # 自定义注解
│   │       ├── aop/               # 权限拦截器
│   │       ├── common/            # 通用类（如响应封装、工具类）
│   │       ├── config/            # 配置类（如跨域、MyBatis 配置）
│   │       ├── controller/        # 控制器类（REST API）
│   │       ├── exception/         # 异常处理类
│   │       ├── mapper/            # 数据库操作接口
│   │       ├── model/             # 数据模型、DTO、VO
│   │       ├── service/           # 业务逻辑接口及实现
│   │       └── YuPictureBackendApplication.java # 启动类
│   ├── resources/
│   │   ├── application.yml        # 配置文件
│   │   ├── generator/             # MyBatis 生成器配置
│   │   └── static/                # 静态资源文件
├── test/
│   └── java/                      # 单元测试
```

## 快速开始

### 环境准备

- JDK 17
- Maven 3.8+
- MySQL 8.0+
- Redis（可选）

### 安装步骤

1. 克隆项目：

   ```bash
   git clone https://gitee.com/qianlonghai/cloud-library.git
   cd cloud-library
   ```

2. 创建数据库并导入 SQL 文件：

   ```bash
   mysql -u root -p < sql/create_table.sql
   ```

3. 修改配置文件：

   修改 `src/main/resources/application.yml` 中的数据库连接信息。

4. 启动项目：

   ```bash
   mvn spring-boot:run
   ```

5. 访问接口文档：

   启动后访问：`http://localhost:8080/swagger-ui.html`

## 使用说明

### 用户注册

```http
POST /user/register
{
  "userAccount": "testuser",
  "userPassword": "123456",
  "checkPassword": "123456"
}
```

### 用户登录

```http
POST /user/login
{
  "userAccount": "testuser",
  "userPassword": "123456"
}
```

### 获取当前登录用户信息

```http
GET /user/get/login
```

### 管理员获取用户信息

```http
GET /user/get?id=1
```

### 用户登出

```http
POST /user/logout
```

### 删除用户（管理员权限）

```http
POST /user/delete
{
  "id": 1
}
```

## 接口文档

项目集成了 Swagger，访问 `http://localhost:8080/swagger-ui.html` 查看完整的 API 文档。

## 异常处理

项目使用 `@RestControllerAdvice` 统一处理异常，返回统一格式的错误信息，如：

```json
{
  "code": 4001,
  "message": "用户未登录",
  "data": null
}
```

## 贡献指南

欢迎贡献代码！请遵循以下步骤：

1. Fork 项目
2. 创建新分支 (`git checkout -b feature/new-feature`)
3. 提交更改 (`git commit -am 'Add some feature'`)
4. 推送分支 (`git push origin feature/new-feature`)
5. 创建 Pull Request

## 许可证

本项目采用 MIT 许可证。详见 [LICENSE](LICENSE) 文件。

--- 

如需进一步帮助，请查看项目中的 `Tips` 目录或参考代码注释。