npm 包 whateverhook 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

whateverhook 是一个 npm 包，它是一个便于使用的 webhook 工具，方便你在使用 git 时快速地触发某些操作，比如在代码提交后触发自动构建、部署等操作。whateverhook 提供了一个简单易用的 API，可以帮助你快速创建和维护 webhook，无论是在个人项目还是企业项目中都非常适用。

安装

whateverhook 是一个 npm 包，你可以使用 npm 或者 yarn 安装：

npm install whateverhook

或者

yarn add whateverhook

使用教程

导入 whateverhook 依赖

const Webhook = require("whateverhook");

创建 Webhook 实例，传入配置对象
```
const config = {
  port: 5000,
  events: ["push"],
  handler: function(payload) {
    console.log("Received push event: ", payload);
  }
};
const webhook = new Webhook(config);
```
这个配置非常简单，我们只需要给定 webhook 服务监听的端口号、触发事件的类型以及回调函数，即 handler。在这个例子中，我们仅仅是将收到的 push 事件进行了简单的输出。
启动服务
```
webhook.start(() => {
  console.log(`Server running on port ${config.port}`);
});
```
通过调用 start 方法启动 webhook 服务，启动后就可以监听配置的端口号上的请求。可以同时启动多个 webhook 服务。
在 git 仓库中添加 webhook

在需要添加 webhook 的 git 仓库中，找到 webhook 配置页面，一般在 repo 的 Settings -> Webhooks 中可以找到。在这里添加新的 webhook，需要提供 webhook URL，这个 URL 可以在启动 webhook 服务后得到，URL 的基本格式为 http://yourip:yourport。

然后，选择该 webhook 关注的事件类型，whateverhook 支持多种事件触发，包括 push、pull_request、deployment 等。如果要同时关注多个事件，可以用数组形式传入。

至此，你已经完成了一个简单的使用 whateverhook 的 demo，你可以通过任意一个 commit 操作来测试你刚刚部署的 webhook。

深度和学习意义

Webhook 的原理和基本使用相对简单，但是在应用中有很多值得思考的场景和问题，比如：

什么时候触发 webhook 更加合适？

在项目中，有很多操作我们都可以通过 webhook 来完成，包括自动测试、自动构建、自动部署等等。但是，我们需要思考一下在哪些场景下使用 webhook 更加合适呢？

对于分支比较少的项目，可以选择在每次代码提交时触发 webhook；对于分支较多的项目，可以选择在 release 或者特定分支提交时触发 webhook。总之，根据实际情况来确定触发 webhook 的时间点更加合适。
webhook 的安全问题

webhook 在项目中承担着不可忽视的重要角色，也因此成为了黑客攻击的一种重要方式。我们需要思考怎么保证 webhook 的安全性，比如使用 SSL、payload 验证等方式来增加安全性。
如何将 webhook 集成到 CI/CD 流程中

webhook 与自动化 CI/CD 流程结合使用可以大大提高我们的代码开发效率，在实际使用中，需要思考如何将 webhook 触发的动作结合到 CI/CD 流程中，以期实现自动化部署、自动化构建、自动化测试等操作。

这些问题都是在使用 webhook 的过程中需要考虑的问题，可以帮助我们更加深入地了解 webhook 的实际作用和使用场景。

示例代码

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

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

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

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

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