retryable-client-http-request-interceptor

RetryableClientHttpRequestInterceptor for RestTemplate and RestClient

For Spring 6+ / Spring Boot 3+

<dependency>
	<groupId>am.ik.spring</groupId>
	<artifactId>retryable-client-http-request-interceptor</artifactId>
	<version>0.6.0</version>
</dependency>

For Spring 5 / Spring Boot 2

<dependency>
	<groupId>am.ik.spring</groupId>
	<artifactId>retryable-client-http-request-interceptor-spring5</artifactId>
	<version>0.6.0</version>
</dependency>

How to use

private final RestTemplate restTemplate;

public MyClient(RestTemplateBuilder builder){
	this.restTemplate = builder
		.rootUri("http://example.com")
		.additionalInterceptors(new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2)))
		.build();
}

or

// Spring 6.1+ / Spring Boot 3.2+
private final RestClient restClient;

public MyClient(RestClient.Builder builder){
	this.restClient = builder
		.baseUrl("http://example.com")
		.requestInterceptor(new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2)))
		.build();
}

• How to use exponential backoff

  new RetryableClientHttpRequestInterceptor(new ExponentialBackOff(100, 2))

• How to configure retryableResponseStatuses (default: 408, 425, 429, 500, 503, 504)

  new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2), Set.of(500, 503))

• How to configure whether to retryClientTimeout (default: true)

  new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2),
  	options -> options.removeRetryableIOException(RetryableIOExceptionPredicate.CLIENT_TIMEOUT))

• How to configure whether to retryConnectException (default: true)

  new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2),
  	options -> options.removeRetryableIOException(RetryableIOExceptionPredicate.CONNECT_TIMEOUT))

• How to configure whether to retryUnknownHostException (default: true)

  new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2),
  	options -> options.removeRetryableIOException(RetryableIOExceptionPredicate.UNKNOWN_HOST))

• How to enable client-side load balancing during retries (Since 0.3.0)

  LoadBalanceStrategy loadBalanceStrategy = /* Bing your own strategy */;
  new RetryableClientHttpRequestInterceptor(new FixedBackOff(100, 2),
  			options -> options.loadBalanceStrategy(loadBalanceStrategy));

License

Licensed under the Apache License, Version 2.0.