NEVO
全部笔记
API 设计

重试也是接口的一部分

约 4 分钟

超时并不能说明请求是否失败。设计下一次尝试时,要把这种不确定性考虑进去。

客户端发出请求,等待,然后超时。从客户端来看,似乎什么都没发生。但在服务端,操作可能已经完成。正是这个差距,让一次看似无害的重试变成重复的订单、邮件或后台任务。

区分通信与处理结果

网络交互成功和业务操作成功是两件不同的事。如果响应到达前连接就断开了,客户端面对的是未知结果。把它当作确定的失败,会让下一步更难判断。

对于改变状态的操作,要让客户端能够标识原本想完成的那一次操作。幂等键可以让重复送达的请求指向同一份工作,而不是每到达一次就新建一份。

把约定说清楚

需要明确:幂等键保留多久;同一个键配上不同的输入时如何处理;重试到达时,原操作是否可能仍在执行。这些都是接口的一部分,不只是存储细节。

把结果与操作标识关联起来。第一次操作已经完成,就返回对应的结果。如果仍在执行,就明确告诉客户端正在处理,而不是再启动一份。

有理由地等待

重试要有上限,也要有间隔。退避把负载分散到不同时间,随机抖动避免大量客户端同时回来。如果接口约定中包含服务端建议的重试间隔,应优先采用。

不要对所有错误都重试。输入不合法需要修改,认证或授权失败需要另作处理,永久性拒绝也不会因为多等一秒就消失。

没有说明何时停止的重试策略,还不完整。

测试结果不确定的情况

测试操作已经提交、响应却丢失的情况;测试两个相同请求同时到达;测试超过幂等键保留时间后再重试。这些场景比依次发送几个成功请求更能说明可靠性。

目标不是保证所有请求都成功,而是让再次尝试具有可以预期的含义。


全部笔记