GitLab 是目前最流行的开源代码托管平台之一，而 GitLab 的 webhooks 可以让我们通过网络事件来触发一些事件，例如构建、部署等等。而 hapi-gitlab-webhooks 是一个 npm 包，可以轻松地监听 GitLab 的 webhook 事件并及时作出反应。本文将介绍如何使用 hapi-gitlab-webhooks 进行开发以及如何将其应用在实际项目中。
什么是 hapi-gitlab-webhooks？
hapi-gitlab-webhooks 是一个基于 Node.js 平台以及 hapi 框架的 npm 包，它能够监听 GitLab 的 webhook 请求并反馈响应。通过使用 hapi-gitlab-webhooks，我们可以非常方便地捕捉 GitLab 的 webhook 请求，并实现我们所需要的业务逻辑。
安装 hapi-gitlab-webhooks
安装 hapi-gitlab-webhooks 相对而言比较简单，只需在命令行中运行以下命令即可：
npm install hapi-gitlab-webhooks --save
使用 hapi-gitlab-webhooks
使用 hapi-gitlab-webhooks 的过程非常简单，只需要引入相应的模块、配置监听路由并监听 GitLab 传入的 webhook 请求即可。
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ------------------ - -------------------------------- ----- ------ - --- -------------- ------------------- ----- ---- --- ----- -------- - --------------------------- ----- ------ - ----------------- -- -- ------ ---- -------- -- -- --- -- --- -------------- ------- ------- ----- ------------ -------- -------- --- --------------------- -- - ------------------- ------- ----- ----------------- ---
在如上代码中，我们监听了 POST /webhooks 路由，并在该路由下定义了 listener。当 GitLab 传入 webhook 请求时，listener 将被调用，并将 GitLab 请求内容（JavaScript 对象）作为参数传入。我们可以在 listener 中实现我们所需的业务逻辑。
示例代码
为了方便起见，我们将使用 Express 框架来编写一个简单的 webhook 示例应用。
当 GitLab 发送 webhook 请求时，我们将监听到该请求，并通过 Express 应用返回一个特定的响应内容。
首先，我们来配置 Express 应用及 hapi-gitlab-webhooks：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------------------ - -------------------------------- ----- --- - ---------- ----- ---- - ----- ----- -------- - --------------------------- ----- ------ - ----------------- -- -- ------ ---- ------- ------- ---- --- -- -- --- -------- - --------- ---- - ---
在代码中，我们定义了一个 Express 应用，并配置端口号、listener、以及实现 listener 中我们所需要的业务逻辑。
接下来，我们来配置监听路由。
app.post('/webhooks', listener);在如上代码中，我们定义了 POST /webhooks 路由，并将 listener 作为 handler 值传递给该路由。
最后，我们启动 Express 应用，并监听指定的端口。
app.listen(PORT, function () {
console.log(`Server running at: http://localhost:${PORT}`);
});完整的示例代码如下所示：
-- -------------------- ---- ------- ----- ------- - ------------------- ----- ------------------ - -------------------------------- ----- --- - ---------- ----- ---- - ----- ----- -------- - --------------------------- ----- ------ - ----------------- -- -- ------ ---- ------- ------- ---- --- -- -- --- -------- - --------- ---- - --- -- ------ --------------------- ---------- -- -- ------- -- ---------------- -------- -- - ------------------- ------- --- --------------------------- ---
总结
hapi-gitlab-webhooks 是一个功能强大的 npm 包，可以让我们非常方便地实现 GitLab 的 webhook 监听以及相应的业务逻辑。使用 hapi-gitlab-webhooks 编写代码的过程非常简单，只需引入相应模块并编写 listener 即可，同时该 npm 包可以方便地应用在各种类型的项目中。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600574d581e8991b448ea299