# spring-cloud

**Repository Path**: zhangyu0914/spring-cloud

## Basic Information

- **Project Name**: spring-cloud
- **Description**: 个人开源项目     
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 0
- **Created**: 2021-08-12
- **Last Updated**: 2025-11-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 小优（Xiaoyeoo）项目

## 🌟 项目简介

**晓夜（Xiaoyeoo）** 是一个基于 **Spring Boot 3.x** 和 **Spring Cloud Alibaba** 构建的现代化微服务项目。它旨在提供一个稳定、高效、易于扩展的分布式系统解决方案。

本项目采用模块化设计，清晰地分离了业务逻辑和接口定义，便于团队协作和独立部署。

| 特性 | 描述 |
| :--- | :--- |
| **核心技术栈** | Java 17, Spring Boot 3.3.2, Maven |
| **微服务架构** | Spring Cloud, Spring Cloud Alibaba 2023.0.1.2 |
| **模块划分** | `xiaoyeoo-service` (服务实现), `xiaoyeoo-api` (接口定义) |
| **部署方式** | Docker 容器化部署 |
| **配置中心** | Nacos (通过环境变量配置用户名和密码) |
| **项目版本** | 2.0.0-SNAPSHOT |

## 🛠️ 技术栈概览

本项目主要使用了以下核心技术：

*   **后端框架**: **Spring Boot 3.x** - 简化 Spring 应用的创建和部署。
*   **微服务治理**: **Spring Cloud Alibaba** - 提供服务发现、配置管理、流量控制等微服务全家桶能力。
*   **构建工具**: **Maven** - 依赖管理和项目构建。
*   **编程语言**: **Java 17** - 长期支持版本，提供性能优化和新特性。
*   **容器化**: **Docker** - 实现应用环境的快速、一致性部署。

## 📦 模块结构

项目分为两个主要模块：

| 模块名称 | 描述 |
| :--- | :--- |
| `xiaoyeoo-service` | **核心业务逻辑实现模块**。包含具体的服务实现、数据访问层（DAO）和业务流程处理。 |
| `xiaoyeoo-api` | **服务接口定义模块**。包含所有对外暴露的接口定义、数据传输对象（DTO）和枚举等公共契约。 |

## 🚀 快速开始

### 1. 环境准备

确保您的开发环境已安装以下软件：

*   **JDK 17** 或更高版本
*   **Maven 3.6+**
*   **Docker** (用于容器化部署)

### 2. 项目构建

进入项目根目录，使用 Maven 进行编译和打包：

```bash
# 清理并打包项目，跳过测试
mvn clean package -DskipTests
```

成功后，您将在 `xiaoyeoo-service/target/` 目录下找到生成的 JAR 包。

### 3. 运行项目 (本地)

您可以通过以下命令直接运行服务模块：

```bash
# 假设您已配置好 Nacos 等依赖服务
java -jar xiaoyeoo-service/target/xiaoyeoo-service-2.0.0-SNAPSHOT.jar
```

### 4. 容器化部署 (推荐)

本项目提供了 `Dockerfile`，推荐使用 Docker 进行部署。

1.  **构建 Docker 镜像**：

    ```bash
    # 在项目根目录执行
    docker build -t taisau/xiaoyeoo:2.0.0-SNAPSHOT .
    ```

2.  **运行 Docker 容器**：

    在运行容器时，您需要通过环境变量传入 Nacos 的认证信息，以确保服务能够正确注册和获取配置。

    ```bash
    docker run -d \
      --name xiaoyeoo \
      -p 8080:8080 \
      -e NACOS_USERNAME=your_nacos_username \
      -e NACOS_PASSWORD=your_nacos_password \
      taisau/xiaoyeoo:2.0.0-SNAPSHOT
    ```

    *   请将 `your_nacos_username` 和 `your_nacos_password` 替换为您的 Nacos 实际用户名和密码。
    *   `-p 8080:8080` 示例端口，请根据实际服务配置进行调整。

## ⚙️ 配置说明

项目配置主要依赖于 **Spring Cloud Alibaba Nacos**。

### Nacos 配置

服务启动时，会从 Nacos 获取配置。您需要在运行环境中设置以下环境变量：

| 环境变量 | 描述 | 示例值 |
| :--- | :--- | :--- |
| `NACOS_USERNAME` | Nacos 配置中心的用户名 | `nacos` |
| `NACOS_PASSWORD` | Nacos 配置中心的密码 | `nacos` |

**注意**: 在生产环境中，请务必使用强密码并妥善保管配置中心认证信息。

## 🤝 贡献

欢迎所有形式的贡献，包括但不限于：

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

## 📄 许可证

本项目暂未发现明确的许可证文件。默认情况下，所有权利保留。请联系项目所有者 (`com.taisau.xiaoyeoo`) 以获取正式的许可证信息。

---

**© 2025 taisau.com** (基于 Group ID 推测)