跳到主要内容

井云服务中心快速开始指南

🚀 欢迎使用井云服务中心​

本指南将帮助您快速了解井云服务中心的架构、功能和使用方法。项目基于 Go 1.25.4 和 Kratos v2 框架构建，采用微服务架构设计。

📋 系统概览​

井云服务中心是一个基于微服务架构的综合性服务平台，提供用户管理、认证授权、支付结算、点数管理、分销系统、智能体管理等核心功能。

核心服务​

  • Gateway服务: 统一网关入口 (HTTP 8000, gRPC 9000)
  • Auth服务: 认证授权服务 (gRPC 9001) - 登录、Token、微信登录
  • User服务: 用户管理服务 (gRPC 9002) - 用户、分销、点数、素材
  • Tenant服务: 租户管理服务 (gRPC 9003) - 租户、版本、菜单、权限
  • Agent服务: 智能体管理服务 (gRPC 9004) - AI智能体、分类、平台集成
  • Payment服务: 支付结算服务 (gRPC 9006) - 订单、微信支付
  • Integration服务: 第三方集成服务 (gRPC 9007) - OSS、短信
  • Cron服务: 定时任务服务 (gRPC 9008) - 点数过期、分销检查

技术栈​

  • 语言: Go 1.25.4
  • 框架: Kratos v2 (微服务框架)
  • ORM: Ent v0.14.5 (类型安全的ORM)
  • 数据库: PostgreSQL 17.5
  • 缓存: Redis
  • 消息队列: RabbitMQ 3.0
  • 服务发现: Consul
  • 依赖注入: Wire v0.7.0

🔧 环境准备​

基础要求​

  • Go 1.25.4 或更高版本
  • Docker 和 Docker Compose
  • PostgreSQL 数据库
  • Redis 缓存
  • RabbitMQ 消息队列
  • Consul 服务注册中心

开发工具​

  • IDE: VS Code / GoLand
  • API测试: Postman / Insomnia
  • 数据库管理: pgAdmin / DBeaver

📦 快速部署​

1. 克隆项目​

git clone git@git.jingyun.design:jingyun/backend.git
cd backend

2. 启动依赖服务​

# 启动本地开发环境
docker-compose -f deployments/docker-compose.local.yml up -d

# 查看服务状态
docker-compose -f deployments/docker-compose.local.yml ps

3. 初始化项目​

# 安装依赖
go mod tidy

# 生成代码
make all

# 构建服务
make build

4. 启动服务​

# 启动所有服务
./scripts/start-all.sh

# 或单独启动服务
cd services/gateway && make run
cd services/auth && make run
cd services/user && make run
# ... 其他服务

🔧 开发配置​

配置中心​

系统使用Consul作为配置中心，配置文件路径：

  • Gateway: kratos/gateway.yaml
  • Auth: kratos/auth.yaml
  • User: kratos/user.yaml
  • Payment: kratos/payment.yaml
  • Point: kratos/point.yaml

数据库初始化​

# 创建数据库
createdb jingyun_center

# 运行迁移
make migrate

# 初始化数据
make seed

📚 API文档​

访问方式​

主要接口​

认证接口​

# 用户登录
curl -X POST http://localhost:8000/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username":"admin","password":"password"}'

# 发送短信验证码
curl -X POST http://localhost:8000/auth/sms/send \
  -H "Content-Type: application/json" \
  -d '{"phone":"13800138000"}'

用户接口​

# 获取用户信息
curl -X GET http://localhost:8000/user/profile \
  -H "Authorization: Bearer <token>"

# 更新用户信息
curl -X PUT http://localhost:8000/user/profile \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"nickname":"新昵称"}'

支付接口​

# 创建支付订单
curl -X POST http://localhost:8000/payment/create \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"amount":100,"subject":"测试订单"}'

🎯 核心功能使用​

用户认证​

  1. 注册用户: 支持手机号、邮箱注册
  2. 登录认证: 支持密码、短信、微信登录
  3. 权限管理: 基于JWT的访问控制
  4. 会话管理: 安全的用户会话管理

算力点系统​

  1. 点数发放: 购买、赠送、活动等方式
  2. 点数消费: FIFO智能消费策略
  3. 过期处理: 自动过期和清理
  4. 交易记录: 完整的消费审计

分销系统​

  1. 等级管理: 多级分销等级设置
  2. 佣金计算: 自动佣金分配
  3. 提现管理: 用户提现申请和审核
  4. 数据统计: 分销业绩分析

支付系统​

  1. 多渠道支付: 微信、支付宝等
  2. 订单管理: 订单状态跟踪
  3. 回调处理: 支付结果同步
  4. 退款处理: 订单退款流程

🐛 常见问题​

Q: 服务启动失败​

A: 检查以下项目：

  • 端口是否被占用
  • 数据库连接是否正常
  • 配置文件是否正确
  • 依赖服务是否启动

Q: 数据库连接失败​

A: 确认以下配置：

  • 数据库地址和端口
  • 用户名和密码
  • 数据库名称
  • 网络连通性

Q: API调用失败​

A: 检查以下内容：

  • Token是否有效
  • 请求格式是否正确
  • 权限是否足够
  • 服务是否正常运行

📖 学习路径​

初学者​

  1. 阅读系统架构
  2. 查看API 文档
  3. 学习开发规范
  4. 尝试测试规范

进阶开发​

  1. 深入系统架构
  2. 学习开发规范
  3. 掌握测试规范
  4. 了解开发指南

运维人员​

  1. 学习开发指南
  2. 掌握团队协作
  3. 配置Caddy SSL 集成
  4. 了解贡献指南

🔗 相关资源​

文档中心​

外部资源​

社区支持​

  • 技术交流群：[联系管理员获取]
  • 问题反馈：[GitHub Issues]
  • 邮件支持：support@jingyun.team

🤝 贡献指南​

欢迎为项目做出贡献！请阅读贡献指南了解详细信息。

贡献方式​

  • 提交代码改进
  • 完善文档内容
  • 报告问题和建议
  • 分享使用经验

祝您使用愉快！如有问题，请随时联系我们。