Snowy-Cloud微服务快速开发平台技术文档
1. 安装指南
1.1 环境要求
前端支撑
| 组件 | 版本要求 | 说明 |
|---|---|---|
| Node.js | ≥18 | JavaScript运行环境 |
后端支撑
| 组件 | 版本要求 | 说明 |
|---|---|---|
| JDK | 17 | Java运行环境 |
| Maven | 最新稳定版 | 项目构建工具 |
| Redis | 最新稳定版 | 缓存数据库 |
| MySQL | 8.0 或 5.7 | 主数据库 |
| Lombok | IDE插件 | 代码简化工具 |
1.2 源码获取
通过以下地址克隆项目:
git clone https://gitee.com/xiaonuobase/snowy-cloud.git
2. 项目使用说明
2.1 前端启动
cd snowy-admin-web
npm install # 安装依赖
npm run dev # 启动开发服务器
访问地址:http://localhost:3000
2.2 后端启动
- 导入项目至IDEA
- 按顺序启动以下服务:
| 服务模块 | 启动类 | 默认端口 |
|---|---|---|
| 注册中心 | SnowyNacosApp | 8848 |
| 监控中心 | SnowyActuatorApp | 9001 |
| 流量控制 | SnowySentinelApp | 9002 |
| API网关 | SnowyGatewayApp | 9003 |
| 任务调度 | SnowyXxlJobApp | 9004 |
| 主业务模块 | SnowyWebApp | 9101 |
| 扩展业务模块 | SnowyBizApp | 9102 |
3. API使用文档
3.1 接口规范
- 采用RESTful风格设计
- 请求头需携带
Authorization: Bearer {token} - 响应格式:
{
"code": 200,
"msg": "success",
"data": {}
}
3.2 国密API示例
用户登录(SM2加密)
// 前端加密示例
import { sm2Encrypt } from '@/utils/smCrypto';
const encrypted = sm2Encrypt(JSON.stringify({
account: 'admin',
password: '123456'
}));
数据脱敏(SM4)
// 后端解密示例
@DecryptField(algorithm = AlgorithmType.SM4)
private String mobile;
4. 项目安装方式
4.1 开发环境部署
- 初始化数据库:
- 执行
snowy-cloud/sql目录下的SQL脚本
- 执行
- 修改配置:
application-dev.yml中配置数据库连接bootstrap.yml中配置Nacos地址
4.2 生产环境部署
Docker-Compose方案
version: '3'
services:
snowy-mysql:
image: mysql:8.0
environment:
MYSQL_ROOT_PASSWORD: snowy@123
snowy-redis:
image: redis:latest
snowy-nacos:
image: nacos/nacos-server
ports:
- "8848:8848"
注意事项
- 默认账号:admin/123456
- 首次启动需初始化国密密钥对
- 生产环境务必修改默认证书文件
本平台已通过等保三级安全要求,建议部署时保持默认安全配置
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



