Webhook 是 "用户定义的 HTTP 回调"。它们通常有以下几个特点:
- 由事件触发,例如支付完成事件。
- 回调地址由用户配置。
下图显示了轮询方式和 webhook 方式的比较。
图片
假设我们运营一个电子商务网站。用户通过 API 网关向订单服务发送订单,订单服务转到支付服务进行支付。然后,支付服务与外部支付服务提供商(PSP)进行对话以完成真正的支付交易。
我们有两种方法可以处理与外部 PSP 的通信。
短轮询
向 PSP 发送支付请求后,支付服务会不断向 PSP 询问支付状态。经过几轮后,PSP 最终返回付款状态。
短轮询有两个缺点:
- 持续轮询状态需要支付服务的资源。
- 外部服务直接与支付服务通信,可能造成安全漏洞。
Webhook
我们可以向外部服务注册一个 Webhook。当有关于请求的最新状态更新时,请回调某个 URL。当 PSP 完成处理后,它会调用 HTTP 请求来更新付款状态。
这样,编程模式就改变了,支付服务就不再需要浪费资源来轮询支付状态了。
如果 PSP 从未回调怎么办?我们可以设置一个 housekeeping 任务,每小时检查一次付款状态。
Webhook 通常被称为反向 API 或推送 API,因为服务器会向客户端发送 HTTP 请求。
使用 Webhook 时,我们需要注意以下三点:
- 我们需要设计一个适当的 API 供外部服务调用。
- 出于安全考虑,我们需要在 API 网关中设置适当的规则,比如白名单设置,限流等。
- 我们需要在外部服务中注册正确的 URL。