什么是 Webhook 以及如何有效使用它们

发布于2024-11-07

O Que São Webhooks e Como Utilizá-los Eficientemente

Webhooks 是集成不同系统并实时发送通知的强大工具。它们允许一个应用程序在事件发生时自动通知另一个应用程序，而无需像传统 API 那样不断发出请求来检查是否有新内容。在这篇文章中，我们将了解它们的工作原理、如何配置它们，并且我们将探索使用 Webhook.site 工具的实际示例，该工具有助于 webhooks 的开发和测试。

什么是 Webhook？

简单来说，Webhook 是一种允许服务在事件发生时向特定 URL 发送 HTTP 请求的机制。 Webhook 无需重复查询服务器来检查更改（如使用 API 时发生的情况），而是会在事件发生后立即通知您的应用程序。这节省了时间和资源，使系统之间的交互更加高效。

使用 Webhook 的一个典型示例是支付服务：当交易完成时，系统会向您的应用程序发送一个 Webhook，通知您付款状态。从那里，您的应用程序可以处理这些信息，例如更新订单状态、通过电子邮件发送收据等。

Webhooks 如何工作？

Webhook 配置：您注册一个 URL 来接收通知。每次发送 webhook 的服务上发生相关事件时都会调用此 URL。
事件发生：当配置的事件（例如事务、数据更新或创建记录）发生时，服务会触发对注册 URL 的 HTTP 请求。
Webhook 处理：您的应用程序接收此请求并处理信息。例如，您可以更新数据库中的数据、向用户发送响应或执行任何其他必要的任务。
请求响应：处理完 webhook 后，您的应用程序必须使用 HTTP 状态代码（例如 200 OK）进行响应，以通知您请求已收到并正确处理。

Webhook.site 的实际示例

在实际应用程序中配置 Webhook 之前，最好在本地或开发环境中对其进行测试。 Webhook.site 是一个出色的工具。它提供了一个临时 URL，您可以在其中提交 Webhook 来预览和调试它们，从而使您能够准确地查看数据是如何接收的。

让我们使用 Webhook.site 来测试 webhook 的接收情况。

访问 Webhook.site:
- 转到 Webhook.site。
- 该网站会自动为您生成一个唯一的 URL（例如 https://webhook.site/unique-url）。这将是我们用来接收通知的 URL。
配置Webhook发送:
- 假设您有一个触发 webhooks 的系统。配置此系统以将请求发送到 Webhook.site 提供的 URL。
- 如果想在本地测试，可以使用cURL或者Postman等工具模拟发送webhooks，将请求发送到生成的URL。

现在，让我们实现一些 Node.js 代码来模拟向此 URL 发送 Webhook。

Node.js 中的 Webhook 实现示例

以下是如何配置端点以接收 Webhook 以及如何使用 axios（或任何其他 HTTP 库）发送 Webhook 的示例：

const express = require('express');
const axios = require('axios');
const app = express();

// Middleware para processar o body das requisições como JSON
app.use(express.json());

// Endpoint que recebe os webhooks
app.post('/webhook-receiver', (req, res) => {
  const event = req.body;

  // Processar o evento (aqui você adiciona a lógica que desejar)
  console.log('Webhook recebido:', event);

  // Retornar um status de sucesso para o serviço que enviou o webhook
  res.status(200).send('Evento processado com sucesso');
});

// Simulando o envio de um webhook para o Webhook.site
const webhookURL = 'https://webhook.site/unique-url';  // Substitua pela sua URL do Webhook.site

const sendWebhook = async () => {
  try {
    const payload = {
      event: 'payment_completed',
      data: {
        orderId: '12345',
        amount: 100.0,
        currency: 'USD'
      }
    };

    const response = await axios.post(webhookURL, payload);
    console.log('Webhook enviado com sucesso:', response.status);
  } catch (error) {
    console.error('Erro ao enviar webhook:', error);
  }
};

app.listen(3000, () => {
  console.log('Servidor rodando na porta 3000');

  // Enviar o webhook após o servidor iniciar
  sendWebhook();
});

在此示例中：