GoWind IM 产品介绍

层次	技术	说明
后端	Go 1.18+、Kratos 框架、gRPC	高性能、低延迟的实时通讯
前端	Vue3、TypeScript、WebSocket、WebRTC	现代化 Web 和移动客户端
消息队列	Redis / Kafka	消息存储和分发
数据库	MySQL / PostgreSQL	用户、消息等数据存储
缓存	Redis	在线状态、会话缓存
媒体服务	SFU / MCU	音视频 P2P 或中继

系统架构

四、核心功能模块

1. 用户管理

账号注册和登录
多设备支持
在线状态管理
用户资料编辑

2. 联系人管理

添加、删除、封禁联系人
联系人分组
联系人昵称和备注
黑名单管理

3. 消息功能

消息类型：文本、图片、视频、文件、语音
消息状态：发送中、已发送、已送达、已读
消息操作：编辑、撤回、删除、引用、转发
消息搜索和存档

4. 群组管理

创建和解散群组
成员邀请和移除
群组权限管理
群公告和群描述

5. 文件管理

文件上传和下载
文件分享和权限
文件预览
存储空间管理

五、快速开始

1. 在线演示

敬请期待...

2. 环境准备

Go 1.18+
Node.js 16+
MySQL 8.0+ 或 PostgreSQL 12+
Redis 6.0+

3. 快速启动

git clone https://github.com/tx7do/go-wind-im.git
cd go-wind-im

# 后端启动
cd backend
make init
gow run im

# 前端启动
cd ../frontend
pnpm install
pnpm dev

4. 访问地址

Web UI：http://localhost:3000
API 文档：http://localhost:7800/docs/
WebSocket：ws://localhost:7800/ws

六、API 概览

用户 API

# 用户注册
POST /api/v1/auth/register
{
  "username": "user1",
  "password": "password123",
  "email": "user@example.com"
}

# 用户登录
POST /api/v1/auth/login
{
  "username": "user1",
  "password": "password123"
}

# 获取用户信息
GET /api/v1/users/{user_id}

# 更新用户信息
PUT /api/v1/users/{user_id}
{
  "nickname": "新昵称",
  "avatar": "头像URL"
}

消息 API

# 发送消息
POST /api/v1/messages
{
  "type": "text",
  "to_user_id": "user2",
  "content": "Hello"
}

# 获取聊天历史
GET /api/v1/messages/{user_id}?page=1&limit=20

# 标记消息已读
PUT /api/v1/messages/{message_id}/read

# 撤回消息
DELETE /api/v1/messages/{message_id}

群组 API

# 创建群组
POST /api/v1/groups
{
  "name": "我的群组",
  "description": "群组描述",
  "members": ["user2", "user3"]
}

# 获取群组信息
GET /api/v1/groups/{group_id}

# 获取群组消息
GET /api/v1/groups/{group_id}/messages

# 添加群成员
POST /api/v1/groups/{group_id}/members
{
  "member_ids": ["user4", "user5"]
}

# 移除群成员
DELETE /api/v1/groups/{group_id}/members/{member_id}

七、WebSocket 消息格式

// 连接 WebSocket
const ws = new WebSocket('ws://localhost:7800/ws?token=your_token');

// 发送消息
ws.send(JSON.stringify({
    type: 'message',
    to_user_id: 'user2',
    content: 'Hello',
    message_type: 'text'
}));

// 接收消息
ws.onmessage = (event) => {
    const message = JSON.parse(event.data);
    console.log('Received:', message);
};

// 消息类型
{
    type: 'message',        // 消息
        type
:
    'status',         // 在线状态
        type
:
    'typing',         // 正在输入
        type
:
    'read',           // 已读回执
        type
:
    'notification'    // 系统通知
}

八、部署指南

Docker 部署

docker build -t gowind-im:latest .
docker run -d \
  -p 7800:7800 \
  -e DATABASE_DSN="your-database-dsn" \
  -e REDIS_ADDR="your-redis-addr" \
  gowind-im:latest

Docker Compose 部署

version: '3.8'
services:
  mysql:
    image: mysql:8.0
    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: im
    ports:
      - "3306:3306"
    volumes:
      - mysql_data:/var/lib/mysql

  redis:
    image: redis:7.0
    ports:
      - "6379:6379"

  im:
    build: .
    ports:
      - "7800:7800"
    depends_on:
      - mysql
      - redis
    environment:
      DATABASE_DSN: root:root@tcp(mysql:3306)/im
      REDIS_ADDR: redis:6379

volumes:
  mysql_data:

九、集成 SDK

JavaScript/TypeScript SDK

import {IMClient} from '@gowind/im-sdk';

const client = new IMClient({
    serverUrl: 'ws://localhost:7800',
    userId: 'user1',
    token: 'your_token'
});

// 连接
await client.connect();

// 发送消息
await client.sendMessage({
    to: 'user2',
    type: 'text',
    content: 'Hello'
});

// 接收消息
client.on('message', (message) => {
    console.log('New message:', message);
});

// 断开连接
await client.disconnect();

Go SDK

import "github.com/tx7do/go-wind-im/sdk"

client := sdk.NewClient("ws://localhost:7800", "user1", "token")
err := client.Connect()
if err != nil {
  log.Fatal(err)
}
defer client.Close()

// 发送消息
msg := &sdk.Message{
  To:      "user2",
  Type:    "text",
  Content: "Hello",
}
err = client.SendMessage(msg)