Use Spring Retry For Failed Requests Using Feign #1457
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,54 +16,75 @@ | |
|
|
||
| package org.springframework.cloud.netflix.feign.ribbon; | ||
|
|
||
| import feign.Client; | ||
| import feign.Request; | ||
| import feign.Response; | ||
| import feign.Util; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.URI; | ||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.HashMap; | ||
| import java.util.LinkedHashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import org.springframework.cloud.client.ServiceInstance; | ||
| import org.springframework.cloud.client.loadbalancer.InterceptorRetryPolicy; | ||
| import org.springframework.cloud.client.loadbalancer.LoadBalancedRetryContext; | ||
| import org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicy; | ||
| import org.springframework.cloud.client.loadbalancer.LoadBalancedRetryPolicyFactory; | ||
| import org.springframework.cloud.client.loadbalancer.ServiceInstanceChooser; | ||
| import org.springframework.cloud.netflix.ribbon.RibbonLoadBalancerClient; | ||
| import org.springframework.cloud.netflix.ribbon.ServerIntrospector; | ||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.http.HttpMethod; | ||
| import org.springframework.http.HttpRequest; | ||
| import org.springframework.retry.RetryCallback; | ||
| import org.springframework.retry.RetryContext; | ||
| import org.springframework.retry.policy.NeverRetryPolicy; | ||
| import org.springframework.retry.support.RetryTemplate; | ||
| import com.netflix.client.AbstractLoadBalancerAwareClient; | ||
| import com.netflix.client.ClientException; | ||
| import com.netflix.client.ClientRequest; | ||
| import com.netflix.client.DefaultLoadBalancerRetryHandler; | ||
| import com.netflix.client.IResponse; | ||
| import com.netflix.client.RequestSpecificRetryHandler; | ||
| import com.netflix.client.config.CommonClientConfigKey; | ||
| import com.netflix.client.config.IClientConfig; | ||
| import com.netflix.loadbalancer.ILoadBalancer; | ||
| import com.netflix.loadbalancer.Server; | ||
|
|
||
| import static org.springframework.cloud.netflix.ribbon.RibbonUtils.updateToHttpsIfNeeded; | ||
|
|
||
| public class FeignLoadBalancer extends | ||
| AbstractLoadBalancerAwareClient<FeignLoadBalancer.RibbonRequest, FeignLoadBalancer.RibbonResponse> implements | ||
| ServiceInstanceChooser { | ||
|
|
||
| private final int connectTimeout; | ||
| private final int readTimeout; | ||
| private final IClientConfig clientConfig; | ||
| private final ServerIntrospector serverIntrospector; | ||
| private final RetryTemplate retryTemplate; | ||
| private final LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory; | ||
|
|
||
| public FeignLoadBalancer(ILoadBalancer lb, IClientConfig clientConfig, | ||
| ServerIntrospector serverIntrospector, RetryTemplate retryTemplate, | ||
| LoadBalancedRetryPolicyFactory loadBalancedRetryPolicyFactory) { | ||
| super(lb, clientConfig); | ||
| this.retryTemplate = retryTemplate; | ||
| this.loadBalancedRetryPolicyFactory = loadBalancedRetryPolicyFactory; | ||
| this.setRetryHandler(new DefaultLoadBalancerRetryHandler(clientConfig)); | ||
| this.clientConfig = clientConfig; | ||
| this.connectTimeout = clientConfig.get(CommonClientConfigKey.ConnectTimeout); | ||
| this.readTimeout = clientConfig.get(CommonClientConfigKey.ReadTimeout); | ||
| this.serverIntrospector = serverIntrospector; | ||
| } | ||
|
|
||
| @Override | ||
| public RibbonResponse execute(final RibbonRequest request, IClientConfig configOverride) | ||
| throws IOException { | ||
| final Request.Options options; | ||
| if (configOverride != null) { | ||
| options = new Request.Options( | ||
| configOverride.get(CommonClientConfigKey.ConnectTimeout, | ||
|
|
@@ -74,26 +95,32 @@ public RibbonResponse execute(RibbonRequest request, IClientConfig configOverrid | |
| else { | ||
| options = new Request.Options(this.connectTimeout, this.readTimeout); | ||
| } | ||
| LoadBalancedRetryPolicy retryPolicy = loadBalancedRetryPolicyFactory.create(this.getClientName(), this); | ||
| retryTemplate.setRetryPolicy(retryPolicy == null ? new NeverRetryPolicy() | ||
|
There was a problem hiding this comment. Seems like this should only be done once. There was a problem hiding this comment. We need the request when creating the policy There was a problem hiding this comment. I'm still confused about where the request is used. There was a problem hiding this comment. So you are saying that the policy should only be created once? The problem is we need the There was a problem hiding this comment. I see, the retry policy created below uses the request. Could there be a problem since the retry policy is scoped to the request and the template is a field? There was a problem hiding this comment. Just trying to make sure I understand the concern.... If multiple requests are executed simultaneously you are concerned about switching out the retry policy mid request? There was a problem hiding this comment. I agree, I guess the only good solution for now is to create a new |
||
| : new InterceptorRetryPolicy(request.toHttpRequest(), retryPolicy, this, this.getClientName())); | ||
| return retryTemplate.execute(new RetryCallback<RibbonResponse, IOException>() { | ||
| @Override | ||
| public RibbonResponse doWithRetry(RetryContext retryContext) throws IOException { | ||
| Request feignRequest = null; | ||
| if(retryContext instanceof LoadBalancedRetryContext) { | ||
| ServiceInstance service = ((LoadBalancedRetryContext)retryContext).getServiceInstance(); | ||
| if(service != null) { | ||
| feignRequest = ((RibbonRequest)request.replaceUri(reconstructURIWithServer(new Server(service.getHost(), service.getPort()), request.getUri()))).toRequest(); | ||
| } | ||
| } | ||
| if(feignRequest == null) { | ||
| feignRequest = request.toRequest(); | ||
| } | ||
| Response response = request.client().execute(feignRequest, options); | ||
| return new RibbonResponse(request.getUri(), response); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Override | ||
| public RequestSpecificRetryHandler getRequestSpecificRetryHandler( | ||
| RibbonRequest request, IClientConfig requestConfig) { | ||
| return new RequestSpecificRetryHandler(false, false, this.getRetryHandler(), requestConfig); | ||
| } | ||
|
|
||
| @Override | ||
|
|
@@ -102,6 +129,12 @@ public URI reconstructURIWithServer(Server server, URI original) { | |
| return super.reconstructURIWithServer(server, uri); | ||
| } | ||
|
|
||
| @Override | ||
| public ServiceInstance choose(String serviceId) { | ||
| return new RibbonLoadBalancerClient.RibbonServer(serviceId, | ||
| this.getLoadBalancer().chooseServer(serviceId)); | ||
| } | ||
|
|
||
| static class RibbonRequest extends ClientRequest implements Cloneable { | ||
|
|
||
| private final Request request; | ||
|
|
@@ -129,6 +162,33 @@ Client client() { | |
| return this.client; | ||
| } | ||
|
|
||
| HttpRequest toHttpRequest() { | ||
| return new HttpRequest() { | ||
| @Override | ||
| public HttpMethod getMethod() { | ||
| return HttpMethod.resolve(RibbonRequest.this.toRequest().method()); | ||
| } | ||
|
|
||
| @Override | ||
| public URI getURI() { | ||
| return RibbonRequest.this.getUri(); | ||
| } | ||
|
|
||
| @Override | ||
| public HttpHeaders getHeaders() { | ||
| Map<String, List<String>> headers = new HashMap<String, List<String>>(); | ||
| Map<String, Collection<String>> feignHeaders = RibbonRequest.this.toRequest().headers(); | ||
| for(String key : feignHeaders.keySet()) { | ||
| headers.put(key, new ArrayList<String>(feignHeaders.get(key))); | ||
| } | ||
| HttpHeaders httpHeaders = new HttpHeaders(); | ||
| httpHeaders.putAll(headers); | ||
| return httpHeaders; | ||
|
|
||
| } | ||
| }; | ||
| } | ||
|
|
||
| @Override | ||
| public Object clone() { | ||
| return new RibbonRequest(this.client, this.request, getUri()); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems odd. Why a bunch of new imports?