Skip to content

Fix circuit breaker Feign builder direct usage #1390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hutiefang76 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix circuit breaker Feign builder direct usage #1390

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2163b3e
Fix circuit breaker Feign builder direct usage
hutiefang Jul 1, 2026
9a18726
Align direct Feign builder circuit breaker resolver
hutiefang Jul 4, 2026
34f202a
Preserve circuit breaker builder method signature
hutiefang Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions ...c/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerInvocationHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,11 @@ else if ("toString".equals(method.getName())) {
return toString();
}

String circuitName = circuitBreakerNameResolver.resolveCircuitBreakerName(feignClientName, target, method);
CircuitBreaker circuitBreaker = circuitBreakerGroupEnabled ? factory.create(circuitName, feignClientName)
: factory.create(circuitName);
String resolvedFeignClientName = feignClientName != null ? feignClientName : target.name();
String circuitName = circuitBreakerNameResolver.resolveCircuitBreakerName(resolvedFeignClientName, target,
method);
CircuitBreaker circuitBreaker = circuitBreakerGroupEnabled
? factory.create(circuitName, resolvedFeignClientName) : factory.create(circuitName);
Supplier<Object> supplier = asSupplier(method, args);
if (this.nullableFallbackFactory != null) {
Function<Throwable, Object> fallbackFunction = throwable -> {
Expand Down
21 changes: 19 additions & 2 deletions ...ign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@

import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
Expand All @@ -45,6 +46,8 @@
import org.springframework.boot.http.converter.autoconfigure.ClientHttpMessageConvertersCustomizer;
import org.springframework.cloud.client.circuitbreaker.CircuitBreaker;
import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory;
import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.AlphanumericCircuitBreakerNameResolver;
import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.DefaultCircuitBreakerNameResolver;
import org.springframework.cloud.openfeign.clientconfig.FeignClientConfigurer;
import org.springframework.cloud.openfeign.support.AbstractFormWriter;
import org.springframework.cloud.openfeign.support.FeignEncoderProperties;
Expand Down Expand Up @@ -248,8 +251,22 @@ public Feign.Builder defaultFeignBuilder(Retryer retryer) {
@Scope("prototype")
@ConditionalOnMissingBean
@ConditionalOnBean(CircuitBreakerFactory.class)
public Feign.Builder circuitBreakerFeignBuilder() {
return FeignCircuitBreaker.builder();
public Feign.Builder circuitBreakerFeignBuilder(CircuitBreakerFactory circuitBreakerFactory,
@Value("${spring.cloud.openfeign.circuitbreaker.group.enabled:false}") boolean circuitBreakerGroupEnabled,
@Value("${spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled:true}") boolean alphanumericIdsEnabled,

@ryanjbaxter ryanjbaxter Jul 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you introduce a new public method with the new parameter and delegate to that? I do not want to change the signature of public methods

ObjectProvider<CircuitBreakerNameResolver> circuitBreakerNameResolver) {
return FeignCircuitBreaker.builder()
.circuitBreakerFactory(circuitBreakerFactory)
.circuitBreakerGroupEnabled(circuitBreakerGroupEnabled)
.circuitBreakerNameResolver(circuitBreakerNameResolver
.getIfAvailable(() -> defaultCircuitBreakerNameResolver(alphanumericIdsEnabled)));
}

private CircuitBreakerNameResolver defaultCircuitBreakerNameResolver(boolean alphanumericIdsEnabled) {
if (alphanumericIdsEnabled) {
return new AlphanumericCircuitBreakerNameResolver();
}
return new DefaultCircuitBreakerNameResolver();
}

}
Expand Down
108 changes: 108 additions & 0 deletions ...n-core/src/test/java/org/springframework/cloud/openfeign/FeignAutoConfigurationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,33 @@
package org.springframework.cloud.openfeign;

import java.lang.reflect.Method;
import java.util.Map;
import java.util.function.Supplier;

import feign.Feign;
import feign.InvocationHandlerFactory;
import feign.Target;
import org.assertj.core.api.Condition;
import org.junit.jupiter.api.Test;

import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.assertj.AssertableApplicationContext;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.cloud.client.circuitbreaker.CircuitBreaker;
import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory;
import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.AlphanumericCircuitBreakerNameResolver;
import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.DefaultCircuitBreakerNameResolver;
import org.springframework.cloud.openfeign.security.OAuth2AccessTokenInterceptor;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.security.oauth2.client.OAuth2AuthorizedClientService;
import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
import org.springframework.test.util.ReflectionTestUtils;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;

/**
* @author Tim Peeters
Expand Down Expand Up @@ -91,6 +101,98 @@ void shouldInstantiateFeignCircuitBreakerTargeterWhenEnabledWithCustomCircuitBre
});
}

@Test
void shouldConfigureCircuitBreakerFeignBuilderWhenUsedDirectly() {
CircuitBreakerFactory<?, ?> circuitBreakerFactory = mock(CircuitBreakerFactory.class);
new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(FeignAutoConfiguration.class, FeignClientsConfiguration.class))
.withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=true",
"spring.cloud.openfeign.circuitbreaker.group.enabled=true",
"spring.cloud.openfeign.httpclient.hc5.enabled=false")
.withBean(CircuitBreakerFactory.class, () -> circuitBreakerFactory)
.run(ctx -> {
CircuitBreakerNameResolver circuitBreakerNameResolver = ctx.getBean(CircuitBreakerNameResolver.class);
Feign.Builder builder = ctx.getBean(Feign.Builder.class);

assertThat(builder).isInstanceOf(FeignCircuitBreaker.Builder.class)
.hasFieldOrPropertyWithValue("circuitBreakerFactory", circuitBreakerFactory)
.hasFieldOrPropertyWithValue("circuitBreakerGroupEnabled", true)
.hasFieldOrPropertyWithValue("circuitBreakerNameResolver", circuitBreakerNameResolver);
});
}

@Test
void shouldConfigureCircuitBreakerFeignBuilderWithoutNameResolverBean() throws NoSuchMethodException {
CircuitBreakerFactory<?, ?> circuitBreakerFactory = mock(CircuitBreakerFactory.class);
new ApplicationContextRunner().withConfiguration(AutoConfigurations.of(FeignClientsConfiguration.class))
.withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=true",
"spring.cloud.openfeign.httpclient.hc5.enabled=false")
.withBean(CircuitBreakerFactory.class, () -> circuitBreakerFactory)
.run(ctx -> {
Feign.Builder builder = ctx.getBean(Feign.Builder.class);
CircuitBreakerNameResolver circuitBreakerNameResolver = (CircuitBreakerNameResolver) ReflectionTestUtils
.getField(builder, "circuitBreakerNameResolver");
Method method = DirectCircuitBreakerClient.class.getMethod("get");
Target<DirectCircuitBreakerClient> target = new Target.HardCodedTarget<>(
DirectCircuitBreakerClient.class, "directClient", "http://localhost");

assertThat(builder).isInstanceOf(FeignCircuitBreaker.Builder.class)
.hasFieldOrPropertyWithValue("circuitBreakerFactory", circuitBreakerFactory)
.hasFieldOrPropertyWithValue("circuitBreakerNameResolver", circuitBreakerNameResolver);
assertThat(circuitBreakerNameResolver)
.isExactlyInstanceOf(AlphanumericCircuitBreakerNameResolver.class);
assertThat(circuitBreakerNameResolver.resolveCircuitBreakerName("directClient", target, method))
.isEqualTo(Feign.configKey(target.type(), method).replaceAll("[^a-zA-Z0-9]", ""));
});
}

@Test
void shouldConfigureDefaultCircuitBreakerFeignBuilderNameResolverWhenAlphanumericIdsDisabled()
throws NoSuchMethodException {
CircuitBreakerFactory<?, ?> circuitBreakerFactory = mock(CircuitBreakerFactory.class);
new ApplicationContextRunner().withConfiguration(AutoConfigurations.of(FeignClientsConfiguration.class))
.withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=true",
"spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled=false",
"spring.cloud.openfeign.httpclient.hc5.enabled=false")
.withBean(CircuitBreakerFactory.class, () -> circuitBreakerFactory)
.run(ctx -> {
Feign.Builder builder = ctx.getBean(Feign.Builder.class);
CircuitBreakerNameResolver circuitBreakerNameResolver = (CircuitBreakerNameResolver) ReflectionTestUtils
.getField(builder, "circuitBreakerNameResolver");
Method method = DirectCircuitBreakerClient.class.getMethod("get");
Target<DirectCircuitBreakerClient> target = new Target.HardCodedTarget<>(
DirectCircuitBreakerClient.class, "directClient", "http://localhost");

assertThat(builder).isInstanceOf(FeignCircuitBreaker.Builder.class)
.hasFieldOrPropertyWithValue("circuitBreakerFactory", circuitBreakerFactory)
.hasFieldOrPropertyWithValue("circuitBreakerNameResolver", circuitBreakerNameResolver);
assertThat(circuitBreakerNameResolver).isExactlyInstanceOf(DefaultCircuitBreakerNameResolver.class);
assertThat(circuitBreakerNameResolver.resolveCircuitBreakerName("directClient", target, method))
.isEqualTo(Feign.configKey(target.type(), method));
});
Comment on lines +149 to +182
}

@Test
void shouldUseTargetNameWhenFeignClientNameIsNotSet() throws Throwable {
CircuitBreakerFactory<?, ?> circuitBreakerFactory = mock(CircuitBreakerFactory.class);
CircuitBreaker circuitBreaker = mock(CircuitBreaker.class);
Method method = DirectCircuitBreakerClient.class.getMethod("get");
InvocationHandlerFactory.MethodHandler methodHandler = mock(InvocationHandlerFactory.MethodHandler.class);
Target<DirectCircuitBreakerClient> target = new Target.HardCodedTarget<>(DirectCircuitBreakerClient.class,
"directClient", "http://localhost");
FeignCircuitBreakerInvocationHandler handler = new FeignCircuitBreakerInvocationHandler(circuitBreakerFactory,
null, target, Map.of(method, methodHandler), null, true,
(feignClientName, targetType, targetMethod) -> feignClientName + "#" + targetMethod.getName());

when(circuitBreakerFactory.create("directClient#get", "directClient")).thenReturn(circuitBreaker);
when(circuitBreaker.run(any(Supplier.class)))
.thenAnswer(invocation -> invocation.<Supplier<?>>getArgument(0).get());
when(methodHandler.invoke(null)).thenReturn("ok");

assertThat(handler.invoke(null, method, null)).isEqualTo("ok");
verify(circuitBreakerFactory).create("directClient#get", "directClient");
}

@Test
void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithoutInterceptors() {
runner
Expand Down Expand Up @@ -147,6 +249,12 @@ private void assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResol
assertThat(bean).isExactlyInstanceOf(beanClass);
}

interface DirectCircuitBreakerClient {

String get();

}

static class CustomCircuitBreakerNameResolver implements CircuitBreakerNameResolver {

@Override
Expand Down