设计WebHook

WebHook 的设计

1、接口设计

WebHook 需要具备良好的自解性,也就是调用 Client 接口时,将自己完整的信息传达到客户端

// POST
{
    "source": {
        "platform": "A Niubility Platform",
        "other": "other infomation"
    },
    "target": {
        "name": "Barret Lee",
        "version": "1.0.0",
        "other": "other infomation"
    },
    "data": {
        //...
    },
    "needCallback": true,
    "serverTime": "2016-12-26 11:55:45"
}

在接口中需要详细说明:

  1. 数据源从哪里来(source)
  2. 数据需要穿给谁(target)
  3. 传递那些数据(data)
  4. 是否需要对方发送回执(needCallback),以及其他信息。

这样做的目的是为了避免发送出现错误,比如发错了对象;即便出错也方便通过日志记录排查问题。

2、多 Hook 设计

URI备注操作
http://example.com/receiveHook通知小李修 bug删除 / 编辑
http://example2.com/receiveHook通知小王修 bug删除 / 编辑

WebHook 的设计一定要支持多 Hook,你永远都不知道下一个系统对接需求会在什么时候到来。

对于复杂的 Hook 设计,表格中可能还有:是否需要回执、是否停用、安全 Token、数据配置等项。

3、安全性设计

这里的安全性是为 Client 考虑的,Client 可能对 refer 或者 origin 做了限制,但这远远不够。当用户在 Server 端注册 WebHook 时,就应该开始考虑 Hook 的安全性了:

// POST
response.setHeader("x-webhook-sign", SHA1(webhook));

Client 在接收到 WebHook 时需要验证 x-webhook-sign 字段,如果不正确应该向服务器响应的错误码(或许此时服务器收到错误码后应该停用这个 Hook)。

4、retry 机制

极有可能因为 Client 的不稳定,导致 Hook 调用失败,此时可以考虑多次尝试:

GitHub - avast/retry-go: Simple golang library for retry mechanism

package retry_test

import (
	"fmt"
	"io/ioutil"
	"net/http"
	"net/http/httptest"
	"strconv"
	"testing"
	"time"

	"github.com/avast/retry-go/v4"
	"github.com/stretchr/testify/assert"
)

// RetriableError is a custom error that contains a positive duration for the next retry
type RetriableError struct {
	Err        error
	RetryAfter time.Duration
}

// Error returns error message and a Retry-After duration
func (e *RetriableError) Error() string {
	return fmt.Sprintf("%s (retry after %v)", e.Err.Error(), e.RetryAfter)
}

var _ error = (*RetriableError)(nil)

// TestCustomRetryFunction shows how to use a custom retry function
func TestCustomRetryFunction(t *testing.T) {
	attempts := 5 // server succeeds after 5 attempts
	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		if attempts > 0 {
			// inform the client to retry after one second using standard
			// HTTP 429 status code with Retry-After header in seconds
			w.Header().Add("Retry-After", "1")
			w.WriteHeader(http.StatusTooManyRequests)
			w.Write([]byte("Server limit reached"))
			attempts--
			return
		}
		w.WriteHeader(http.StatusOK)
		w.Write([]byte("hello"))
	}))
	defer ts.Close()

	var body []byte

	err := retry.Do(
		func() error {
			resp, err := http.Get(ts.URL)

			if err == nil {
				defer func() {
					if err := resp.Body.Close(); err != nil {
						panic(err)
					}
				}()
				body, err = ioutil.ReadAll(resp.Body)
				if resp.StatusCode != 200 {
					err = fmt.Errorf("HTTP %d: %s", resp.StatusCode, string(body))
					if resp.StatusCode == http.StatusTooManyRequests {
						// check Retry-After header if it contains seconds to wait for the next retry
						if retryAfter, e := strconv.ParseInt(resp.Header.Get("Retry-After"), 10, 32); e == nil {
							// the server returns 0 to inform that the operation cannot be retried
							if retryAfter <= 0 {
								return retry.Unrecoverable(err)
							}
							return &RetriableError{
								Err:        err,
								RetryAfter: time.Duration(retryAfter) * time.Second,
							}
						}
						// A real implementation should also try to http.Parse the retryAfter response header
						// to conform with HTTP specification. Herein we know here that we return only seconds.
					}
				}
			}

			return err
		},
		retry.DelayType(func(n uint, err error, config *retry.Config) time.Duration {
			fmt.Println("Server fails with: " + err.Error())
			if retriable, ok := err.(*RetriableError); ok {
				fmt.Printf("Client follows server recommendation to retry after %v\n", retriable.RetryAfter)
				return retriable.RetryAfter
			}
			// apply a default exponential back off strategy
			return retry.BackOffDelay(n, err, config)
		}),
	)

	fmt.Println("Server responds with: " + string(body))

	assert.NoError(t, err)
	assert.Equal(t, "hello", string(body))
}

GitHub - softonic/axios-retry: Axios plugin that intercepts failed requests and retries them whenever possible

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
Webhook 是一种 API 设计模式,允许应用程序将实时事件发送给其他应用程序。Webhook 通过 HTTP 请求向其他应用程序发送数据,而不需要等待另一个应用程序轮询数据源。下面是一个基本的 Webhook 设计: 1. 定义事件:你需要确定你的应用程序中的哪些真实事件需要触发 Webhook。例如,当用户创建帐户时、当订单发生更改时或当库存水平达到特定阈值时。 2. 设计 Webhook URL:为每个事件定义一个 Webhook URL。这个 URL 应该是一个公开可访问的 API 端点,可以接收 POST 请求。 3. 安全性考虑:Webhook 接收器应该是安全的,需要身份验证和授权。你可以使用 API 密钥或 OAuth2 认证等方法来保护 Webhooks。 4. 触发 Webhook:当事件发生时,应用程序将触发 Webhook 请求,将事件数据作为 POST 请求的正文发送给 Webhook URL。 5. 处理 WebhookWebhook URL 接收到请求后,应用程序需要处理接收到的数据,可能需要将数据保存到数据库、向其他应用程序发送通知等。 6. 响应 WebhookWebhook 接收器应该在处理请求后发送响应。这个响应应该是一个 HTTP 状态码,例如 200,以指示 Webhook 请求已成功处理。 7. 处理错误:如果 Webhook 请求失败,则应用程序需要尝试重新发送请求或记录错误以进行进一步的故障排除。 最后,你需要考虑 Webhook 的扩展性和性能。如果你的应用程序需要处理大量的 Webhook 请求,你可能需要使用负载均衡器或其他技术来确保 Webhook 接收器的高可用性和可扩展性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

刘贤松

一本万利

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值