【限时免费】 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  # 启动开发服务器

2.2 后端启动

需按顺序启动以下微服务模块：

服务模块	启动类	默认端口
注册中心/配置中心	SnowyNacosApp	8848
监控服务	SnowyActuatorApp	9001
限流服务	SnowySentinelApp	9002
API网关	SnowyGatewayApp	9003
分布式任务调度	SnowyXxlJobApp	9004
主应用模块	SnowyWebApp	9101
业务模块	SnowyBizApp	9102

3. API使用文档

3.1 接口规范

• 采用RESTful风格设计
• 请求头需携带Authorization: Bearer [token]
• 响应格式统一为JSON

3.2 国密算法接口示例

// SM2加密示例
@PostMapping("/encrypt")
public Result encrypt(@RequestBody String plainText) {
    String cipherText = Sm2Util.encrypt(plainText);
    return Result.success(cipherText);
}

3.3 核心API模块

模块	功能说明
系统管理	用户/角色/菜单管理
权限管理	接口权限/数据权限控制
日志管理	操作日志/登录日志记录
代码生成	可视化代码生成工具

4. 项目安装方式

4.1 开发环境部署

1. 导入项目到IDE（推荐IntelliJ IDEA）
2. 配置Maven并下载依赖
3. 创建MySQL数据库并执行初始化脚本
4. 修改各模块配置文件中的数据库连接信息
5. 按顺序启动微服务模块

4.2 生产环境部署

推荐使用Docker Compose部署：

version: '3'
services:
  snowy-mysql:
    image: mysql:8.0
    environment:
      MYSQL_ROOT_PASSWORD: 123456
  snowy-redis:
    image: redis:latest
  snowy-nacos:
    image: nacos/nacos-server
    ports:
      - "8848:8848"

4.3 国产化适配

支持以下国产化环境：

• 操作系统：麒麟OS、统信UOS
• 数据库：达梦DM8、人大金仓
• 中间件：东方通TongWeb

5. 架构说明

采用分层架构设计：

表示层（Ant Design Vue）
  ↓
API网关（Spring Cloud Gateway）
  ↓
业务服务层（Spring Boot）
  ↓
数据访问层（MyBatis-Plus）
  ↓
国产化数据库

6. 注意事项

1. 首次启动需先运行Nacos服务
2. 生产环境务必修改默认密码和密钥
3. 国密算法相关配置需符合等保要求
4. 微服务间调用需通过FeignClient实现