# mk-cloud

**Repository Path**: qiseyun/mk-cloud

## Basic Information

- **Project Name**: mk-cloud
- **Description**: 微服务简易骨架; 使用docker容器化部署
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-11-29
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# mk-cloud

(不定期更新)

微服务云平台项目，基于 Spring Cloud Alibaba 构建。

## 技术栈

- **Java 21**
- **Spring Boot 3.5.7**
- **Spring Cloud 2025.0.0**
- **Spring Cloud Alibaba 2025.0.0.0**
- **Nacos** - 服务注册与配置中心
- **RocketMQ** - 消息队列
- **MyBatisPlus 3.5.14** - ORM框架
- **Redisson 3.45.0** - Redis客户端
- **EasyExcel 4.0.3** - Excel处理
- **SpringDoc 2.8.5** - API文档
- **Hutool 5.8.25** - 工具库
- **Fastjson 2.0.52** - JSON处理
- **OkHttp3 4.12.0** - HTTP客户端

## 模块

| 模块              | 说明                                                                   |
|-----------------|----------------------------------------------------------------------|
| gateway-service | 网关服务                                                                 |
| admin-service   | 后台管理服务                                                               |
| client-service  | 客户端服务                                                                |
| auth-service    | 认证服务                                                                 |
| excel-service   | Excel处理服务                                                            |
| message-service | 消息中心服务                                                               |
| springbootadmin | 服务指标监控                                                               |
| common          | 公共模块 (包含common-core, common-redis, common-rocketmq, common-qiniuoss) |

## 快速开始

### 环境要求

- JDK 21+
- Maven 3.8+
- Docker & Docker Compose
- Nacos (用于服务注册与配置中心)

### 编译

```bash
mvn clean install -DskipTests
```

### 环境配置

项目使用 `.env` 文件管理环境变量，默认配置如下：
```
SPRING_PROFILES_ACTIVE=prod
JAVA_OPTS="-Xms128m -Xmx256m -Djava.security.egd=file:/dev/./urandom"
TZ=Asia/Shanghai
```

### Docker容器化部署

使用 Docker Compose 进行一键部署：

#### 启动所有服务

```bash
# 构建镜像并启动服务
docker compose up -d

# 或者分步操作
docker compose build
docker compose up -d
```

#### 停止服务

```bash
docker compose down
```

相关文件:
- [docker-compose.yml](docker-compose.yml)
- [gateway-service/Dockerfile](gateway-service/Dockerfile)
- [auth-service/Dockerfile](auth-service/Dockerfile)
- [admin-service/Dockerfile](admin-service/Dockerfile)
- [client-service/Dockerfile](client-service/Dockerfile)
- [excel-service/Dockerfile](excel-service/Dockerfile)
- [message-service/Dockerfile](message-service/Dockerfile)
- [springbootadmin/Dockerfile](springbootadmin/Dockerfile)

### 自动化部署脚本

项目提供了一键部署脚本 [deploy.sh](deploy.sh)，包含以下功能：
- 拉取最新代码
- Maven 打包（跳过测试）
- 构建 Docker 镜像
- 启动 Docker Compose 服务

使用方法：
```bash
chmod +x deploy.sh
./deploy.sh
```

### 本地开发

1. 启动 Nacos 服务 (建议使用 Docker 方式)
2. 按顺序启动各微服务模块 (推荐使用 IDE 分别启动)
3. 网关服务默认端口为 9080，可通过 http://localhost:9080 访问

### 服务架构

- **网关层**: gateway-service (端口 9080)
- **认证服务**: auth-service
- **管理服务**: admin-service
- **客户端服务**: client-service
- **Excel服务**: excel-service
- **消息服务**: message-service
- **监控服务**: springbootadmin
- **公共组件**: common 模块

### API文档

系统集成 SpringDoc (OpenAPI)，各服务的 API 文档可通过 `/swagger-ui.html` 或 `/v3/api-docs` 访问。

### 服务指标监控
1、线上9086端口需配置白名单访问，限制访问来源