Tio Boot DocsTio Boot Docs
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
Home
  • java-db
  • api-table
  • Enjoy
  • Tio Boot Admin
  • ai_agent
  • translator
  • knowlege_base
  • ai-search
  • 案例
Abount
  • Github
  • Gitee
  • 01_tio-boot 简介

    • tio-boot:新一代高性能 Java Web 开发框架
    • tio-boot 入门示例
    • Tio-Boot 配置 : 现代化的配置方案
    • tio-boot 整合 Logback
    • tio-boot 整合 hotswap-classloader 实现热加载
    • 自行编译 tio-boot
    • 最新版本
    • 开发规范
  • 02_部署

    • 使用 Maven Profile 实现分环境打包 tio-boot 项目
    • Maven 项目配置详解:依赖与 Profiles 配置
    • tio-boot 打包成 FastJar
    • 使用 GraalVM 构建 tio-boot Native 程序
    • 使用 Docker 部署 tio-boot
    • 部署到 Fly.io
    • 部署到 AWS Lambda
    • 到阿里云云函数
    • 使用 Deploy 工具部署
    • 胖包与瘦包的打包与部署
    • 使用 Jenkins 部署 Tio-Boot 项目
    • 使用 Nginx 反向代理 Tio-Boot
    • 使用 Supervisor 管理 Java 应用
  • 03_配置

    • 配置参数
    • 服务器监听器
    • 内置缓存系统 AbsCache
    • 使用 Redis 作为内部 Cache
    • 静态文件处理器
    • 基于域名的静态资源隔离
    • DecodeExceptionHandler
  • 04_原理

    • 生命周期
    • 请求处理流程
    • 重要的类
  • 05_json

    • Json
    • 接受 JSON 和响应 JSON
    • 响应实体类
  • 06_web

    • 概述
    • 文件上传
    • 接收请求参数
    • 接收日期参数
    • 接收数组参数
    • 返回字符串
    • 返回文本数据
    • 返回网页
    • 请求和响应字节
    • 文件下载
    • 返回视频文件并支持断点续传
    • http Session
    • Cookie
    • HttpRequest
    • HttpResponse
    • Resps
    • RespBodyVo
    • /zh/06_web/19.html
    • 全局异常处理器
    • 异步
    • 动态 返回 CSS 实现
    • 返回图片
    • Transfer-Encoding: chunked 实时音频播放
    • Server-Sent Events (SSE)
    • 接口访问统计
    • 接口请求和响应数据记录
    • 自定义 Handler 转发请求
    • 使用 HttpForwardHandler 转发所有请求
    • 跨域
    • 添加 Controller
    • 常用工具类
    • HTTP Basic 认证
    • WebJars
    • JProtobuf
  • 07_validate

    • 数据紧校验规范
    • 参数校验
  • 08_websocket

    • 使用 tio-boot 搭建 WebSocket 服务
    • WebSocket 聊天室项目示例
  • 09_java-db

    • java‑db
    • 操作数据库入门示例
    • SQL 模板
    • 数据源配置与使用
    • ActiveRecord
    • Model
    • 生成器与 Model
    • Db 工具类
    • 批量操作
    • 数据库事务处理
    • Cache 缓存
    • Dialect 多数据库支持
    • 表关联操作
    • 复合主键
    • Oracle 支持
    • Enjoy SQL 模板
    • Java-DB 整合 Enjoy 模板最佳实践
    • 多数据源支持
    • 独立使用 ActiveRecord
    • 调用存储过程
    • java-db 整合 Guava 的 Striped 锁优化
    • 生成 SQL
    • 通过实体类操作数据库
    • java-db 读写分离
    • Spring Boot 整合 Java-DB
    • like 查询
    • 常用操作示例
    • Druid 监控集成指南
    • SQL 统计
  • 10_api-table

    • ApiTable 概述
    • 使用 ApiTable 连接 SQLite
    • 使用 ApiTable 连接 Mysql
    • 使用 ApiTable 连接 Postgres
    • 使用 ApiTable 连接 TDEngine
    • 使用 api-table 连接 oracle
    • 使用 api-table 连接 mysql and tdengine 多数据源
    • EasyExcel 导出
    • EasyExcel 导入
    • TQL(Table SQL)前端输入规范
    • ApiTable 实现增删改查
    • 数组类型
    • 单独使用 ApiTable
  • 11_aop

    • JFinal-aop
    • Aop 工具类
    • 配置
    • 配置
    • 独立使用 JFinal Aop
    • @AImport
    • 原理解析
  • 12_cache

    • Caffine
    • Jedis-redis
    • hutool RedisDS
    • Redisson
    • Caffeine and redis
    • CacheUtils 工具类
    • 使用 CacheUtils 整合 caffeine 和 redis 实现的两级缓存
    • 使用 java-db 整合 ehcache
    • 使用 java-db 整合 redis
    • Java DB Redis 相关 Api
    • redis 使用示例
  • 13_认证和权限

    • hutool-JWT
    • FixedTokenInterceptor
    • 使用内置 TokenManager 实现登录
    • 用户系统
    • 重置密码
    • 匿名登录
    • Google 登录
    • 权限校验注解
    • Sa-Token
    • sa-token 登录注册
    • StpUtil.isLogin() 源码解析
    • 短信登录
    • 移动端微信登录实现指南
    • 移动端重置密码
  • 14_i18n

    • i18n
  • 15_enjoy

    • tio-boot 整合 Enjoy 模版引擎文档
    • 引擎配置
    • 表达式
    • 指令
    • 注释
    • 原样输出
    • Shared Method 扩展
    • Shared Object 扩展
    • Extension Method 扩展
    • Spring boot 整合
    • 独立使用 Enjoy
    • tio-boot enjoy 自定义指令 localeDate
    • PromptEngine
    • Enjoy 入门示例-擎渲染大模型请求体
    • Enjoy 使用示例
  • 16_定时任务

    • Quartz 定时任务集成指南
    • 分布式定时任务 xxl-jb
    • cron4j 使用指南
  • 17_tests

    • TioBootTest 类
  • 18_tio

    • TioBootServer
    • tio-core
    • 内置 TCP 处理器
    • 独立启动 UDPServer
    • 使用内置 UDPServer
    • t-io 消息处理流程
    • tio-运行原理详解
    • TioConfig
    • ChannelContext
    • Tio 工具类
    • 业务数据绑定
    • 业务数据解绑
    • 发送数据
    • 关闭连接
    • Packet
    • 监控: 心跳
    • 监控: 客户端的流量数据
    • 监控: 单条 TCP 连接的流量数据
    • 监控: 端口的流量数据
    • 单条通道统计: ChannelStat
    • 所有通道统计: GroupStat
    • 资源共享
    • 成员排序
    • ssl
    • DecodeRunnable
    • 使用 AsynchronousSocketChannel 响应数据
    • 拉黑 IP
    • 深入解析 Tio 源码:构建高性能 Java 网络应用
  • 19_aio

    • ByteBuffer
    • AIO HTTP 服务器
    • 自定义和线程池和池化 ByteBuffer
    • AioHttpServer 应用示例 IP 属地查询
    • 手写 AIO Http 服务器
  • 20_netty

    • Netty TCP Server
    • Netty Web Socket Server
    • 使用 protoc 生成 Java 包文件
    • Netty WebSocket Server 二进制数据传输
    • Netty 组件详解
  • 21_netty-boot

    • Netty-Boot
    • 原理解析
    • 整合 Hot Reload
    • 整合 数据库
    • 整合 Redis
    • 整合 Elasticsearch
    • 整合 Dubbo
    • Listener
    • 文件上传
    • 拦截器
    • Spring Boot 整合 Netty-Boot
    • SSL 配置指南
    • ChannelInitializer
    • Reserve
  • 22_MQ

    • Mica-mqtt
    • EMQX
    • Disruptor
  • 23_tio-utils

    • tio-utils
    • HttpUtils
    • Notification
    • 邮箱
    • JSON
    • 读取文件
    • Base64
    • 上传和下载
    • Http
    • Telegram
    • RsaUtils
    • EnvUtils 使用文档
    • 系统监控
    • 毫秒并发 ID (MCID) 生成方案
  • 24_tio-http-server

    • 使用 Tio-Http-Server 搭建简单的 HTTP 服务
    • tio-boot 添加 HttpRequestHandler
    • 在 Android 上使用 tio-boot 运行 HTTP 服务
    • tio-http-server-native
    • handler 常用操作
  • 25_tio-websocket

    • WebSocket 服务器
    • WebSocket Client
  • 26_tio-im

    • 通讯协议文档
    • ChatPacket.proto 文档
    • java protobuf
    • 数据表设计
    • 创建工程
    • 登录
    • 历史消息
    • 发消息
  • 27_mybatis

    • Tio-Boot 整合 MyBatis
    • 使用配置类方式整合 MyBatis
    • 整合数据源
    • 使用 mybatis-plus 整合 tdengine
    • 整合 mybatis-plus
  • 28_mongodb

    • tio-boot 使用 mongo-java-driver 操作 mongodb
  • 29_elastic-search

    • Elasticsearch
    • JavaDB 整合 ElasticSearch
    • Elastic 工具类使用指南
    • Elastic-search 注意事项
    • ES 课程示例文档
  • 30_magic-script

    • tio-boot 整合 magic-script
  • 31_groovy

    • tio-boot 整合 Groovy
  • 32_firebase

    • 整合 google firebase
    • Firebase Storage
    • Firebase Authentication
    • 使用 Firebase Admin SDK 进行匿名用户管理与自定义状态标记
    • 导出用户
    • 注册回调
    • 登录注册
  • 33_文件存储

    • 文件上传数据表
    • 本地存储
    • 使用 AWS S3 存储文件并整合到 Tio-Boot 项目中
    • 存储文件到 腾讯 COS
  • 34_spider

    • jsoup
    • 爬取 z-lib.io 数据
    • 整合 WebMagic
    • WebMagic 示例:爬取学校课程数据
    • Playwright
    • Flexmark (Markdown 处理器)
    • tio-boot 整合 Playwright
    • 缓存网页数据
  • 36_integration_thirty_party

    • tio-boot 整合 okhttp
    • 整合 GrpahQL
    • 集成 Mailjet
    • 整合 ip2region
    • 整合 GeoLite 离线库
    • 整合 Lark 机器人指南
    • 集成 Lark Mail 实现邮件发送
    • Thymeleaf
    • Swagger
    • Clerk 验证
  • 37_dubbo

    • 概述
    • dubbo 2.6.0
    • dubbo 2.6.0 调用过程
    • dubbo 3.2.0
  • 38_spring

    • Spring Boot Web 整合 Tio Boot
    • spring-boot-starter-webflux 整合 tio-boot
    • Tio Boot 整合 Spring Boot Starter
    • Tio Boot 整合 Spring Boot Starter Data Redis 指南
  • 39_spring-cloud

    • tio-boot spring-cloud
  • 40_mysql

    • 使用 Docker 运行 MySQL
    • /zh/42_mysql/02.html
  • 41_postgresql

    • PostgreSQL 安装
    • PostgreSQL 主键自增
    • PostgreSQL 日期类型
    • Postgresql 金融类型
    • PostgreSQL 数组类型
    • PostgreSQL 全文检索
    • PostgreSQL 查询优化
    • 获取字段类型
    • PostgreSQL 向量
    • PostgreSQL 优化向量查询
    • PostgreSQL 其他
  • 43_oceanbase

    • 快速体验 OceanBase 社区版
    • 快速上手 OceanBase 数据库单机部署与管理
    • 诊断集群性能
    • 优化 SQL 性能指南
    • /zh/43_oceanbase/05.html
  • 50_media

    • JAVE 提取视频中的声音
    • Jave 提取视频中的图片
    • /zh/50_media/03.html
  • 51_asr

    • Whisper-JNI
  • 54_native-media

    • java-native-media
    • JNI 入门示例
    • mp3 拆分
    • mp4 转 mp3
    • 使用 libmp3lame 实现高质量 MP3 编码
    • Linux 编译
    • macOS 编译
    • 从 JAR 包中加载本地库文件
    • 支持的音频和视频格式
    • 任意格式转为 mp3
    • 通用格式转换
    • 通用格式拆分
    • 视频合并
    • VideoToHLS
    • split_video_to_hls 支持其他语言
    • 持久化 HLS 会话
  • 55_telegram4j

    • 数据库设计
    • /zh/55_telegram4j/02.html
    • 基于 MTProto 协议开发 Telegram 翻译机器人
    • 过滤旧消息
    • 保存机器人消息
    • 定时推送
    • 增加命令菜单
    • 使用 telegram-Client
    • 使用自定义 StoreLayout
    • 延迟测试
    • Reactor 错误处理
    • Telegram4J 常见错误处理指南
  • 56_telegram-bots

    • TelegramBots 入门指南
    • 使用工具库 telegram-bot-base 开发翻译机器人
  • 60_LLM

    • 简介
    • AI 问答
    • /zh/60_LLM/03.html
    • /zh/60_LLM/04.html
    • 增强检索(RAG)
    • 结构化数据检索
    • 搜索+AI
    • 集成第三方 API
    • 后置处理
    • 推荐问题生成
    • 连接代码执行器
    • 避免 GPT 混乱
    • /zh/60_LLM/13.html
  • 61_ai_agent

    • 数据库设计
    • 示例问题管理
    • 会话管理
    • 历史记录
    • 对接 Perplexity API
    • 意图识别与生成提示词
    • 智能问答模块设计与实现
    • 文件上传与解析文档
    • 翻译
    • 名人搜索功能实现
    • Ai studio gemini youbue 问答使用说明
    • 自建 YouTube 字幕问答系统
    • 自建 获取 youtube 字幕服务
    • 通用搜索
    • /zh/61_ai_agent/15.html
    • 16
    • 17
    • 18
    • 在 tio-boot 应用中整合 ai-agent
    • 16
  • 62_translator

    • 简介
  • 63_knowlege_base

    • 数据库设计
    • 用户登录实现
    • 模型管理
    • 知识库管理
    • 文档拆分
    • 片段向量
    • 命中测试
    • 文档管理
    • 片段管理
    • 问题管理
    • 应用管理
    • 向量检索
    • 推理问答
    • 问答模块
    • 统计分析
    • 用户管理
    • api 管理
    • 存储文件到 S3
    • 文档解析优化
    • 片段汇总
    • 段落分块与检索
    • 多文档解析
    • 对话日志
    • 检索性能优化
    • Milvus
    • 文档解析方案和费用对比
    • 离线运行向量模型
  • 64_ai-search

    • ai-search 项目简介
    • ai-search 数据库文档
    • ai-search SearxNG 搜索引擎
    • ai-search Jina Reader API
    • ai-search Jina Search API
    • ai-search 搜索、重排与读取内容
    • ai-search PDF 文件处理
    • ai-search 推理问答
    • Google Custom Search JSON API
    • ai-search 意图识别
    • ai-search 问题重写
    • ai-search 系统 API 接口 WebSocket 版本
    • ai-search 搜索代码实现 WebSocket 版本
    • ai-search 生成建议问
    • ai-search 生成问题标题
    • ai-search 历史记录
    • Discover API
    • 翻译
    • Tavily Search API 文档
    • 对接 Tavily Search
    • 火山引擎 DeepSeek
    • 对接 火山引擎 DeepSeek
    • ai-search 搜索代码实现 SSE 版本
    • jar 包部署
    • Docker 部署
    • 爬取一个静态网站的所有数据
    • 网页数据预处理
    • 网页数据检索与问答流程整合
  • 65_java-linux

    • Java 执行 python 代码
    • 通过大模型执行 Python 代码
    • MCP 协议
    • Cline 提示词
    • Cline 提示词-中文版本
  • 66_manim

    • 简介
    • Manim 开发环境搭建
    • 生成场景提示词
    • 生成代码
    • 完整脚本示例
    • 语音合成系统
    • Fish.audio TTS 接口说明文档与 Java 客户端封装
    • 整合 fishaudio 到 java-uni-ai-server 项目
    • 执行 Python (Manim) 代码
    • 使用 SSE 流式传输生成进度的实现文档
    • 整合全流程完整文档
    • HLS 动态推流技术文档
    • manim 分场景生成代码
    • 分场景运行代码及流式播放支持
    • 分场景业务端完整实现流程
    • Maiim布局管理器
    • 仅仅生成场景代码
    • 使用 modal 运行 manim 代码
    • Python 使用 Modal GPU 加速渲染
    • Modal 平台 GPU 环境下运行 Manim
    • Modal Manim OpenGL 安装与使用
    • 优化 GPU 加速
    • 生成视频封面流程
    • Java 调用 manim 命令 执行代码 生成封面
    • Manim 图像生成服务客户端文档
    • manim render help
    • 显示 中文公式
    • manimgl
    • EGL
    • /zh/66_manim/30.html
    • /zh/66_manim/31.html
    • 成本核算
    • /zh/66_manim/33.html
  • 70_tio-boot-admin

    • 入门指南
    • 初始化数据
    • token 存储
    • 与前端集成
    • 文件上传
    • 网络请求
    • 图片管理
    • /zh/70_tio-boot-admin/08.html
    • Word 管理
    • PDF 管理
    • 文章管理
    • 富文本编辑器
  • 71_tio-boot

    • /zh/71_tio-boot/01.html
    • Swagger 整合到 Tio-Boot 中的指南
    • HTTP/1.1 Pipelining 性能测试报告
  • 80_性能测试

    • 压力测试 - tio-http-serer
    • 压力测试 - tio-boot
    • 压力测试 - tio-boot-native
    • 压力测试 - netty-boot
    • 性能测试对比
    • TechEmpower FrameworkBenchmarks
    • 压力测试 - tio-boot 12 C 32G
  • 99_案例

    • 封装 IP 查询服务
    • tio-boot 案例 - 全局异常捕获与企业微信群通知
    • tio-boot 案例 - 文件上传和下载
    • tio-boot 案例 - 整合 ant design pro 增删改查
    • tio-boot 案例 - 流失响应
    • tio-boot 案例 - 增强检索
    • tio-boot 案例 - 整合 function call
    • tio-boot 案例 - 定时任务 监控 PostgreSQL、Redis 和 Elasticsearch
    • Tio-Boot 案例:使用 SQLite 整合到登录注册系统
    • tio-boot 案例 - 执行 shell 命令

通讯协议文档

  • 功能概述
  • 消息格式
  • 消息重发机制
  • 登录方式
  • 群聊功能
  • 消息通讯协议
    • 通用消息结构
  • 具体命令
    • 0. 错误信息
    • 1. 确认消息(ACK)
    • 3. 登录请求消息
    • 4. 登录响应消息
    • 5. 鉴权请求消息
    • 6. 鉴权响应消息
    • 7. 心跳请求消息
    • 8. 心跳响应消息
    • 9. 退出请求消息
    • 10. 退出响应消息
    • 11. 聊天消息请求
    • 12. 聊天消息响应
    • 13. 已读请求消息
    • 14. 已读响应消息
    • 15. 撤回消息请求
    • 16. 撤回消息响应
    • 17. 消息转发请求
    • 18. 消息转发响应
    • 19. 获取用户信息请求消息
    • 20. 获取用户信息响应消息
    • 21. 创建群请求消息
    • 22. 创建群响应消息
    • 23. 解散群请求消息
    • 24. 解散群响应消息
    • 25. 邀请加入群请求消息
    • 26. 邀请加入群响应消息
    • 27. 加入群请求消息
    • 28. 加入群响应消息
    • 29. 退出群请求消息
    • 30. 退出群响应消息
    • 31. 群发消息请求
    • 32. 群发消息响应
    • 33. 静音用户请求消息
    • 34. 静音用户响应消息
    • 35. 屏蔽用户请求消息
    • 36. 屏蔽用户响应消息
    • 37. 删除用户请求消息
    • 38. 删除用户响应消息
    • 41. 静音群请求消息
    • 42. 静音群响应消息
    • 43. 屏蔽群请求消息
    • 44. 屏蔽群响应消息
  • 附录
    • 错误代码说明

本通讯协议旨在为即时通讯系统提供一套全面、可靠的消息传输标准。协议支持多种登录方式、消息类型及群聊功能,并包含完善的鉴权与消息重发机制,确保消息的安全与可靠传递。


功能概述

本通讯协议支持以下功能:

  • 确认(ACK)、重发、消息序列 管理。
  • 匿名登录、用户名密码登录 和 Token 登录。
  • 支持发送多种类型的消息:文本(Text)、图片(Image)、音频(Audio)、视频(Video)、新闻(News)、Markdown。
  • 群聊功能:创建群、解散群、邀请加入群、加入群、退出群、屏蔽群、群发消息。
  • 鉴权机制:在发送消息等相关操作中需要携带 token 进行鉴权。

消息格式

所有消息均采用统一的 JSON/Binary 结构,确保不同类型的消息能够被一致地处理和解析。


消息重发机制

为了确保消息的可靠传输,本协议采用消息序列号与确认(ACK)机制。

  • 消息序列号(sequence):每个消息都有唯一的序列号,用于跟踪消息的发送和接收。
  • 确认字段(ack):用于确认收到特定序列号的消息。如果发送方在一定时间内未收到确认,则会重发该消息。

登录方式

协议支持多种登录方式,以满足不同场景下的需求:

  1. 匿名登录:

    • 在登录请求中,将 anonymous 字段设置为 true,并提供 loginname 进行匿名登录。
    • 示例:
      {
        "username": "guest",
        "anonymous": true
      }
      
  2. 用户名密码登录:

    • 提供 username 和 password 字段进行验证。
    • 示例:
      {
        "username": "user123",
        "password": "securepassword"
      }
      
  3. Token 登录:

    • 提供 token 字段进行验证,适用于已经获取过 Token 的场景。
    • 示例:
      {
        "token": "abcdef123456"
      }
      

注意:在登录请求中,username 和 password 与 token 仅需传递一种即可。


群聊功能

本协议支持全面的群聊功能,具体包括:

  1. 创建群:用户可创建新群组,指定群名称、初始成员及群描述。
  2. 解散群:群主或有权限的成员可解散群组。
  3. 邀请加入群:群主或有权限的成员可邀请其他用户加入群组。
  4. 加入群:用户可通过邀请或申请方式加入群组。
  5. 退出群:群成员可主动退出群组。
  6. 屏蔽群:群成员可选择屏蔽某个群组的消息通知。
  7. 群发消息:用户可向群组发送多种类型的消息。

上述每项功能均通过相应的请求与响应消息进行操作和确认,确保群聊功能的可靠性与用户体验。


消息通讯协议

通用消息结构

所有的消息均遵循以下通用结构:

{
  "cmd": "命令码",
  "sequence": "消息序列号 (Long类型)",
  "ack": "确认的消息序列号 (Long类型,可选)",
  "from": "发送方ID",
  "to": "接收方ID",
  "token": "鉴权令牌 (String类型,可选)",
  "timestamp": "消息创建时间 (Long类型, UTC时间戳)",
  "body": {
    // 根据cmd不同,body内容不同
  }
}
  • cmd:命令码,表示消息类型。
  • sequence:消息序列号,用于消息的唯一标识和重发机制。
  • ack:可选字段,用于确认收到特定序列号的消息。
  • from 和 to:发送方和接收方的 ID。
  • token:用于鉴权的令牌,部分消息类型为必填项。
  • timestamp:消息创建的时间戳,采用 System.currentTimeMillis() 方法生成,自 1970 年 1 月 1 日 00:00:00 UTC 起的毫秒数。
  • body:消息主体,根据不同的 cmd 类型而变化。

时间戳说明

定义为自 1970 年 1 月 1 日 00:00:00 UTC(协调世界时)起至当前时刻的毫秒数。这是一个绝对时间戳,表示的是统一的 UTC 时间,与系统的本地时区设置无关。


具体命令

以下是具体的命令码及其对应的消息结构。

0. 错误信息

  • 命令码:COMMAND_ERROR (0)
{
  "cmd": 0,
  "ack": 1234567894,
  "message": "错误描述信息"
}
  • 说明:用于传递错误信息,ack 字段指向相关联的消息序列号。

1. 确认消息(ACK)

  • 命令码:COMMAND_ACK (1)
{
  "cmd": 1,
  "ack": 1234567890,
  "timestamp": 1725338896411
}
  • 说明:用于确认已收到特定序列号的消息。

3. 登录请求消息

  • 命令码:COMMAND_LOGIN_REQ (3)
{
  "cmd": 3,
  "sequence": 1234567894,
  "timestamp": 1725338896811,
  "body": {
    "username": "用户名",
    "password": "密码",
    "token": "令牌",
    "anonymous": true // 是否匿名登录,默认为false(可选)
  }
}
  • 说明:客户端发送的登录请求。根据登录方式,body 中的字段会有所不同。

4. 登录响应消息

  • 命令码:COMMAND_LOGIN_RESP (4)
{
  "cmd": 4,
  "ack": 1234567894,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息",
  "body": {
    "userId": "1"
  }
}
  • 说明:服务器对登录请求的响应,code 表示状态,body 中包含用户 ID。

5. 鉴权请求消息

  • 命令码:COMMAND_AUTH_REQ (5)
{
  "cmd": 5,
  "sequence": 1234567892,
  "timestamp": 1725338896611,
  "token": "校验码"
}
  • 说明:用于验证用户身份的请求消息,需携带有效的 token。

6. 鉴权响应消息

  • 命令码:COMMAND_AUTH_RESP (6)
{
  "cmd": 6,
  "ack": 1234567892,
  "timestamp": 1725338896711,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对鉴权请求的响应,code 表示鉴权结果。

7. 心跳请求消息

  • 命令码:COMMAND_HEARTBEAT_REQ (7)
{
  "cmd": 7,
  "sequence": 1234567896,
  "timestamp": 1725338897011
}
  • 说明:客户端发送的心跳请求,仅包含 cmd、sequence 和 timestamp 三个字段,用于维持连接活跃。

8. 心跳响应消息

  • 命令码:COMMAND_HEARTBEAT_RESP (8)
{
  "cmd": 8,
  "ack": 1234567896,
  "timestamp": 1725338897011,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对心跳请求的响应,ack 对应客户端发送的 sequence。

备注:根据具体业务实现,有时 cmd 可能复用为 1(ACK 消息)以简化响应。


9. 退出请求消息

  • 命令码:COMMAND_CLOSE_REQ (9)
{
  "cmd": 9,
  "sequence": 1234567897,
  "from": "客户端ID",
  "token": "鉴权令牌",
  "timestamp": 1725338897111
}
  • 说明:客户端发送的退出请求,用于断开与服务器的连接。

10. 退出响应消息

  • 命令码:COMMAND_CLOSE_RESP (10)
{
  "cmd": 10,
  "ack": 1234567897,
  "timestamp": 1725338897111,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对退出请求的响应,确认客户端已成功退出。

11. 聊天消息请求

  • 命令码:COMMAND_CHAT_REQ (11)

  • 发送消息

{
  "cmd": 11,
  "sequence": 1234567890,
  "to": "接收方ID",
  "timestamp": 1725338896411,
  "body": {
    "msgType": "消息类型 (text、image、audio、video、news、markdown)",
    "content": {
      // 根据msgType不同,content结构不同
    }
  }
}
  • 接收消息
{
  "cmd": 11,
  "timestamp": 1725338896411,
  "sequence": 1234567890,
  "from": "发送方Id",
  "to": "接收方id",
  "id": "雪花id", // 服务器生成
  "body": {
    "msgType": "消息类型 (text、image、audio、video、news、markdown)",
    "content": {
      // 根据msgType不同,content结构不同
    }
  }
}
  • 说明:
    • 客户端发送聊天消息时,指定接收方 ID 及消息内容。
    • 服务器转发消息时,包含发送方 ID、接收方 ID 及服务器生成的唯一消息 ID(雪花 ID)。

根据不同的 msgType,消息内容(content)的结构有所不同:

  1. 文本消息(text)

    "content": {
        "text": "文本内容"
    }
    
  2. 图片消息(image)

    "content": {
        "url": "图片URL",
        "width": 800,
        "height": 600,
        "format": "png"
    }
    
  3. 音频消息(audio)

    "content": {
        "url": "音频URL",
        "duration": 60, // 秒
        "format": "mp4"
    }
    
  4. 视频消息(video)

    "content": {
        "url": "视频URL",
        "duration": 60, // 秒
        "thumbnail": "缩略图URL",
        "format": "mp4"
    }
    
  5. 新闻消息(news)

    "content": {
        "title": "新闻标题",
        "description": "新闻描述",
        "url": "新闻链接",
        "image": "新闻图片URL"
    }
    
  6. Markdown 消息(markdown)

    "content": {
        "markdown": "Markdown格式的文本"
    }
    

12. 聊天消息响应

  • 命令码:COMMAND_CHAT_RESP (12)
{
  "cmd": 12,
  "timestamp": 1725338896411,
  "from": "发送方Id",
  "to": "接收方Id",
  "ack": 1234567890,
  "id": "雪花id", // 服务器生成
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 字段说明:

    • ack:确认的消息序列 ID,用于消息追踪和确认。
    • code:消息状态码,具体含义如下:
      • 0: 消息发送失败。
      • 1: 消息已成功入库。
      • 2: 消息已从服务器成功发送。
      • 3: 消息已成功到达客户端。
      • 4: 目标用户已读该消息。
      • 5: 目标用户已屏蔽该用户。
    • id:由服务器在消息入库后生成的唯一雪花 ID。
  • 消息流程说明:

    1. 服务器响应:服务器在收到消息后,立即返回 COMMAND_CHAT_RESP 消息,用于确认该消息是否成功入库或已从服务器发送。
    2. 客户端响应:客户端在收到消息后,需要向服务器发送 COMMAND_CHAT_RESP,以确认消息已成功到达客户端。
    3. 超时与重发机制:如果服务器未能及时收到客户端的 COMMAND_CHAT_RESP 响应,将认为消息未送达,并启动定时重发机制,确保消息的可靠送达。

13. 已读请求消息

  • 命令码:COMMAND_MESSAGE_READ_REQ (13)
{
  "cmd": 13,
  "timestamp": 1725338896411,
  "sequence": 1234567890,
  "from": "2",
  "to": "1",
  "id": "451987138345680896",
  "code": 1
}
  • 说明:用于通知服务器某条消息已被阅读。包含消息 ID 及相关信息。

14. 已读响应消息

  • 命令码:COMMAND_MESSAGE_READ_RESP (14)
{
  "cmd": 14,
  "ack": 1234567890,
  "timestamp": 1111111111,
  "code": 1
}
  • 说明:服务器对已读请求的响应,确认已收到已读通知。

15. 撤回消息请求

  • 命令码:COMMAND_RECALL_MSG_REQ (15)
{
  "cmd": 15,
  "timestamp": 1725338899011,
  "sequence": 1234567915,
  "from": "用户ID",
  "id": "451987138345680896" // 撤回的消息ID
}
  • 说明:用户请求撤回某条已发送的消息,需提供消息 ID。

16. 撤回消息响应

  • 命令码:COMMAND_RECALL_MSG_RESP (16)
{
  "cmd": 16,
  "ack": 1234567915,
  "timestamp": 1725338899111,
  "code": 1,
  "message": "描述信息"
}
  • 说明:服务器对撤回消息请求的响应,确认撤回操作是否成功。

17. 消息转发请求

  • 命令码:COMMAND_FORWARD_MSG_REQ (17)
{
  "cmd": 17,
  "timestamp": 1725338899211,
  "sequence": 1234567916,
  "from": "用户ID",
  "body": {
    "to": ["接收方ID1", "接收方ID2"] // 支持多目标
  },
  "originalMsgId": "原始消息ID" // 需转发的消息ID
}
  • 说明:支持将指定消息转发给其他用户或群组,to 字段支持多个目标。

18. 消息转发响应

  • 命令码:COMMAND_FORWARD_MSG_RESP (18)
{
  "cmd": 18,
  "ack": 1234567916,
  "timestamp": 1725338899211,
  "code": 1,
  "message": "描述信息"
}
  • 说明:服务器对消息转发请求的响应,确认转发操作是否成功。

19. 获取用户信息请求消息

  • 命令码:COMMAND_GET_USER_REQ (19)
{
  "cmd": 19,
  "sequence": 1234567898,
  "timestamp": 1725338897211,
  "body": {
    "userId": "用户ID", // type为0时必填
    "groupId": "组ID", // type为1时必填
    "type": 0 // 0: 获取好友信息, 1: 获取指定组信息, 2: 获取其他类型信息
  }
}
  • 说明:用于请求获取用户或群组的信息,根据 type 字段决定获取的具体信息类型。

20. 获取用户信息响应消息

  • 命令码:COMMAND_GET_USER_RESP (20)
{
  "cmd": 20,
  "ack": 1234567898,
  "timestamp": 1725338897311,
  "body": {
    "users": [
      {
        "userId": "用户ID",
        "username": "用户名",
        "nickname": "昵称",
        "avatar": "头像URL"
        // 更多用户信息字段
      }
      // 可包含更多用户信息
    ]
  }
}
  • 说明:服务器对获取用户信息请求的响应,body 中包含所请求的用户或群组详细信息。

21. 创建群请求消息

  • 命令码:COMMAND_CREATE_GROUP_REQ (21)
{
  "cmd": 21,
  "sequence": 1234567900,
  "timestamp": 1725338897411,
  "body": {
    "groupName": "群名称",
    "members": ["成员ID1", "成员ID2"], // 可选,初始成员列表
    "description": "群描述"
  }
}
  • 说明:用户请求创建一个新群组,可以指定初始成员列表及群组描述。

22. 创建群响应消息

  • 命令码:COMMAND_CREATE_GROUP_RESP (22)
{
  "cmd": 22,
  "ack": 1234567900,
  "timestamp": 1725338897511,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息",
  "body": {
    "groupId": "新创建的群ID"
  }
}
  • 说明:服务器对创建群请求的响应,返回新创建的群 ID。

23. 解散群请求消息

  • 命令码:COMMAND_DISBAND_GROUP_REQ (23)
{
  "cmd": 23,
  "sequence": 1234567902,
  "timestamp": 1725338897611,
  "body": {
    "groupId": "群ID",
    "name": "群主用户名" // 可选,用于验证操作权限
  }
}
  • 说明:群主或有权限的用户请求解散指定群组。

24. 解散群响应消息

  • 命令码:COMMAND_DISBAND_GROUP_RESP (24)
{
  "cmd": 24,
  "ack": 1234567902,
  "timestamp": 1725338897711,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对解散群请求的响应,确认群组是否成功解散。

25. 邀请加入群请求消息

  • 命令码:COMMAND_INVITE_TO_GROUP_REQ (25)
{
  "cmd": 25,
  "sequence": 1234567904,
  "timestamp": 1725338897811,
  "body": {
    "groupId": "群ID",
    "invitees": ["被邀请者ID1", "被邀请者ID2"]
  }
}
  • 说明:群主或有权限的成员邀请其他用户加入群组。

26. 邀请加入群响应消息

  • 命令码:COMMAND_INVITE_TO_GROUP_RESP (26)
{
  "cmd": 26,
  "ack": 1234567904,
  "timestamp": 1725338897911,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对邀请加入群请求的响应,确认邀请操作是否成功。

27. 加入群请求消息

  • 命令码:COMMAND_JOIN_GROUP_REQ (27)
{
  "cmd": 27,
  "sequence": 1234567906,
  "timestamp": 1725338898011,
  "body": {
    "groupId": "群ID"
  }
}
  • 说明:用户请求加入指定群组。

28. 加入群响应消息

  • 命令码:COMMAND_JOIN_GROUP_RESP (28)
{
  "cmd": 28,
  "ack": 1234567906,
  "timestamp": 1725338898111,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对加入群请求的响应,确认加入操作是否成功。

29. 退出群请求消息

  • 命令码:COMMAND_LEAVE_GROUP_REQ (29)
{
  "cmd": 29,
  "sequence": 1234567908,
  "from": "成员ID",
  "token": "鉴权令牌",
  "timestamp": 1725338898211,
  "body": {
    "groupId": "群ID"
  }
}
  • 说明:成员请求退出指定群组,需携带有效的 token 进行鉴权。

30. 退出群响应消息

  • 命令码:COMMAND_LEAVE_GROUP_RESP (30)
{
  "cmd": 30,
  "ack": 1234567908,
  "timestamp": 1725338898311,
  "code": 1, // 1: 成功, 其他: 错误代码
  "message": "描述信息"
}
  • 说明:服务器对退出群请求的响应,确认退出操作是否成功。

31. 群发消息请求

  • 命令码:COMMAND_GROUP_MESSAGE_REQ (31)
{
  "cmd": 31,
  "sequence": 1234567912,
  "groupId": "群ID",
  "timestamp": 1725338898611,
  "body": {
    "msgType": "消息类型",
    "content": {
      // 与之前的消息类型相同
    }
  }
}
  • 说明:用户向群组发送消息,支持多种消息类型。

32. 群发消息响应

  • 命令码:COMMAND_GROUP_MESSAGE_RESP (32)
{
  "cmd": 32,
  "sequence": 1234567913,
  "ack": 1234567912,
  "from": "服务器ID",
  "groupId": "发送方ID",
  "timestamp": 1725338898711,
  "code": 1,
  "message": "描述信息"
}
  • 说明:服务器对群发消息请求的响应,确认消息是否成功发送至群组。

33. 静音用户请求消息

  • 命令码:COMMAND_MUTE_USER_REQ (33)
{
  "cmd": 33,
  "sequence": 1234567910,
  "timestamp": 1725338898411,
  "body": {
    "user_id": "群ID",
    "mute": true // true: 静音, false: 取消静音
  }
}

34. 静音用户响应消息

  • 命令码:COMMAND_MUTE_USER_RESP (34)
{
  "cmd": 34,
  "ack": 1234567910,
  "from": "用户id",
  "timestamp": 1725338898511,
  "code": 1,
  "message": "描述信息"
}

35. 屏蔽用户请求消息

  • 命令码:COMMAND_BLOCK_USER_REQ (35)
{
  "cmd": 35,
  "sequence": 1234567910,
  "timestamp": 1725338898411,
  "body": {
    "user_id": "user id",
    "block": true // true: 屏蔽, false: 取消屏蔽
  }
}

36. 屏蔽用户响应消息

  • 命令码:COMMAND_MUTE_USER_RESP (36)
{
  "cmd": 36,
  "ack": 1234567910,
  "from": "用户id",
  "timestamp": 1725338898511,
  "code": 1,
  "message": "描述信息"
}

37. 删除用户请求消息

  • 命令码:COMMAND_DELETE_USER_REQ (37)
{
  "cmd": 35,
  "sequence": 1234567910,
  "timestamp": 1725338898411,
  "body": {
    "user_id": "群ID",
    "delete": true // true: 删除, false: 取消删除
  }
}

38. 删除用户响应消息

  • 命令码:COMMAND_DELETE_USER_RESP (38)
{
  "cmd": 39,
  "ack": 1234567910,
  "from": "用户id",
  "timestamp": 1725338898511,
  "code": 1,
  "message": "描述信息"
}

41. 静音群请求消息

  • 命令码:COMMAND_MUTE_GROUP_REQ (41)
{
  "cmd": 41,
  "sequence": 1234567910,
  "from": "成员ID",
  "timestamp": 1725338898411,
  "body": {
    "groupId": "群ID",
    "mute": true // true: 屏蔽, false: 取消屏蔽
  }
}
  • 说明:成员请求屏蔽或取消屏蔽指定群组的消息通知。

42. 静音群响应消息

  • 命令码:COMMAND_MUTE_GROUP_RESP (42)
{
  "cmd": 41,
  "ack": 1234567910,
  "from": "成员ID",
  "timestamp": 1725338898511,
  "code": 1,
  "message": "描述信息"
}
  • 说明:服务器对屏蔽群请求的响应,确认屏蔽操作是否成功。

43. 屏蔽群请求消息

  • 命令码:COMMAND_BLOCK_GROUP_REQ (43)
{
  "cmd": 43,
  "sequence": 1234567910,
  "from": "成员ID",
  "timestamp": 1725338898411,
  "body": {
    "groupId": "群ID",
    "mute": true // true: 屏蔽, false: 取消屏蔽
  }
}
  • 说明:成员请求屏蔽或取消屏蔽指定群组的消息通知。

44. 屏蔽群响应消息

  • 命令码:COMMAND_BLOCK_GROUP_RESP (44)
{
  "cmd": 44,
  "ack": 1234567910,
  "from": "成员ID",
  "timestamp": 1725338898511,
  "code": 1,
  "message": "描述信息"
}
  • 说明:服务器对屏蔽群请求的响应,确认屏蔽操作是否成功。

附录

错误代码说明

  • 1:操作成功。
  • 2:认证失败或 Token 无效。
  • 3:权限不足。
  • 4:目标用户或群组不存在。
  • 5:消息格式错误。
  • 6:服务器内部错误。
  • 7:消息未找到(用于撤回操作)。
  • 8:操作超时。
  • 9:其他自定义错误代码。

备注:具体错误代码的定义可根据实际业务需求进行扩展和调整。

Edit this page
Last Updated:
Contributors: Tong Li
Next
ChatPacket.proto 文档