什么是 Webhook?

Webhook 是一个 API 概念,是微服务 API 的使用范式之一,也被成为反向 API,即前端不主动发送请求,完全由后端推送;举个常用例子,比如你的好友发了一条朋友圈,后端将这条消息推送给所有其他好友的客户端,就是 Webhook 的典型场景。

简单来说,Webhook 就是一个接收 HTTP POST(或GET,PUT,DELETE)的URL,一个实现了 Webhook 的 API 提供商就是在当事件发生的时候会向这个配置好的 URL 发送一条信息,与请求-响应式不同,使用 Webhook 你可以实时接受到变化。

这又是一种对 客户机-服务器 模式的逆转,在传统方法中,客户端从服务器请求数据,然后服务器提供给客户端数据(客户端是在拉数据),在 Webhook 范式下,服务器更新所需提供的资源,然后自动将其作为更新发送到客户端(服务器是在推数据),客户端不是请求者,而是被动接收方;这种控制关系的反转可以用来促进许多原本需要在远程服务器上进行更复杂的请求和不断的轮询的通信请求;通过简单地接收资源而不是直接发送请求,我们可以更新远程代码库,轻松地分配资源,甚至将其集成到现有系统中来根据 API 的需要来更新端点和相关数据,唯一的缺点是初始建立困难。

  1. 主要用途

更新客户端,在资源新建或者更新时提供更新的、指定的数据。

  1. 常见 Webhook 使用场景

对于第三方平台验权、登陆等 没有前端界面做中转的场景,或者强安全要求的支付场景等,适合用 Webhook 做数据主动推送,说白了就是在前端无从参与,或者因为前端安全问题不适合参与时,就是 Webhook 的场景;很显然 Webhook 也不是 Http 的替代品,不过的确是一种新的前后端交互方式。

如果客户端要长期监听某个任务的状态,按照正常的 API 调用的方式去做,那么必须不停得轮训服务器来获取当前状态;使用 Webhook 则无需轮训,通过 API 可以确定是否发生了更改,如果更改了只需要等待服务器推送信息过来,然后客户端更新就可以;git webhook其实也是这方面的应用。

  1. 使用说明

Webhook 通过请求发送数据到你的应用后,就不再关注这些数据;也就是说如果你的应用存在问题,数据会丢失,许多 Webhook 会处理回应,如果程序出现错误会重传数据;如果你的应用处理这个请求并且依然返回一个错误,你的应用就会收到重复数据。

Webhook 可能会发出大量的请求,这样会造成你的应用阻塞,确保你的应用能处理这些请求

转发地址:https://tojohnonly.github.io/138-%E4%BB%80%E4%B9%88%E6%98%AFWebhook%EF%BC%9F.html

相关资料

Webhook到底是个啥?
https://zhuanlan.zhihu.com/p/133449879
webhook工具
https://www.kancloud.cn/edk24/test/1925621

Gitlab 中配置 WebHook

https://help.aliyun.com/document_detail/153774.html

SmartWebHook v0.2 发布了。SmartWebHook是一个基于 Golang 开发的用于迅速搭建并使用 WebHook 进行自动化部署和运维系统,支持:Github / GitLab / GitOsc / Gogs。界面和开发思路参考于 git-webhook ,在原作者的基础上解耦了WebHook和Server之间关系,实现了多对多关系。因与服务器通信使用的是SSH方式,请注意保管服务器账号和密码。同时支持 C/S 模式,配合客户端可以实现不用SSH也可以远程执行命令。

文档更新时间: 2021-09-17 08:22   作者:月影鹏鹏