# backend

**Repository Path**: caacop/backend

## Basic Information

- **Project Name**: backend
- **Description**: 领航后端API服务
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-09
- **Last Updated**: 2025-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 领航API服务

## 项目介绍
领航API服务是一个基于Spring Boot的后端服务项目，提供RESTful API接口支持。该项目使用Java 17开发，采用了现代化的Spring技术栈和微服务架构思想，支持容器化部署。

## 技术栈
- **核心框架**：Spring Boot 3.5.3
- **数据持久层**：Spring Data JPA
- **数据库**：MySQL
- **缓存**：Redis
- **API文档**：SpringDoc OpenAPI (Swagger)
- **构建工具**：Maven
- **部署方式**：Docker容器化

## 项目结构
```
src/main/java/com/linghang/back/
├── config/         # 配置类
├── controller/     # 控制器层，处理HTTP请求
├── service/        # 业务逻辑层
├── repository/     # 数据访问层
├── entity/         # 实体类，映射数据库表
├── dto/            # 数据传输对象
├── util/           # 工具类
└── BackendApplication.java  # 应用程序入口类
```

## 环境要求
- JDK 17+
- Maven 3.6+
- MySQL 8.0+
- Redis 6.0+
- Docker & Docker Compose (用于容器化部署)

## 开发环境设置
1. 克隆项目到本地
   ```bash
   git clone <项目仓库URL>
   cd backend
   ```

2. 配置数据库和Redis连接
   修改 `src/main/resources/application.properties` 或 `application.yml` 文件中的数据库和Redis配置

3. 编译项目
   ```bash
   mvn clean package -DskipTests
   ```

4. 本地运行
   ```bash
   java -jar target/backend-0.0.1-SNAPSHOT.jar
   ```
   或使用提供的脚本：
   ```bash
   ./build-local.sh
   ```

## 部署指南

### Docker部署
1. 构建Docker镜像
   ```bash
   docker build -t linghang/backend:latest .
   ```
   或使用提供的脚本：
   ```bash
   ./build-and-push.sh
   ```

2. 使用Docker Compose启动服务
   ```bash
   docker-compose up -d
   ```

### 部署文档
更详细的部署指南请参考：
- [Docker Hub部署指南](docker-hub-guide.md)
- [服务器部署指南](deploy-guide.md)

## API文档
项目集成了Swagger UI，启动服务后可通过以下地址访问API文档：
```
http://localhost:8080/swagger-ui/index.html
```

## 定时任务
本项目支持定时任务，使用Spring的@Scheduled注解实现。

## 贡献指南
1. Fork本仓库
2. 创建您的特性分支 (`git checkout -b feature/amazing-feature`)
3. 提交您的更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 创建一个Pull Request

## 开发团队
- 领航开发团队

## 许可证
[待添加许可证信息]