# start-springboot3

**Repository Path**: hoogodly/start-springboot3

## Basic Information

- **Project Name**: start-springboot3
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-13
- **Last Updated**: 2025-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# StartSpringboot3 项目说明

这是一个基于 Spring Boot 3 的基础项目，适用于快速搭建企业级应用。项目集成了 MyBatis Plus、日志配置、全局异常处理等功能，提供统一的响应格式和工具类，方便开发者快速上手。

## 项目特点

- **Spring Boot 3 支持**：采用最新的 Spring Boot 3 框架，性能更优，支持新特性。
- **统一响应格式**：使用 `BaseResponse` 类封装统一的返回结构，提升前后端交互效率。
- **MyBatis Plus 集成**：通过 `MybatisPlusConfig` 配置 MyBatis Plus，简化数据库操作。
- **全局异常处理**：通过 `GlobalExceptionHandler` 处理所有异常，避免重复的 try-catch 逻辑。
- **分页与排序支持**：`PageRequest` 提供通用的分页与排序参数。
- **删除请求封装**：`DeleteRequest` 提供统一的删除请求参数结构。
- **工具类支持**：包括 `ResultUtils` 用于构建成功或错误响应，`ThrowUtils` 用于简化异常抛出逻辑。
- **跨域配置**：`CorsConfig` 提供跨域请求支持，适用于前后端分离开发。
- **日志配置**：通过 `logback.xml` 配置日志输出格式和路径。

## 目录结构

```
src
├── main
│   ├── java
│   │   └── com
│   │       └── foliage
│   │           └── startspringboot3
│   │               ├── StartSpringboot3Application.java
│   │               ├── common
│   │               │   ├── BaseResponse.java
│   │               │   ├── DeleteRequest.java
│   │               │   ├── PageRequest.java
│   │               │   ├── ResultUtils.java
│   │               │   └── ThrowUtils.java
│   │               ├── config
│   │               │   ├── CorsConfig.java
│   │               │   └── MybatisPlusConfig.java
│   │               ├── controller
│   │               │   └── TestController.java
│   │               ├── exception
│   │               │   ├── BusinessException.java
│   │               │   ├── ErrorCode.java
│   │               │   └── GlobalExceptionHandler.java
│   │               └── mapper
│   │                   └── 
│   └── resources
│       ├── application.yml
│       └── logback.xml
└── test
    └── java
        └── com
            └── foliage
                └── startspringboot3
                    └── StartSpringboot3ApplicationTests.java
```

## 快速开始

### 1. 安装依赖

确保你已安装以下环境：
- Java 17 或更高版本
- Maven
- IDE（如 IntelliJ IDEA 或 Eclipse）

```bash
mvn install
```

### 2. 启动项目

运行主类 `StartSpringboot3Application.java`，项目将会启动在本地 8080 端口。

### 3. 测试接口

访问以下接口进行测试：

- **健康检查**：`GET /health`

## 使用说明

### 统一响应格式

所有接口返回值均使用 `BaseResponse` 类，格式如下：

```json
{
  "code": 200,
  "data": "返回的数据",
  "message": "请求成功"
}
```

### 异常处理

- 使用 `BusinessException` 抛出业务异常。
- 使用 `ErrorCode` 枚举定义通用错误码。
- 使用 `ThrowUtils` 快速判断并抛出异常。

### 分页请求

使用 `PageRequest` 传递分页参数，支持当前页、页大小、排序字段和排序方式。

### 删除请求

使用 `DeleteRequest` 传递删除请求参数，支持按 ID 删除。

## 开发建议

- 所有新增的控制器应继承统一的响应结构。
- 业务异常应使用 `ThrowUtils` 抛出，避免手动 `new` 异常。
- 所有接口默认使用 `@Hidden` 注解隐藏 Swagger 文档，如需展示请移除该注解。

## 许可证

本项目遵循 MIT 许可证，请在使用时确保遵守相关协议。