# springbootx-template

**Repository Path**: wszack/springbootx-template

## Basic Information

- **Project Name**: springbootx-template
- **Description**: springbootx-template
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-17
- **Last Updated**: 2025-04-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

---

<h1 align="center">SpringBootX-Template 🚀</h1>

<p align="center">
  <img src="https://img.shields.io/badge/Spring%20Boot-2.3.12.RELEASE-brightgreen" alt="Spring Boot">
  <img src="https://img.shields.io/badge/Java-8-orange" alt="Java">
  <img src="https://img.shields.io/badge/License-MIT-blue" alt="License">
  <img src="https://img.shields.io/badge/Maven-3.6%2B-yellowgreen" alt="Maven">
</p>

**SpringBootX-Template** 是基于 **Spring Boot 2.3.12.RELEASE** 的企业级开发脚手架，专为 JDK 1.8 环境优化，集成主流中间件与最佳实践，助力快速构建高可维护性应用。

---

## 功能特性 ✨

### 核心功能
• ✅ **统一响应封装**：标准化 `Result<T>` 格式，兼容 Spring Boot 2.3.x 错误处理策略
• ✅ **安全认证**：JWT + Spring Security 5.3，支持 RBAC 权限模型
• ✅ **数据持久化**：MyBatis-Plus 3.4.x + 动态多数据源（MySQL/H2）
• ✅ **缓存与锁**：Redis 6.x 缓存模板 + Redisson 分布式锁
• ✅ **日志管理**：Logback 分级日志，支持 ELK 集成

### 开发提效
• 🛠️ **API 文档**：集成 Swagger2（Springfox 2.9.2），自动生成 RESTful 接口文档
• 🛠️ **多环境配置**：`dev`/`test`/`prod` 环境隔离，支持 `spring.profiles.active` 切换
• 🛠️ **热部署优化**：通过 `spring.devtools.restart.trigger-file` 指定热更新触发文件

---

## 技术栈 🛠️
| **类别**       | **组件**                                                                 |
|----------------|--------------------------------------------------------------------------|
| **核心框架**   | Spring Boot 2.3.12.RELEASE、Spring Framework 5.2.15.RELEASE              |
| **安全框架**   | Spring Security 5.3.x                                                    |
| **持久层**     | MyBatis-Plus 3.4.3.1、Druid 1.1.21（连接池）                             |
| **缓存**       | Redis 6.x、Redisson 3.16.0                                                |
| **工具库**     | Lombok、Hutool、Jackson                                                   |

---

## 环境要求 💻
• **JDK 1.8**（必须，兼容性已验证）
• **MySQL 5.7+** 或 **H2 1.4.200**
• **Redis 6.0+**
• **Maven 3.6+**

---

## 项目结构 📂
```bash
src/
├── main/
│   ├── java/
│   │   └── com/
│   │       └── yourcompany/
│   │           ├── config/        # 配置类（数据源、安全等）
│   │           ├── controller/    # REST API 层
│   │           ├── entity/        # 数据实体
│   │           ├── mapper/        # MyBatis 数据访问层
│   │           └── Application.java # 启动类
│   └── resources/
│       ├── application.yml        # 主配置
│       └── application-dev.yml   # 开发环境配置
└── pom.xml                        # Maven 依赖管理
```

---

## 快速开始 🚴
### 1. 克隆项目
```bash
git clone https://gitee.com/yourname/springbootx-template.git
```

### 2. 配置数据库
```yaml
# application-dev.yml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/yourdb?useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password: yourpassword
```

### 3. 启动应用
```bash
mvn spring-boot:run  # 或直接运行 Application.java
```

---

## 关键配置 🔧
### Redis 连接
```yaml
spring:
  redis:
    host: 127.0.0.1
    port: 6379
    password: yourpassword
```

### Swagger 文档
访问 `http://localhost:8080/swagger-ui.html`（开发环境启用）

---

## 注意事项 ⚠️
1. **JDK 兼容性**  
   项目严格限定 JDK 1.8，升级需修改 `pom.xml` 的 `<java.version>`

2. **错误详情显示**  
   添加以下配置以显示详细错误信息：
   ```yaml
   server:
     error:
       include-message: always
   ```

3. **依赖冲突排查**  
   使用 `mvn dependency:tree` 检查依赖树

---

## 参考文档 📚
• [Spring Boot 2.3 Release Notes](https://spring.io/projects/spring-boot#learn)  
• [MyBatis-Plus 文档](https://baomidou.com/)  

---