# springboot-study

**Repository Path**: yun_long_wang/springboot-study

## Basic Information

- **Project Name**: springboot-study
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-27
- **Last Updated**: 2025-12-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring Boot 学习项目

这是一个基于 Spring Boot 的学习型项目，旨在展示如何构建模块化的 Spring Boot 应用程序。项目包含了基础模块、插件模块以及通用组件模块，展示了如何使用 MyBatis Plus、Druid、Swagger 等常用框架和工具。

---

## 项目结构

- **common**：通用组件模块，包含公共配置、异常处理、响应封装等通用类。
- **plugin**：插件模块，包含业务功能实现，如用户管理、角色管理、资源管理等。
- **plugin-api**：插件接口模块，定义插件所需的实体类和接口。
- **entry**：主模块，包含 Spring Boot 启动类和配置文件。

---

## 主要功能

- **用户管理**：支持用户的增删改查操作。
- **角色管理**：支持角色的增删改查及权限分配。
- **资源管理**：支持菜单、目录、按钮等资源的管理。
- **全局异常处理**：统一的异常处理机制，返回标准化的错误信息。
- **逻辑删除与物理删除**：支持逻辑删除和物理删除两种方式。
- **分页支持**：所有列表数据支持分页查询。
- **Swagger 文档**：提供 API 文档和在线测试功能。

---

## 技术栈

- Spring Boot
- MyBatis Plus
- Druid 数据库连接池
- Swagger UI
- Lombok
- Spring Validation
- Maven 多模块管理

---

## 快速开始

### 环境要求

- Java 8 或更高版本
- Maven 3.x
- MySQL 5.7 或更高版本

### 构建与运行

1. 克隆项目：

   ```bash
   git clone https://gitee.com/yun_long_wang/springboot-study.git
   ```

2. 修改数据库配置：

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

3. 构建项目：

   ```bash
   cd springboot-study
   mvn clean install
   ```

4. 启动项目：

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

5. 访问 API 文档：

   启动后访问 `http://localhost:8082/doc.html` 查看 API 文档。

---

## 目录说明

- `common/`：通用组件模块，包含公共配置、工具类、异常处理等。
- `plugin/`：插件模块，包含具体的业务逻辑实现。
- `plugin-api/`：插件接口模块，定义实体类和接口。
- `entry/`：主模块，包含启动类和配置文件。

---

## 贡献指南

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

1. Fork 项目。
2. 创建新分支。
3. 提交代码更改。
4. 创建 Pull Request。

---

## 许可证

本项目采用 MIT 许可证。详情请查看 [LICENSE](LICENSE) 文件。