添加中文README和简化构建配置

- 新增中文README.md,包含完整的构建和运行说明
- 移除不必要的Lombok注解处理器显式配置
- 简化Maven配置,依赖自动注解处理
- 验证所有模块使用Java 11成功编译

技术改进:
- Java 11环境下Lombok自动处理,无需额外插件配置
- 保持项目配置简洁和标准化
- 提供详细的开发环境设置指南
This commit is contained in:
irving
2025-08-28 22:40:32 -04:00
parent 1ad0da2b36
commit 33d4df8e52

89
README.md Normal file
View File

@@ -0,0 +1,89 @@
# PeiPei 后端项目
基于 Spring Boot 的多模块项目,为 PeiPei 应用提供后端服务。
## 项目结构
- **play-admin**: 主要的 Spring Boot 应用模块
- **play-common**: 公共工具类和共享代码
- **play-generator**: 代码生成工具
## 构建要求
- **Java 11** (必须)
- **Maven 3.6+**
## 快速开始
### 1. 安装 Java 11
在 macOS 上使用 Homebrew:
```bash
brew install --cask zulu@11
```
为当前会话设置 JAVA_HOME:
```bash
export JAVA_HOME=$(/usr/libexec/java_home -v 11)
```
### 2. 构建项目
```bash
# 清理并构建所有模块
mvn clean install
# 或者仅编译
mvn clean compile
```
### 3. 运行应用
```bash
# 运行主应用
java -jar play-admin/target/play-admin-1.0.jar
# 或使用 Maven
cd play-admin
mvn spring-boot:run
```
## 配置说明
项目在所有模块中统一使用 Java 11:
- 所有模块都配置为 Java 11 源码和目标版本
- Lombok 注解自动处理
- 无需显式配置注解处理器
## 开发说明
- 项目已更新为所有模块统一使用 Java 11
- Lombok 依赖使用 `scope=provided` 启用自动注解处理
- Maven 编译插件继承 Spring Boot 父 POM 配置
## 模块介绍
### play-admin
主要的 Spring Boot 应用,包含:
- REST API 接口
- 安全配置
- 数据库集成
- 微信集成
### play-common
共享工具库,包含:
- 公共域对象
- 工具类
- Redis 配置
- 安全工具
### play-generator
代码生成工具,包含:
- MyBatis Plus 代码生成
- 基于模板的代码生成
## 构建状态
✅ 所有模块使用 Java 11 编译成功
✅ Lombok 注解自动处理
✅ 模块间配置一致