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

增加命令菜单

引言

本文档旨在指导开发者如何为 Telegram 机器人添加命令菜单,以提升用户交互体验。通过详细的代码示例和解释,读者将学习如何使用 BotFather 或通过编程方式动态管理机器人命令菜单。本文还介绍了如何过滤命令消息以及封装路由,以实现更灵活和可维护的机器人功能。

增加命令菜单

为机器人增加命令菜单有两种主要方式:

  • 通过 BotFather
  • 通过 代码

通过 BotFather 增加菜单

  • /mybots
  • 选择机器人
  • Edit Bot
  • Edit Commands 发送下面的消息
start - 首页

通过代码增加命令菜单

以下代码示例演示了如何通过编程方式为 Telegram 机器人设置和删除命令菜单。通过这种方法,可以在运行时动态管理机器人的命令,提供更大的灵活性。

package com.litongjava.gpt.translator.config;

import java.nio.file.Path;
import java.time.Duration;
import java.util.List;
import java.util.function.Function;

import com.litongjava.annotation.AConfiguration;
import com.litongjava.annotation.Initialization;
import com.litongjava.gpt.translator.client.TelegramClient;
import com.litongjava.gpt.translator.predicate.UserMessagePredicate;
import com.litongjava.gpt.translator.telegram.adapter.MyBotEventAdapter;
import com.litongjava.gpt.translator.telegram.function.TranslateFunction;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.utils.environment.EnvUtils;

import lombok.extern.slf4j.Slf4j;
import reactor.util.retry.Retry;
import telegram4j.core.MTProtoBootstrap;
import telegram4j.core.MTProtoTelegramClient;
import telegram4j.core.event.domain.message.SendMessageEvent;
import telegram4j.core.spec.BotCommandScopeSpec;
import telegram4j.mtproto.RpcException;
import telegram4j.mtproto.store.FileStoreLayout;
import telegram4j.mtproto.store.StoreLayoutImpl;
import telegram4j.tl.BotCommand;
import telegram4j.tl.ImmutableBotCommand;

@Slf4j
@AConfiguration
public class TelegramTranslateBot {

  @Initialization
  public void config() {
    // 从环境变量获取 Telegram API 配置信息
    int apiId = EnvUtils.getInt("telegram.api.id");
    String apiHash = EnvUtils.getStr("telegram.api.hash");
    String botAuthToken = EnvUtils.getStr("telegram.bot.auth.token");

    String botId = botAuthToken.split(":")[0];
    // 创建并连接 MTProto Telegram 客户端
    MTProtoBootstrap bootstrap = MTProtoTelegramClient.create(apiId, apiHash, botAuthToken);

    StoreLayoutImpl storeLayoutImpl = new StoreLayoutImpl(Function.identity());
    FileStoreLayout storeLayout = new FileStoreLayout(storeLayoutImpl, Path.of("t4j-bot_" + botId + ".bin"));
    bootstrap.setStoreLayout(storeLayout);

    MTProtoTelegramClient client = bootstrap.connect().block();
    if (client == null) {
      log.error("Failed to connect to Telegram MTProto client.");
      return;
    }
    log.info("Telegram MTProto client connected.");

    //deleteCommand(client);
    setCommand(client);

    // 获取自己的id
    long selfId = client.getSelfId().asLong();
    log.info("self id:{}", selfId);

    // 配置事件监听器:接收 SendMessageEvent,过滤用户消息,并应用翻译功能
    client.on(SendMessageEvent.class)
        //
        .filter(new UserMessagePredicate(selfId)::test).flatMap(new TranslateFunction()::apply)
        //
        .delayElements(Duration.ofSeconds(1)) // 每秒最多发送一条消息
        //
        .doOnError(e -> log.error("处理消息时发生错误", e))
        //
        .retryWhen(Retry.backoff(5, Duration.ofSeconds(1)).filter(e -> e instanceof RpcException))
        //
        .subscribe();

    client.on(new MyBotEventAdapter()).subscribe();

    TelegramClient.client = client;

    // 防止主线程阻塞,监控客户端断开连接
    //    TioThreadUtils.submit(() -> {
    //      client.onDisconnect().block();
    //      log.info("Telegram client disconnected.");
    //    });

    // 在服务器关闭时,断开 Telegram 客户端连接
    HookCan.me().addDestroyMethod(client::disconnect);


  }

  private void deleteCommand(MTProtoTelegramClient client) {
    client.resetCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "")
        //
        .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
        //
        .doOnSuccess(v -> log.info("Commands successfully deleted!"))
        //
        .doOnError(e -> log.error("Failed to delete commands.", e)).block();
  }

  private void setCommand(MTProtoTelegramClient client) {
    BotCommand startCommand = ImmutableBotCommand.of("start", "Start using the bot");
    BotCommand aboutCommand = ImmutableBotCommand.of("about", "About this bot");

    List<BotCommand> commands = List.of(startCommand, aboutCommand);

    client.setCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "", commands)
        //
        .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
        //
        .doOnSuccess(v -> log.info("Commands successfully set!"))
        //
        .doOnError(e -> log.error("Failed to set commands.", e)).block();
  }
}

上面的代码演示了如何通过代码增加命令菜单,增加完成后显示如下:

命令菜单演示

在上述代码中,TelegramTranslateBot 类通过代码方式为 Telegram 机器人设置和删除命令菜单。下面将详细解释 setCommand 和 deleteCommand 两个方法的实现及其工作原理。

通过代码增加命令菜单 代码解释

setCommand 方法

功能

setCommand 方法用于为机器人设置命令菜单。在本例中,设置了两个命令:/start 和 /about,分别对应“开始使用机器人”和“关于此机器人”的描述。设置菜单时无需在命令前添加斜杠("/"),只需直接添加命令即可。菜单设置一次后,只要不删除,即可永久有效。

代码解析

private void setCommand(MTProtoTelegramClient client) {
    BotCommand startCommand = ImmutableBotCommand.of("start", "Start using the bot");
    BotCommand aboutCommand = ImmutableBotCommand.of("about", "About this bot");

    List<BotCommand> commands = List.of(startCommand, aboutCommand);

    client.setCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "", commands)
        //
        .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
        //
        .doOnSuccess(v -> log.info("Commands successfully set!"))
        //
        .doOnError(e -> log.error("Failed to set commands.", e)).block();
}

详细说明

  1. 定义命令

    BotCommand startCommand = ImmutableBotCommand.of("start", "Start using the bot");
    BotCommand aboutCommand = ImmutableBotCommand.of("about", "About this bot");
    
    • 使用 ImmutableBotCommand.of 方法创建两个不可变的 BotCommand 对象,分别代表 /start 和 /about 命令,并为其添加描述。
  2. 创建命令列表

    List<BotCommand> commands = List.of(startCommand, aboutCommand);
    
    • 将上述两个命令添加到一个 List 中,以便一次性设置多个命令。
  3. 设置命令

    client.setCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "", commands)
    
    • 调用 client.setCommands 方法,将命令列表应用到默认范围 (BotCommandScopeSpec.Type.DEFAULT)。
    • 第二个参数为空字符串,表示不使用特定的语言环境。
  4. 重试机制

    .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
    
    • 使用 Reactor 的 retryWhen 操作符,配置在失败时进行重试,最多重试 3 次,每次重试之间间隔 2 秒。
  5. 日志记录

    .doOnSuccess(v -> log.info("Commands successfully set!"))
    .doOnError(e -> log.error("Failed to set commands.", e))
    
    • 成功设置命令后,记录成功日志。
    • 如果设置失败,记录错误日志。
  6. 阻塞等待

    .block();
    
    • 阻塞当前线程,直到命令设置操作完成。这在初始化阶段确保命令已经设置完毕。

deleteCommand 方法

功能

deleteCommand 方法用于删除机器人当前的所有命令菜单。这在需要重置命令或移除现有命令时使用。

代码解析

private void deleteCommand(MTProtoTelegramClient client) {
    client.resetCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "")
        //
        .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
        //
        .doOnSuccess(v -> log.info("Commands successfully deleted!"))
        //
        .doOnError(e -> log.error("Failed to delete commands.", e)).block();
}

详细说明

  1. 重置命令

    client.resetCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "")
    
    • 调用 client.resetCommands 方法,针对默认范围 (BotCommandScopeSpec.Type.DEFAULT) 重置命令。
    • 第二个参数为空字符串,表示不使用特定的语言环境。
  2. 重试机制

    .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
    
    • 类似于 setCommand 方法,配置在失败时进行最多 3 次重试,每次间隔 2 秒。
  3. 日志记录

    .doOnSuccess(v -> log.info("Commands successfully deleted!"))
    .doOnError(e -> log.error("Failed to delete commands.", e))
    
    • 成功删除命令后,记录成功日志。
    • 如果删除失败,记录错误日志。
  4. 阻塞等待

    .block();
    
    • 阻塞当前线程,直到命令删除操作完成。

注意事项

  • 在 config 方法中,deleteCommand(client); 被注释掉了。这意味着默认情况下不会删除现有命令,只有在需要重置命令时才会启用该方法。
  • 使用阻塞操作 (block()) 在初始化阶段是合理的,但在其他上下文中应谨慎使用,以避免阻塞非阻塞式应用的执行流程。

总结

通过 setCommand 和 deleteCommand 方法,TelegramTranslateBot 类实现了通过代码方式动态管理 Telegram 机器人的命令菜单。这种方法相比使用 BotFather 更加灵活,适用于需要在运行时动态调整命令的场景。此外,代码中采用了重试机制和日志记录,增强了系统的健壮性和可维护性。

过滤命令消息

在上述代码中,我们增加了 SendMessageEvent 和 MyBotEventAdapter 的监听。当消息发送到本程序时,MyBotEventAdapter 和 SendMessageEvent 对应的监听器都会处理消息。为了避免处理命令消息,我们在 UserMessagePredicate 中增加了过滤逻辑。命令消息的 entities 类型为 MessageEntityBotCommand。

以下是命令消息的日志示例:

SendMessageEvent{
	message=Message{data=Variant2{t1=BaseMessage#38116ee0{flags=10000000, id=1822, fromId=null, peerId=PeerUser#59511722{userId=my_chat_id}, fwdFrom=null, viaBotId=null, replyTo=null, date=1733760693, message='/start', media=null, replyMarkup=null,

		entities=[MessageEntityBotCommand#6cef8ac7{offset=0, length=6}], views=null, forwards=null, replies=null, editDate=null, postAuthor='null', groupedId=null, reactions=null, restrictionReason=null, ttlPeriod=null}}},

	chat=PrivateChat{user=User{minData=BaseUser#abb5f120{flags=10010000000000000001101011, flags2=10000, id=my_chat_id, accessHash=-6745242867060598026, firstName='苏里南', lastName='null', username='xpankou', phone='null', photo=BaseUserProfilePhoto#82d1f706{flags=0, photoId=5129962608709971087, strippedThumb=null, dcId=1}, status=UserStatusRecently#e26f42f1{}, botInfoVersion=null, restrictionReason=null, botInlinePlaceholder='null', langCode='zh-hans', emojiStatus=null, usernames=null, storiesMaxId=null}, fullData=null}, selfUser=User{minData=BaseUser#abb5f120{flags=10000010001100010000001011, flags2=10010, id=7847170133, accessHash=-4262855346709871929, firstName='my-translator', lastName='null', username='litongjava_bot', phone='null', photo=null, status=null, botInfoVersion=3, restrictionReason=null, botInlinePlaceholder='Search...', langCode='null', emojiStatus=null, usernames=null, storiesMaxId=null}, fullData=null}},

	author=User{minData=BaseUser#abb5f120{flags=10010000000000000001101011, flags2=10000, id=my_chat_id, accessHash=-6745242867060598026, firstName='苏里南', lastName='null', username='xpankou', phone='null', photo=BaseUserProfilePhoto#82d1f706{flags=0, photoId=5129962608709971087, strippedThumb=null, dcId=1}, status=UserStatusRecently#e26f42f1{}, botInfoVersion=null, restrictionReason=null, botInlinePlaceholder='null', langCode='zh-hans', emojiStatus=null, usernames=null, storiesMaxId=null}, fullData=null}
}

UserMessagePredicate 类

package com.litongjava.gpt.translator.predicate;

import java.util.List;
import java.util.Optional;
import java.util.function.Predicate;

import lombok.extern.slf4j.Slf4j;
import telegram4j.core.event.domain.message.SendMessageEvent;
import telegram4j.core.object.MentionablePeer;
import telegram4j.core.object.Message;
import telegram4j.core.object.MessageEntity;
import telegram4j.core.object.chat.Chat;

@Slf4j
public class UserMessagePredicate implements Predicate<SendMessageEvent> {
  private long botId;

  public UserMessagePredicate(long selfId) {
    this.botId = selfId;
  }

  @Override
  public boolean test(SendMessageEvent event) {
    // log.info("e:{}", event);

    Optional<MentionablePeer> optionalAuthor = event.getAuthor();
    Optional<Chat> optionalChat = event.getChat();
    // 防止机器人处理自己发送的消息
    // 如果消息的发送者信息不存在,说明可能是机器人自身发送的消息,忽略
    if (optionalAuthor.isEmpty()) {
      log.info("消息发送者信息缺失,可能是机器人自身发送的消息。");
      return false;
    }
    if (optionalChat.isEmpty()) {
      log.info("消息信息缺失,可能是机器人自身发送的消息。");
      return false;
    }
    long messageAuthorId = optionalAuthor.get().getId().asLong();
    if (botId == messageAuthorId) {
      log.info("获取到机器人的消息");
      return false;
    }
    Message message = event.getMessage();
    String content = message.getContent();
    List<MessageEntity> entities = message.getEntities();
    for (MessageEntity messageEntity : entities) {
      if (messageEntity.getType() == MessageEntity.Type.BOT_COMMAND && messageEntity.getContent().equals(content)) {
        log.info("不处理命令");
        return false;
      }
    }

    return true;
  }
}

封装路由

TelegramCommandUtils

package com.litongjava.gpt.translator.telegram.common;

import java.util.List;
import java.util.Optional;

import telegram4j.core.object.Message;
import telegram4j.core.object.MessageEntity;

public class TelegramCommandUtils {
  public static Optional<ParsedCommand> parseCommand(Message message) {

    List<MessageEntity> entities = message.getEntities();
    for (MessageEntity entity : entities) {
      if (entity.getType() == MessageEntity.Type.BOT_COMMAND) {
        String commandWithArgs = message.getContent().substring(entity.getOffset(), entity.getOffset() + entity.getLength());
        String[] parts = commandWithArgs.split(" ", 2);
        String command = parts[0].substring(1);
        String args = parts.length > 1 ? parts[1] : "";
        return Optional.of(new ParsedCommand(command, args));
      }
    }
    return Optional.empty();
  }
}

ParsedCommand

package com.litongjava.gpt.translator.telegram.common;
public class ParsedCommand {
  private final String command;
  private final String args;

  public ParsedCommand(String command, String args) {
    this.command = command;
    this.args = args;
  }

  public String getCommand() { return command; }
  public String getArgs() { return args; }
}

TelegramCommandRouter

package com.litongjava.gpt.translator.telegram.common;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;

import org.reactivestreams.Publisher;

import telegram4j.core.event.domain.message.SendMessageEvent;
import telegram4j.tl.BotCommand;
import telegram4j.tl.ImmutableBotCommand;

public class TelegramCommandRouter {
  public static List<BotCommand> botCommands = new ArrayList<>();
  public static Map<String, Function<SendMessageEvent, Publisher<?>>> mappings = new ConcurrentHashMap<>();

  public static void add(String command, String descripton, Function<SendMessageEvent, Publisher<?>> function) {
    botCommands.add(ImmutableBotCommand.of(command, descripton));
    mappings.put(command, function);
  }

  public static Function<SendMessageEvent, Publisher<?>> find(String command) {
    return mappings.get(command);
  }
}

TelegramCommandDispatcher

package com.litongjava.gpt.translator.telegram.common;

import java.util.function.Function;

import org.reactivestreams.Publisher;

import lombok.extern.slf4j.Slf4j;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Schedulers;
import telegram4j.core.event.domain.message.SendMessageEvent;

@Slf4j
public class TelegramCommandDispatcher {
  public static Publisher<?> dispatch(String command, SendMessageEvent event) {
    Function<SendMessageEvent, Publisher<?>> function = TelegramCommandRouter.find(command);
    if (function != null) {
      return Mono.from(function.apply(event))
          //
          .subscribeOn(Schedulers.boundedElastic())
          //
          .doOnSuccess(v -> log.info("执行命令: " + command))
          //
          .doOnError(e -> log.error("执行命令时出错: " + command, e))
          //
          .onErrorResume(e -> Mono.empty());
    }
    return Mono.empty();
  }
}

使用 MyBotEventAdapter 处理所有消息和添加命令

配置 TelegramTranslateBot

以下代码展示了如何使用 MyBotEventAdapter 处理所有消息,并通过封装的路由添加命令。

package com.litongjava.gpt.translator.config;

import java.nio.file.Path;
import java.time.Duration;
import java.util.function.Function;

import com.litongjava.annotation.AConfiguration;
import com.litongjava.annotation.Initialization;
import com.litongjava.gpt.translator.client.TelegramClient;
import com.litongjava.gpt.translator.telegram.adapter.MyBotEventAdapter;
import com.litongjava.gpt.translator.telegram.common.TelegramCommandRouter;
import com.litongjava.gpt.translator.telegram.function.AboutUsCommandFunction;
import com.litongjava.gpt.translator.telegram.function.StartCommandFunction;
import com.litongjava.tio.boot.server.TioBootServer;
import com.litongjava.tio.utils.environment.EnvUtils;

import lombok.extern.slf4j.Slf4j;
import reactor.util.retry.Retry;
import telegram4j.core.MTProtoBootstrap;
import telegram4j.core.MTProtoTelegramClient;
import telegram4j.core.spec.BotCommandScopeSpec;
import telegram4j.mtproto.RpcException;
import telegram4j.mtproto.store.FileStoreLayout;
import telegram4j.mtproto.store.StoreLayoutImpl;

@Slf4j
@AConfiguration
public class TelegramTranslateBot {

  @Initialization
  public void config() {
    // 从环境变量获取 Telegram API 配置信息
    int apiId = EnvUtils.getInt("telegram.api.id");
    String apiHash = EnvUtils.getStr("telegram.api.hash");
    String botAuthToken = EnvUtils.getStr("telegram.bot.auth.token");

    String botId = botAuthToken.split(":")[0];
    // 创建并连接 MTProto Telegram 客户端
    MTProtoBootstrap bootstrap = MTProtoTelegramClient.create(apiId, apiHash, botAuthToken);

    StoreLayoutImpl storeLayoutImpl = new StoreLayoutImpl(Function.identity());
    FileStoreLayout storeLayout = new FileStoreLayout(storeLayoutImpl, Path.of("t4j-bot_" + botId + ".bin"));
    bootstrap.setStoreLayout(storeLayout);

    MTProtoTelegramClient client = bootstrap.connect().block();
    if (client == null) {
      log.error("Failed to connect to Telegram MTProto client.");
      return;
    }
    log.info("Telegram MTProto client connected.");

    //deleteCommand(client);
    setCommand(client);

    // 获取自己的id
    long selfId = client.getSelfId().asLong();
    log.info("self id:{}", selfId);
    client.on(new MyBotEventAdapter(selfId))
        //
        .delayElements(Duration.ofSeconds(1)) // 每秒最多发送一条消息
        //
        .doOnError(e -> log.error("处理消息时发生错误", e))
        //
        .retryWhen(Retry.backoff(5, Duration.ofSeconds(1)).filter(e -> e instanceof RpcException))
        //
        .subscribe();

    TelegramClient.client = client;

    // 防止主线程阻塞,监控客户端断开连接
    //    TioThreadUtils.submit(() -> {
    //      client.onDisconnect().block();
    //      log.info("Telegram client disconnected.");
    //    });

    // 在服务器关闭时,断开 Telegram 客户端连接
    HookCan.me().addDestroyMethod(client::disconnect);

  }

  private void deleteCommand(MTProtoTelegramClient client) {
    client.resetCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "")
        //
        .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
        //
        .doOnSuccess(v -> log.info("Commands successfully deleted!"))
        //
        .doOnError(e -> log.error("Failed to delete commands.", e)).block();
  }

  private void setCommand(MTProtoTelegramClient client) {
    TelegramCommandRouter.add("start", "Start using the bot", new StartCommandFunction()::apply);
    TelegramCommandRouter.add("about", "About this bot", new AboutUsCommandFunction()::apply);

    client.setCommands(BotCommandScopeSpec.of(BotCommandScopeSpec.Type.DEFAULT), "", TelegramCommandRouter.botCommands)
        //
        .retryWhen(Retry.backoff(3, Duration.ofSeconds(2)))
        //
        .doOnSuccess(v -> log.info("Commands successfully set!"))
        //
        .doOnError(e -> log.error("Failed to set commands.", e)).block();
  }
}

MyBotEventAdapter

package com.litongjava.gpt.translator.telegram.adapter;

import java.util.List;
import java.util.Optional;

import org.reactivestreams.Publisher;

import com.litongjava.gpt.translator.services.SendMessageEventService;
import com.litongjava.gpt.translator.telegram.common.ParsedCommand;
import com.litongjava.gpt.translator.telegram.common.TelegramCommandDispatcher;
import com.litongjava.gpt.translator.telegram.common.TelegramCommandUtils;
import com.litongjava.gpt.translator.telegram.function.TelegramMessageDispatcher;
import com.litongjava.jfinal.aop.Aop;

import lombok.extern.slf4j.Slf4j;
import reactor.core.publisher.Mono;
import reactor.core.scheduler.Schedulers;
import telegram4j.core.event.EventAdapter;
import telegram4j.core.event.domain.inline.CallbackQueryEvent;
import telegram4j.core.event.domain.message.SendMessageEvent;
import telegram4j.core.object.MentionablePeer;
import telegram4j.core.object.Message;
import telegram4j.core.object.MessageEntity;
import telegram4j.core.object.chat.Chat;

@Slf4j
public class MyBotEventAdapter extends EventAdapter {

  private long botId;

  public MyBotEventAdapter(long selfId) {
    this.botId = selfId;
  }

  @Override
  public Publisher<?> onSendMessage(SendMessageEvent event) {
    Message message = event.getMessage();
    Optional<MentionablePeer> optionalAuthor = event.getAuthor();
    Optional<Chat> optionalChat = event.getChat();
    //防止机器人处理自己发送的消息
    // 如果消息的发送者信息不存在,说明可能是机器人自身发送的消息,忽略
    if (optionalAuthor.isEmpty()) {
      log.info("消息发送者信息缺失,可能是机器人自身发送的消息。");
      return Mono.empty();
    }
    if (optionalChat.isEmpty()) {
      log.info("消息信息缺失,可能是机器人自身发送的消息。");
      return Mono.empty();
    }
    long messageAuthorId = optionalAuthor.get().getId().asLong();
    if (botId == messageAuthorId) {
      log.info("获取到机人自己的消息");
      return Mono.empty();
    }

    // 火并忘记:异步保存事件
    Mono.fromRunnable(() -> {
      try {
        Aop.get(SendMessageEventService.class).save(event);
      } catch (Exception e) {
        log.error("Failed to save event", e);
      }
    }).subscribeOn(Schedulers.boundedElastic()).subscribe();

    List<MessageEntity> entities = message.getEntities();
    if (entities.size() > 0) {
      for (MessageEntity entity : entities) {
        if (entity.getType() == MessageEntity.Type.BOT_COMMAND) {
          Optional<ParsedCommand> parseCommand = TelegramCommandUtils.parseCommand(message);
          return parseCommand.map(parsed -> TelegramCommandDispatcher.dispatch(parsed.getCommand(), event))
              //
              .orElse(Mono.empty());
        }
      }
    } else {
      // 将 dispatch 调用转为异步 Mono 计算
      return Mono.fromCallable(() -> new TelegramMessageDispatcher().dispatch(event))
          //
          .subscribeOn(Schedulers.boundedElastic())
          //
          .flatMap(publisher -> Mono.from(publisher))
          //
          .onErrorResume(e -> {
            log.error("处理消息时出错", e);
            return Mono.empty();
          });
    }

    return Mono.empty();

  }

  @Override
  public Publisher<?> onCallbackQuery(CallbackQueryEvent event) {
    return super.onCallbackQuery(event);
  }
}

命令函数

StartCommandFunction

package com.litongjava.gpt.translator.telegram.function;

import org.reactivestreams.Publisher;
import reactor.core.publisher.Mono;
import telegram4j.core.event.domain.message.SendMessageEvent;
import telegram4j.core.object.Message;
import telegram4j.core.object.chat.Chat;

public class StartCommandFunction {

  public Publisher<? extends Message> apply(SendMessageEvent event) {
    String welcomeMessage = "🌐 **翻译机器人** 🌐\n\n 这个机器人使用 GPT 技术为您提供高质量的文本翻译服务。欢迎使用翻译机器人!\n\n";

    Mono<Chat> chat = event.getMessage().getChat();
    return chat.flatMap(c -> {
      return c.sendMessage(welcomeMessage);
    });
  }
}

AboutUsCommandFunction

package com.litongjava.gpt.translator.telegram.function;

import org.reactivestreams.Publisher;

import reactor.core.publisher.Mono;
import telegram4j.core.event.domain.message.SendMessageEvent;
import telegram4j.core.object.Message;
import telegram4j.core.object.chat.Chat;

public class AboutUsCommandFunction {

  public Publisher<? extends Message> apply(SendMessageEvent event) {
    String aboutMessage = "**开发者:** Litong Java\n" + "**版本:** 1.0.0\n\n" + "感谢您使用本机器人!";
    Mono<Chat> chat = event.getMessage().getChat();
    return chat.flatMap(c -> {
      return c.sendMessage(aboutMessage);
    });
  }
}

以上配置完成后,命令菜单的显示效果如下:

命令菜单演示

结论

通过本文档的指导,您已经了解了如何通过代码为 Telegram 机器人添加和管理命令菜单,并实现了命令消息的过滤和路由封装。这不仅提升了机器人的功能性和用户体验,还增强了代码的可维护性和扩展性。您可以根据需要进一步扩展命令功能,满足不同的业务需求。

Edit this page
Last Updated:
Contributors: Tong Li
Prev
定时推送
Next
使用 telegram-Client