本文详细介绍了使用 Go 创建 Webhook 代理,从而实现监听 GitHub Webhooks 的应用程序的本地开发。 该解决方案通过构建自定义服务器和 CLI 应用程序来避免使用 smee.io 或 ngrok 等第三方服务。
挑战在于将 webhook 事件从 GitHub 转发到本地主机开发环境。 本教程提供了一个由两部分组成的解决方案:一个用于接收 GitHub 事件的服务器和一个用于将事件转发到本地应用程序的 CLI。
建筑:
该系统涉及四个关键组件:
CLI 和服务器之间的通信使用服务器发送事件 (SSE),这是一种简单的单向推送技术。
实施:
项目结构包括用于 CLI 和服务器可执行文件的 cmd
目录,以及用于共享包的 internal
目录。 服务器利用 go-sse
库来实现 SSE 功能。 CLI 使用 backoff
库进行稳健的连接处理。
*服务器(cmd/web/main.go 和internal/server/):**
服务器有两个端点:
/channel/{channel}
(GET):与 CLI 建立 SSE 连接。/channel/{channel}
(POST):接收 GitHub Webhook 事件,对它们进行编码,并将它们发布到连接的 CLI。CLI (cmd/cli/main.go):
CLI 建立到服务器的 SSE 连接,接收编码的请求,对其进行解码,并将其转发到指定的本地应用程序。 错误处理和指数退避是使用 backoff
库实现的。
测试:
提供了一个简单的测试服务器(cmd/test/main.go
)来接收和处理转发的 Webhook 事件。 部署服务器并运行 CLI 后,将更改推送到 GitHub 存储库会触发 Webhook,然后将其转发到本地测试服务器。
部署(附录):
文章详细介绍了如何使用 Docker 和部署工具 Kamal 来部署服务器。 它包括创建 Dockerfile、设置 Kamal、配置环境变量(包括使用密码管理器确保安全)以及添加运行状况检查端点。 该过程包括设置 DigitalOcean Droplet、配置 SSH 访问以及通过 Kamal 代理使用 Let's Encrypt 管理域名和 SSL 证书。 还建议采取额外的安全措施和改进开发环境。
这个强大的解决方案提供了一种灵活可靠的方法,用于在本地开发期间处理 GitHub webhooks,从而无需外部服务。 未来的文章将探讨扩展它以创建 Telegram 机器人。
以上是在 Go 中构建 Webhook 有效负载交付服务的详细内容。更多信息请关注PHP中文网其他相关文章!