npm 包 webhooked 使用教程

前言

在前端开发中，我们经常会需要将一些事件和动作自动化执行。比如当我们将代码 push 到 GitHub 或者 GitLab 仓库时，自动触发代码构建和部署。

在这种情况下，我们可以使用 webhook 来实现让服务器自动处理事件。本文将带您深入浅出地介绍 npm 包 webhooked，并提供使用教程以及示例代码。

什么是 webhooked？

Webhooked 是一个基于 Node.js 的 npm 包，它能够帮助我们更容易地使用 webhook，自动执行一些任务。

Webhook 可以被理解为一种建立起服务器和第三方服务之间联系的方法。当触发条件满足时，Webhook 可以发送一个 HTTP POST 请求，将最新的数据推送给服务器。

在实际操作中，我们可以使用 Webhooked 将 Webhook 方便地加入到我们的 Node.js 应用程序中。

使用方式

安装

在使用 Webhooked 之前，我们需要先进行安装。在命令行中输入以下命令：

npm install webhooked --save

这样，我们就成功地将 Webhooked 添加到了项目的依赖中。

创建 Webhook

在上一步中，我们已经安装了 Webhooked，接下来我们需要创建一个 Webhook 实例。

const webhooked = require('webhooked');
const webhook = webhooked.create();

配置路由

接下来，我们需要设置路由来接收 Webhook。这里，我们使用 Express 来创建路由：

// 配置 Express 路由
app.post('/webhook-endpoint', webhook.listener((event, actions) => {
  console.log('Event type:', event.get('x-github-event'));
}));

当有 HTTP POST 请求到达 /webhook-endpoint 路由，Webhooked 将解析请求体并根据 x-github-event 首部类型将该请求作为向该事件处理程序发送的事件处理程序。

设置 Action

在许多情况下，Webhook 会在触发时需要执行多个操作。在 Webhooked 中，我们可以使用 Action 链来定义一个由多个操作组成的任务。

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

在 Action 链中，每个操作都是通过 then() 方法来定义的。每次链式的 then() 完成时，Webhooked 将执行下一个 then()。

触发 Webhook

最后一步是触发 Webhook。当调用 Webhooked 实例的 trigger() 方法时，Webhook 将按照配置信息，在路由处发送一个 HTTP POST 请求。这可以用于模拟 Webhook，以确保我们的路由和处理程序正在正确运行。

webhook.trigger('activity.webhooked');

完整代码示例

以下是一个完整的代码示例。它将推送从 Github 获取的最新提交，并将其发布到控制台。

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

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

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

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

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

总结

本文介绍了 npm 包 Webhooked 的使用方式，从安装插件开始，到配置和触发 Webhook，最后给出了一个完整代码示例。希望本文可以帮助您更好地理解和使用 Webhook，自动化您的工作流程。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/6005549e81e8991b448d1dab