重试工具(Retry Helpers)

class redis.retry.Retry(backoff, retries, supported_errors=(<class 'redis.exceptions.ConnectionError'>, <class 'redis.exceptions.TimeoutError'>, <class 'TimeoutError'>))

Retry a specific number of times after a failure

参数:

• backoff (AbstractBackoff)

• retries (int)

• supported_errors (Tuple[Type[Exception], ...])

call_with_retry(do, fail)

Execute an operation that might fail and returns its result, or raise the exception that was thrown depending on the Backoff object. do: the operation to call. Expects no argument. fail: the failure handler, expects the last error that was thrown

参数:

• do (Callable[[], T])

• fail (Callable[[Exception], Any])

返回类型:

T

update_supported_errors(specified_errors)

Updates the supported errors with the specified error types

参数:

specified_errors (Iterable[Type[Exception]])

返回类型:

None

在 Redis Standalone 中的重试(Retry in Redis Standalone)

>>> from redis.backoff import ExponentialBackoff
>>> from redis.retry import Retry
>>> from redis.client import Redis
>>> from redis.exceptions import (
>>>    BusyLoadingError,
>>>    ConnectionError,
>>>    TimeoutError
>>> )
>>>
>>> # 使用指数退避策略进行3次重试
>>> retry = Retry(ExponentialBackoff(), 3)
>>> # 配置在自定义错误时进行重试的 Redis 客户端
>>> r = Redis(host='localhost', port=6379, retry=retry, retry_on_error=[BusyLoadingError, ConnectionError, TimeoutError])
>>> # 配置仅在超时错误时进行重试的 Redis 客户端
>>> r_only_timeout = Redis(host='localhost', port=6379, retry=retry, retry_on_timeout=True)

从上述示例可以看出，Redis 客户端支持 3 个参数来配置重试行为：

• retry: 带有 回退(Backoff) 策略和最大重试次数的 Retry 实例

• retry_on_error: 重试的 异常(Exceptions) 异常列表

• retry_on_timeout: 如果为 True，仅在 TimeoutError 时重试

如果传入了 retry_on_error 或 retry_on_timeout，但未提供 retry，则默认使用 Retry(NoBackoff(), 1) （意味着在第一次失败后立即重试一次）。

在 Redis Cluster 中的重试(Retry in Redis Cluster)

>>> from redis.backoff import ExponentialBackoff
>>> from redis.retry import Retry
>>> from redis.cluster import RedisCluster
>>>
>>> # 使用指数退避策略进行3次重试
>>> retry = Retry(ExponentialBackoff(), 3)
>>> # 配置重试的 Redis Cluster 客户端
>>> rc = RedisCluster(host='localhost', port=6379, retry=retry, cluster_error_retry_attempts=2)

Redis Cluster 中的重试行为与 Standalone 略有不同：

• retry: 带有 回退(Backoff) 策略和最大重试次数的 Retry 实例，默认值为 Retry(NoBackoff(), 0)

• cluster_error_retry_attempts: 当遇到 TimeoutError、ConnectionError 或 ClusterDownError 时，重试的次数，默认值为 3

我们来看以下示例：

>>> from redis.backoff import ExponentialBackoff
>>> from redis.retry import Retry
>>> from redis.cluster import RedisCluster
>>>
>>> rc = RedisCluster(host='localhost', port=6379,
                      retry=Retry(ExponentialBackoff(), 6), cluster_error_retry_attempts=1)
>>> rc.set('foo', 'bar')

• 客户端库计算键 'foo' 的哈希槽。

• 根据哈希槽，确定要连接到哪个节点以执行命令。

• 在连接期间，抛出了 ConnectionError。

• 由于我们设置了 retry=Retry(ExponentialBackoff(), 6)，客户端会尝试重新连接该节点最多6次，每次尝试之间采用指数退避。

• 即便经过6次重试，客户端仍无法连接。

• 由于我们设置了 cluster_error_retry_attempts=1，在放弃之前，客户端会启动集群更新，将失败的节点从启动节点中移除，并重新初始化集群。

• 集群重新初始化后，开始新一轮的重试循环，最多6次重试，每次之间采用指数退避。

• 如果客户端能够连接，一切正常；否则，由于已耗尽所有尝试，异常最终会抛给调用者。