纲要
- 项目业务功能拆解
用户业务:注册、登录、信息查询社交业务:好友关系、群组管理、申请列表聊天业务:私聊/群聊、消息记录、已读未读状态
- 系统架构设计
API 网关:统一入口、反向代理、服务路由BFF 层:业务聚合,减少客户端多服务直接调用微服务层:按领域拆分(用户、IM、社交)消息队列:异步任务处理- 基础组件:
etcd、MongoDB等
- 项目结构概览(树状目录)
- 基础环境准备
- 服务器规划(开发与测试用虚拟机)
- 代码仓库(Git 私有仓库初始化与推送)
- 容器镜像仓库(阿里云容器服务,命名空间与镜像仓库的创建)
- 镜像推送与部署(
docker tag,docker push, 私有镜像在docker-compose中的引用)
项目业务功能
本项目的核心目标是构建一个即时通讯(IM)系统,用户可通过界面登录,并与好友或群组进行实时聊天。围绕这一目标,业务可划分为三大模块:
-
用户模块
提供注册、登录、用户详情查询、用户搜索等功能。用户必须能够发现其他用户,才能建立好友关系或邀请加入群组。 -
社交模块
管理好友关系与群组关系,包括:好友申请、好友列表、群组创建、加入/退出群组、群组申请列表以及群成员列表等。 -
聊天模块
系统的核心功能,涵盖私聊与群聊。进一步拆分为:消息发送、消息接收、聊天记录存储、消息已读/未读状态同步等子功能。
系统架构设计
为支撑上述业务,系统采用基于 Go-Zero@latest 的微服务架构,关键分层如下:
API 网关
网关位于客户端与后端服务之间,承担反向代理与路由职责。所有客户端请求统一发往网关,由网关根据路由规则转发至对应的 BFF 服务。网关同时可集成认证、限流等功能,并屏蔽后端服务的多实例部署细节,使客户端无需关心内部服务地址。
BFF 层(Backend For Frontend)
在微服务体系中,不同客户端(Web、移动端)可能需要聚合多个微服务的数据。BFF 层即为特定前端定制的聚合服务,它将多个微服务的调用组合为一个粗粒度的 API,减少客户端请求次数。例如,“创建群组”操作需要调用社交服务创建群组、调用 IM 服务建立会话、调用用户服务获取成员信息,BFF 可在一个接口中完成这些聚合,避免客户端发起多次请求。
微服务层
按照业务领域垂直拆分:
- 用户服务:处理用户注册、登录、信息管理等。
- IM 服务:负责消息收发、会话管理、聊天记录持久化及已读未读状态。
- 社交服务:管理好友关系、群组生命周期、申请列表等。
服务间通过 RPC 通信,基础组件依赖 etcd 实现服务注册发现,MongoDB 作为部分业务的数据存储。
消息队列
异步任务(如推送通知、离线消息处理)通过消息队列进行解耦,提高系统响应速度与扩展性。
项目结构概览
在 go-zero 项目中,目录结构通常按服务划分,并结合 BFF 层清晰组织:
im-system/
├── gateway/ # API 网关
│ └── etc/
│ └── gateway.yaml # 网关配置
├── bff/ # BFF 聚合层
│ ├── internal/
│ │ ├── handler/
│ │ ├── logic/
│ │ └── svc/
│ └── bff.go
├── services/
│ ├── user/ # 用户微服务
│ │ ├── internal/
│ │ └── user.go
│ ├── im/ # IM 微服务
│ │ ├── internal/
│ │ └── im.go
│ └── social/ # 社交微服务
│ ├── internal/
│ └── social.go
├── common/ # 公共库、中间件等
├── docker-compose.yml
└── go.mod
基础环境构建
服务器环境
开发阶段使用两台虚拟机(通过 VMware 创建):
- 虚拟机 A:用于本地开发测试。
- 虚拟机 B:用于集成后的部署验证与展示。
确保两台机器安装 Docker 及 Docker Compose,便于后续容器化管理。
代码仓库
选用 Git 私有仓库(以 Gitee 为例)管理项目源码。初始化步骤如下:
$ mkdir im-system && cd im-system
$ git init
$ echo "# IM System" >> README.md
$ git add README.md
$ git commit -m "first commit"
$ git remote add origin https://gitee.com/yourname/im-system.git
$ git push -u origin master
后续开发中所有代码改动均通过 commit 与 push 提交至远程私有仓库,确保代码安全与版本控制。
容器镜像仓库
使用阿里云容器镜像服务(ACR)存储自定义 Docker 镜像,便于在测试与生产环境拉取。
操作流程:
- 登录阿里云容器服务控制台,创建命名空间(例如
im-system)。 - 在命名空间下创建两个镜像仓库:
user-rpc与api(或按实际服务命名),仓库类型选择“本地仓库”,以便镜像不公开。 - 配置访问凭证:固定密码设置为环境变量或保存于本地,后续推送/拉取均依赖此凭证。
镜像推送
在开发机上,已有通过 go-zero 构建好的本地镜像,需要打标签并推送至私有仓库。
# 为本地镜像打标签,使其对应仓库地址
$ docker tag local-user-rpc:latest registry.cn-hangzhou.aliyuncs.com/im-system/user-rpc:latest
$ docker tag local-api:latest registry.cn-hangzhou.aliyuncs.com/im-system/api:latest
# 推送到私有仓库
$ docker push registry.cn-hangzhou.aliyuncs.com/im-system/user-rpc:latest
$ docker push registry.cn-hangzhou.aliyuncs.com/im-system/api:latest
推送成功后,可在阿里云控制台对应仓库的“镜像版本”中确认已存在。
使用私有镜像部署
在 docker-compose.yml 中,将镜像地址替换为私有仓库地址。示例片段:
services:
user-rpc:
image: registry.cn-hangzhou.aliyuncs.com/im-system/user-rpc:latest
containers_name: user-rpc
restart: always
environment:
- ETCD_ENDPOINTS=etcd:2379
networks:
- im-net
api:
image: registry.cn-hangzhou.aliyuncs.com/im-system/api:latest
ports:
- "8888:8888"
networks:
- im-net
etcd:
image: quay.io/coreos/etcd:v3.5.4
...
若原有本地已存在旧镜像,可先清理后再启动:
# 删除所有本地镜像(谨慎操作)
$ docker rmi -f $(docker images -q)
# 重新启动服务,将自动拉取私有仓库镜像
$ docker-compose up -d
验证服务是否正常启动:
$ docker-compose ps
$ curl http://localhost:8888/health
至此,项目的基础运行环境搭建完成,后续即可在此基础上进行 go-zero 微服务的迭代开发。
总结
以上即对即时通讯系统业务需求、架构设计以及开发环境准备的完整梳理,为后续章节的功能实现奠定了坚实基础。在实际开发中,还需遵循 go-zero 框架的代码生成规范,确保服务间 RPC 通信的高效与稳定。
1282



被折叠的 条评论
为什么被折叠?



