# springboot-starter

**Repository Path**: hw_love_666/springboot-starter

## Basic Information

- **Project Name**: springboot-starter
- **Description**: springboot 集成开发模板框架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-11
- **Last Updated**: 2026-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: template, backend

## README



# Spring Boot Starter

一个基于 Spring Boot 的快速开发模板项目，集成了 MyBatis-Plus、JWT 认证、统一响应处理等常用组件，帮助开发者快速搭建企业级应用。

## ✨ 项目特性

- **统一响应格式**：规范的 BaseResponse 响应结构，统一成功与错误响应
- **异常处理**：全局异常处理器，配合自定义业务异常，实现优雅的错误处理
- **分页支持**：通用的分页请求封装，简化列表查询逻辑
- **JWT 认证**：完整的 JWT 认证流程，包含 Token 生成、解析与拦截
- **代码生成器**：MyBatis-Plus 代码生成器，快速生成实体、Mapper、Service、Controller
- **安全配置**：Spring Security 集成，支持 JWT 认证过滤
- **跨域支持**：灵活的配置，支持前后端分离开发

## 🛠 技术栈

| 技术 | 用途 |
|------|------|
| Spring Boot | 应用框架 |
| MyBatis-Plus | ORM 框架 |
| JWT | 认证授权 |
| Spring Security | 安全框架 |
| Lombok | 简化代码 |

## 📁 项目结构

```
src/main/java/com/ithw/springbootstarter/
├── common/                 # 公共组件
│   ├── BaseResponse.java   # 统一响应封装
│   ├── DeleteRequest.java  # 删除请求封装
│   ├── PageRequest.java    # 分页请求封装
│   ├── ResultUtils.java    # 响应构建工具
│   └── GlobalExceptionHandler.java  # 全局异常处理
├── config/                 # 配置类
│   ├── CorsConfig.java     # 跨域配置
│   └── SecurityConfig.java # 安全配置
├── controller/             # 控制器
│   └── HealthController.java  # 健康检查接口
├── exception/              # 异常处理
│   ├── BusinessException.java  # 业务异常
│   ├── ErrorCode.java      # 错误码枚举
│   └── ThrowUtils.java     # 异常抛出工具
├── generator/              # 代码生成器
│   └── MyBatisCodeGenerator.java
├── inteceptor/             # 拦截器
│   └── JwtAuthenticationFilter.java  # JWT认证过滤器
├── mapper/                 # MyBatis Mapper接口
├── service/                # 服务层
├── utils/                  # 工具类
│   └── JwtUtil.java        # JWT工具类
└── SpringbootStarterApplication.java  # 启动类
```

## 🚀 快速开始

### 环境要求

- JDK 1.8+
- Maven 3.6+
- MySQL 5.7+

### 构建运行

```bash
# 克隆项目
git clone https://gitee.com/hw_love_666/spring-boot-starter.git

# 进入项目目录
cd spring-boot-starter

# 构建项目
./mvnw clean package -DskipTests

# 运行项目
java -jar target/spring-boot-starter.jar
```

## 📖 使用指南

### 统一响应格式

所有接口返回统一的 `BaseResponse` 结构：

```json
{
  "code": 0,
  "data": {},
  "message": "success"
}
```

**成功响应**：
```java
// 方式一：使用 ResultUtils
return ResultUtils.success(data);

// 方式二：直接构造
return new BaseResponse<>(0, data, "success");
```

**错误响应**：
```java
// 使用错误码枚举
return ResultUtils.error(ErrorCode.NOT_FOUND);

// 自定义错误信息
return ResultUtils.error(404, "资源不存在");
```

### 业务异常处理

抛出业务异常时使用 `ThrowUtils` 工具类：

```java
// 方式一：条件满足时抛出异常
ThrowUtils.throwIf(condition, ErrorCode.NOT_FOUND);

// 方式二：带自定义消息
ThrowUtils.throwIf(condition, ErrorCode.PARAMS_ERROR, "参数验证失败");
```

### 分页查询

使用 `PageRequest` 封装分页参数：

```java
public BaseResponse<PageInfo<User>> list(PageRequest request) {
    // 业务逻辑
}
```

### JWT 认证

**生成 Token**：
```java
@Autowired
private JwtUtil jwtUtil;

public String login(String userName, String nickName) {
    return jwtUtil.generateToken(userName, nickName);
}
```

**验证 Token**：
```java
public Claims parseToken(String token) {
    return jwtUtil.parseToken(token);
}
```

## ⚙️ 配置说明

在 `src/main/resources/application.yml` 中配置：

```yaml
server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database
    username: your_username
    password: your_password
  
mybatis-plus:
  mapper-locations: classpath*:/mapper/**/*.xml
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
```

## 📡 API 接口

### 健康检查

- **接口**：`GET /health/check`
- **描述**：检查服务是否正常运行
- **响应**：
```json
{
  "code": 0,
  "data": "ok",
  "message": "success"
}
```

## 🤝 贡献指南

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

## 📄 许可证

本项目基于 MIT License 开源。

## 📞 联系方式

- 项目地址：https://gitee.com/hw_love_666/spring-boot-starter
- 作者：hw_love_666