在微服务框架中,通过rest api的形式调用其余服务是很失常的事件。在spring生态系统中,一个风行的REST客户端是Feign,这是因为它的声名式格调和增加不同配置的DRY形式。
这篇博客中,我会探讨对于feign客户端的重试机制。本能的,咱们会这样实现,在try catch和while循环中编写api调用语句,并为另一个api调用编写代码,直到满足条件。这兴许能合乎咱们的目标,然而这会使得咱们的代码俊俏且无奈实现。
现实状况下,所有货色完满运行,且咱们不须要重试任何HTTP申请。因而,在feign中,默认是不启用重试的。而后,完满是不存在的,对于一个tcp包来说,在网络中有数百万种办法会死掉。所以,为了启用重试,你必须把上面的代码放在你的客户端配置中。
@Beanpublic Retryer retryer() { return new Retryer.Default();}
你能够在default办法中传一些参数,比方:间隔时间、最大重试次数等,否则它会以1秒距离重试5次。
这仅仅会让feign在碰到IO异样的时候重试。这有点情理,对吧? X 应该重试去获取Y,仅仅当Y不可达的时候。但这并不是常常产生的。有可能,因为Y和Z之间的连贯断了,导致Y返回5XX的错误码,并且你想在这种状况下重试。要应用它,你必须抛出RetryableException。为了实现这样的目标,咱们须要实现ErrorDecoder类。代码像这样:
public class MyErrorDecoder implements ErrorDecoder { private final ErrorDecoder defaultErrorDecoder = new Default(); @Override public Exception decode(String s, Response response) { Exception exception = defaultErrorDecoder.decode(s, response); if(exception instanceof RetryableException){ return exception; } if(response.status() == 504){ return new RetryableException("504 error", response.request().httpMethod(), null ); } return exception; }}
为了使上述代码失效,你必须把上面的配置放到application properties文件中:
feign.client.config.default.error-decoder=com.example.somepackage.MyErrorDecoder
当初,事件已安顿得当,让咱们看看MyErrorDecoder
这个类都干了些什么。它实现了ErrorDecoder
类并且重写了它的decode办法,这很显著。在decode办法外部,首先咱们查看了抛出的异样是不是曾经是RetryableException
。如果曾经是RetryableException
,那么这是feign本人抛出的异样,并且如果咱们返回该异样,feign就会本人进行重试。
如果异样不是RetryableException
,第二段代码会执行。在这段代码中,咱们查看返回状态是不是504。如果是,咱们手动返回一个RetryableException
。
咱们能够在errorDecoder
中干很多事件。设想一个场景,你想在任何5XX的错误码时进行重试,无论这是否是你的理论场景。那么咱们应该怎么做?编写一堆if/else嘛?不,你不须要,你只须要:
if (HttpStatus.valueOf(response.status()).is5xxServerError()) { return new RetryableException("Server error", response.request().httpMethod(), null);}
上面,也是自定义重试机制的一个办法。你为啥要这么做?我的场景时,当产生每次重试的时候,我先要打印log。为了定制这个retryer,首先删除配置中的默认retryer。而后创立一个模块,像这样:
@Slf4j@Component@NoArgsConstructorpublic class CustomRetryer implements Retryer { private int retryMaxAttempt; private long retryInterval; private int attempt = 1; public CustomRetryer(int retryMaxAttempt, Long retryInterval) { this.retryMaxAttempt = retryMaxAttempt; this.retryInterval = retryInterval; } @Override public void continueOrPropagate(RetryableException e) { log.info("Feign retry attempt {} due to {} ", attempt, e.getMessage()); if(attempt++ == retryMaxAttempt){ throw e; } try { Thread.sleep(retryInterval); } catch (InterruptedException ignored) { Thread.currentThread().interrupt(); } } @Override public Retryer clone() { return new CustomRetryer(6, 2000L); }}
这里咱们的CustomRetryer
重写了continueOrPropagate
和clone
办法,这是feign默认retryer的办法。clone办法中,咱们以须要的参数创立了一个CustomRetryer
,这里6是最大重试次数,2000L时每次重试的间隔时间。
在continueOrPropagate
办法中,你能够定制你的重试机制。记住,为了进行重试并且流传错误信息,你必须抛出这个办法收到的retryable异样。否则,它会持续重试。在这个例子中,咱们在尝试咱们设定的最大重试次数之后,抛出这个异样,否则它会在持续下一次重试之前,期待间隔时间(参数)。
到目前为止,咱们看到的是如何创立一个自定义的谬误解码器和重传器,以依据咱们的须要扩大feign的可靠性。如果您以这种形式创立谬误解码器和重试器,它将为您增加到我的项目中的任意数量的feign客户端工作。然而,设想一个场景,对于不同的client,你想要不通的重试机制,或者对屿其余的的client,不进行重试。你要怎么做?给不通的client,绑定不通的重试器和编码器是很容易的。像这样配置就行:
feign.client.config.default.<your_client_name>.error-decoder=com.example.somepackage.MyErrorDecoderfeign.client.config.client1.retryer=com.example.somepackage.CustomRetryer
重试高兴!!
原文地址:https://medium.com/swlh/how-t...