NPM 包 Telegraf 使用教程

阅读时长 6 分钟读完

介绍

Telgraf 是一个 Node.js 框架,用于构建 Telegram 机器人的服务器端应用程序。它提供了简单易用的 API 接口,支持许多功能如命令和中间件。另外,Telgraf 还支持多种语言,包括 JavaScript、TypeScript、Python 和 Java 等。

本文将会详细介绍如何使用 Telgraf,包括安装、配置、命令和中间件等方面。为了更好的理解,我们同时提供了一些详细的代码示例。

安装

首先,我们需要在本地机器上安装 Node.js 和 NPM。如果您还没有安装,可以到 Node.js 官网 下载最新版本。

在安装了 Node.js 和 NPM 之后,我们可以使用以下命令来安装 Telgraf:

配置

在安装了 Telgraf 之后,我们需要创建一个新文件,命名为 bot.js。在该文件中,我们首先需要引入 Telgraf 包并创建一个新的实例:

其中,YOUR_TELEGRAM_BOT_TOKEN 是您的 Telegram 机器人的访问令牌。如果您还没有创建机器人,请到 Telegram 官网查看 如何创建 Telegram 机器人的指南

有了机器人实例之后,我们就可以开始为机器人添加自定义命令和中间件了。下面我们将详细介绍如何添加命令和中间件。

命令

命令是 Telegram 机器人中最常用的功能之一。它可以让用户通过键入指定的命令来触发机器人执行特定的任务。在 Telgraf 中,我们可以通过以下方式来添加命令:

在这个示例中,我们首先使用 bot.command 方法来添加一个新的命令,该命令的名称为 start。紧接着,我们为命令指定一个回调函数(在这里是匿名函数),该函数接受一个上下文参数 ctx。在回调函数中,我们使用 ctx.reply 方法发送一条简单的文本回复。

我们可以为机器人添加多个命令。例如:

中间件

中间件是 Telgraf 中一个强大的功能。它可以让您在处理命令或其他事件之前或之后执行某些操作,如日志记录、验证用户身份、处理异常等等。在 Telgraf 中,我们可以通过以下方式来添加中间件:

-- -------------------- ---- -------
------------- ----- -- -
  ----------------------- -------------------
  ------
--

------------- ----- -- -
  -- --------------------------------- --- -------- -
    ------
  - ---- -
    ----------------- --- --- --- ---------- -- ------ ---- ------
  -
--

在这个示例中,我们首先使用 bot.use 方法来添加两个不同的中间件。其中第一个中间件用于记录日志,我们可以通过 console.log 方法来打印出更新对象(即 ctx.update)中包含的消息。第二个中间件用于验证用户身份,在这里我们仅允许用户名为 admin 的用户访问机器人,而其他任何人都将收到一条“未授权”的回复消息。

消息处理

除了命令和中间件之外,Telgraf 还支持处理各种不同的 Telegram 消息,如文本、图片、文件等等。我们可以通过以下方式来处理消息:

-- -------------------- ---- -------
----------------- ----- -- -
  ----- ------- - ------------------

  -- ------------- --- ----- -
    -------------------
  - ---- -- --------------- -
    --------------- --------
  -
--

在这个示例中,我们使用 bot.on 方法来添加一个新的消息处理程序。我们指定处理器以响应 message 类型的更新,并在处理程序中检查消息的内容以根据消息类型执行不同的操作。在这里,我们检查文本消息中是否包含“hi”字样,并在图片消息中发送“Nice photo!”回复。

启动

最后,我们需要调用 bot.launch() 方法来启动机器人,并让其开始监听来自 Telegram 的更新:

在启动后,我们通过 console.log 方法输出一条消息来指示机器人已启动并正在运行。

完整示例

以下是完整的 bot.js 示例代码:

-- -------------------- ---- -------
----- -------- - -------------------
----- --- - --- -----------------------------------

-------------------- ----- -- -
  ---------------- --------
--

------------------- ----- -- -
  --------------- -------
--

----------------------- ----- -- -
  --------------- --- --- -------------
--

------------- ----- -- -
  ----------------------- -------------------
  ------
--

------------- ----- -- -
  -- --------------------------------- --- -------- -
    ------
  - ---- -
    ----------------- --- --- --- ---------- -- ------ ---- ------
  -
--

----------------- ----- -- -
  ----- ------- - ------------------

  -- ------------- --- ----- -
    -------------------
  - ---- -- --------------- -
    --------------- --------
  -
--

------------
---------------- -- -- --- ----------

结论

在本文中,我们详细介绍了如何使用 Telgraf 在 Node.js 中构建 Telegram 机器人应用程序。通过使用命令、中间件和消息处理等功能,我们可以轻松地构建出完整的机器人应用,以便与 Telegram 用户交互。同时,Telgraf 还提供了丰富的文档和 API 文档,以便更深入地了解其功能和用法。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/89771