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 命令

ChatPacket.proto 文档

  • 协议概述

本文档详细描述了即时通讯系统中使用的 ChatPacket.proto 文件,该文件基于 Protocol Buffers(protobuf)定义了通讯协议中的各类消息结构和命令类型。本文档不仅对原始的 .proto 文件进行了润色和格式优化,还根据前述通讯协议的内容修复了其中的错误,确保协议的一致性和完整性。

协议概述

ChatPacket.proto 文件定义了即时通讯系统中所有可能的消息类型及其结构。通过使用 Protocol Buffers,消息在客户端与服务器之间进行高效的序列化与反序列化,确保通讯的高效性与可靠性。


syntax = "proto3";

package com.litongjava.protobuf;

option java_outer_classname = "ChatPacketOuter";

// 命令类型枚举
enum CommandType {
    COMMAND_ERROR = 0;               // 错误信息
    COMMAND_ACK = 1;                 // 确认消息
    COMMAND_HANDSHAKE_REQ = 2;       // 握手请求
    COMMAND_HANDSHAKE_RESP = 3;      // 握手响应
    COMMAND_AUTH_REQ = 4;            // 鉴权请求
    COMMAND_AUTH_RESP = 5;           // 鉴权响应
    COMMAND_LOGIN_REQ = 6;           // 登录请求
    COMMAND_LOGIN_RESP = 7;          // 登录响应
    COMMAND_CHAT_REQ = 11;           // 聊天消息请求
    COMMAND_CHAT_RESP = 12;          // 聊天消息响应
    COMMAND_MESSAGE_READ_REQ = 13;   // 已读请求
    COMMAND_MESSAGE_READ_RESP = 14;  // 已读响应
    COMMAND_RECALL_MSG_REQ = 15;     // 撤回消息请求
    COMMAND_RECALL_MSG_RESP = 16;    // 撤回消息响应
    COMMAND_GET_USER_REQ = 17;       // 获取用户信息请求
    COMMAND_GET_USER_RESP = 18;      // 获取用户信息响应
    COMMAND_CREATE_GROUP_REQ = 19;   // 创建群请求
    COMMAND_CREATE_GROUP_RESP = 20;  // 创建群响应
    COMMAND_DISBAND_GROUP_REQ = 21;  // 解散群请求
    COMMAND_DISBAND_GROUP_RESP = 22; // 解散群响应
    COMMAND_INVITE_TO_GROUP_REQ = 23;// 邀请加入群请求
    COMMAND_INVITE_TO_GROUP_RESP = 24;// 邀请加入群响应
    COMMAND_JOIN_GROUP_REQ = 25;     // 加入群请求
    COMMAND_JOIN_GROUP_RESP = 26;    // 加入群响应
    COMMAND_LEAVE_GROUP_REQ = 27;    // 退出群请求
    COMMAND_LEAVE_GROUP_RESP = 28;   // 退出群响应
    COMMAND_MUTE_GROUP_REQ = 29;     // 屏蔽群请求
    COMMAND_MUTE_GROUP_RESP = 30;    // 屏蔽群响应
    COMMAND_GROUP_MESSAGE_REQ = 31;  // 群发消息请求
    COMMAND_GROUP_MESSAGE_RESP = 32; // 群发消息响应
}

// 主消息结构
message ChatPacket {
    CommandType cmd = 1;          // 命令码,表示消息类型
    int64 sequence = 2;           // 消息序列号,用于消息的唯一标识和重发机制
    int64 ack = 3;                // 确认的消息序列号,可选
    string from = 4;              // 发送方ID
    string to = 5;                // 接收方ID
    int64 timestamp = 6;          // 消息创建时间,UTC时间戳
    string token = 7;             // 鉴权令牌,可选

    string groupId = 8;           // 群聊消息时使用的群ID,可选

    oneof body {
        HandshakeMessage handshakeMessage = 9;               // 握手消息
        AuthMessage authMessage = 10;                         // 鉴权消息
        LoginMessage loginMessage = 11;                       // 登录请求消息
        LoginResponse loginResponse = 12;                     // 登录响应消息
        ChatMessage chatMessage = 13;                         // 聊天请求消息
        ChatResponse chatResponse = 14;                       // 聊天响应消息
        HeartbeatMessage heartbeatMessage = 15;               // 心跳消息
        CloseMessage closeMessage = 16;                        // 关闭、退出消息
        GetUserMessage getUserMessage = 17;                    // 获取用户信息请求消息
        GetUserResponse getUserResponse = 18;                  // 获取用户信息响应消息

        // 群聊消息
        CreateGroupMessage createGroupMessage = 19;            // 创建群请求消息
        CreateGroupResponse createGroupResponse = 20;          // 创建群响应消息
        DisbandGroupMessage disbandGroupMessage = 21;          // 解散群请求消息
        DisbandGroupResponse disbandGroupResponse = 22;        // 解散群响应消息
        InviteToGroupMessage inviteToGroupMessage = 23;        // 邀请加入群请求消息
        InviteToGroupResponse inviteToGroupResponse = 24;      // 邀请加入群响应消息
        JoinGroupMessage joinGroupMessage = 25;                // 加入群请求消息
        JoinGroupResponse joinGroupResponse = 26;              // 加入群响应消息
        LeaveGroupMessage leaveGroupMessage = 27;              // 退出群请求消息
        LeaveGroupResponse leaveGroupResponse = 28;            // 退出群响应消息
        MuteGroupMessage muteGroupMessage = 29;                // 屏蔽群请求消息
        MuteGroupResponse muteGroupResponse = 30;              // 屏蔽群响应消息
        GroupChatMessage groupChatMessage = 31;                // 群发消息请求
        GroupChatResponse groupChatResponse = 32;              // 群发消息响应消息
    }
}

// 握手消息
message HandshakeMessage {
    bytes hbyte = 1; // 握手字节数据
}

// 鉴权消息
message AuthMessage {
    string token = 1; // 鉴权令牌
}

// 登录请求消息
message LoginMessage {
    string loginname = 1;   // 登录名
    string password = 2;    // 密码
    string token = 3;       // 鉴权令牌
    bool anonymous = 4;     // 是否匿名登录,默认为false
}

// 登录响应消息
message LoginResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
    string userId = 3;      // 用户ID,成功时返回
}

// 聊天请求消息
message ChatMessage {
    string msgType = 1; // "text", "image", "audio", "video", "news", "markdown"
    oneof content {
        TextContent textContent = 2;
        ImageContent imageContent = 3;
        AudioContent audioContent = 4;
        VideoContent videoContent = 5;
        NewsContent newsContent = 6;
        MarkdownContent markdownContent = 7;
    }
}

// 文本消息内容
message TextContent {
    string text = 1; // 文本内容
}

// 图片消息内容
message ImageContent {
    string url = 1;       // 图片URL
    int32 width = 2;      // 图片宽度
    int32 height = 3;     // 图片高度
    string format = 4;    // 图片格式,如 "png", "jpg"
}

// 音频消息内容
message AudioContent {
    string url = 1;       // 音频URL
    int32 duration = 2;   // 音频时长,单位秒
    string format = 3;    // 音频格式,如 "mp3"
}

// 视频消息内容
message VideoContent {
    string url = 1;           // 视频URL
    int32 duration = 2;       // 视频时长,单位秒
    string thumbnail = 3;     // 缩略图URL
    string format = 4;        // 视频格式,如 "mp4"
}

// 新闻消息内容
message NewsContent {
    string title = 1;       // 新闻标题
    string description = 2; // 新闻描述
    string url = 3;         // 新闻链接
    string image = 4;       // 新闻图片URL
}

// Markdown消息内容
message MarkdownContent {
    string markdown = 1; // Markdown格式的文本
}

// 聊天响应消息
message ChatResponse {
    int32 status = 1;    // 1: 成功, 其他: 错误代码
    string message = 2;  // 描述信息
    string id = 3;       // 服务器生成的唯一消息ID(雪花ID)
}

// 心跳消息
message HeartbeatMessage {
    bytes hbbyte = 1; // 心跳字节数据
}

// 关闭、退出消息
message CloseMessage {
    // 无额外字段
}

// 关闭响应消息
message CloseResponse {
    int32 status = 1;    // 1: 成功, 其他: 错误代码
    string message = 2;  // 描述信息
}

// 获取用户信息请求消息
message GetUserMessage {
    string userId = 1;    // type为0时必填
    string groupId = 2;   // type为1时必填
    int32 type = 3;       // 0: 获取好友信息, 1: 获取指定组信息, 2: 获取所有在线用户, 3: 获取所有用户
}

// 获取用户信息响应消息
message GetUserResponse {
    repeated UserInfo users = 1; // 用户信息列表
}

// 用户信息结构
message UserInfo {
    string userId = 1;      // 用户ID
    string username = 2;    // 用户名
    string nickname = 3;    // 昵称
    string avatar = 4;      // 头像URL
    int32 status = 5;       // 用户状态,0: 离线, 1: 在线
    // 可根据需求扩展更多字段
}

// 创建群请求消息
message CreateGroupMessage {
    string groupName = 1;          // 群名称
    repeated string members = 2;    // 初始成员列表(可选)
    string description = 3;        // 群描述
}

// 创建群响应消息
message CreateGroupResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
    string groupId = 3;     // 新创建的群ID
}

// 解散群请求消息
message DisbandGroupMessage {
    string groupId = 1; // 群ID
}

// 解散群响应消息
message DisbandGroupResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
}

// 邀请加入群请求消息
message InviteToGroupMessage {
    string groupId = 1;               // 群ID
    repeated string invitees = 2;     // 被邀请者ID列表
}

// 邀请加入群响应消息
message InviteToGroupResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
}

// 加入群请求消息
message JoinGroupMessage {
    string groupId = 1; // 群ID
}

// 加入群响应消息
message JoinGroupResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
}

// 退出群请求消息
message LeaveGroupMessage {
    string groupId = 1; // 群ID
}

// 退出群响应消息
message LeaveGroupResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
}

// 屏蔽群请求消息
message MuteGroupMessage {
    string groupId = 1; // 群ID
    bool mute = 2;      // true: 屏蔽, false: 取消屏蔽
}

// 屏蔽群响应消息
message MuteGroupResponse {
    int32 result = 1;       // 1: 成功, 其他: 错误代码
    string message = 2;     // 描述信息
}

// 群发消息请求消息
message GroupChatMessage {
    string msgType = 1; // "text", "image", "audio", "video", "news", "markdown"
    oneof content {
        TextContent textContent = 2;
        ImageContent imageContent = 3;
        AudioContent audioContent = 4;
        VideoContent videoContent = 5;
        NewsContent newsContent = 6;
        MarkdownContent markdownContent = 7;
    }
}

// 群发消息响应消息
message GroupChatResponse {
    int32 status = 1;    // 1: 成功, 其他: 错误代码
    string message = 2;  // 描述信息
}
Edit this page
Last Updated:
Contributors: Tong Li
Prev
通讯协议文档
Next
java protobuf