io.github.resilience4j.circuitbreaker.configure

Class CircuitBreakerAspect

java.lang.Object

io.github.resilience4j.circuitbreaker.configure.CircuitBreakerAspect

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.EmbeddedValueResolverAware, org.springframework.core.Ordered

public class CircuitBreakerAspect
extends java.lang.Object
implements org.springframework.context.EmbeddedValueResolverAware, org.springframework.core.Ordered

This Spring AOP aspect intercepts all methods which are annotated with a CircuitBreaker annotation. The aspect will handle methods that return a RxJava2 reactive type, Spring Reactor reactive type, CompletionStage type, or value type.

The CircuitBreakerRegistry is used to retrieve an instance of a CircuitBreaker for a specific name.

Given a method like this:

      @CircuitBreaker(name = "myService")
     public String fancyName(String name) {
         return "Sir Captain " + name;
     }
 

each time the #fancyName(String) method is invoked, the method's execution will pass through a a CircuitBreaker according to the given config.

The fallbackMethod parameter signature must match either:

1) The method parameter signature on the annotated method or 2) The method parameter signature with a matching exception type as the last parameter on the annotated method

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
CircuitBreakerAspect(CircuitBreakerConfigurationProperties circuitBreakerProperties, io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry, java.util.List<CircuitBreakerAspectExt> circuitBreakerAspectExtList, FallbackDecorators fallbackDecorators)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	circuitBreakerAroundAdvice(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint, io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker circuitBreakerAnnotation)
int	getOrder()
void	matchAnnotatedClassOrMethod(io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker circuitBreaker)
void	setEmbeddedValueResolver(org.springframework.util.StringValueResolver resolver)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CircuitBreakerAspect

public CircuitBreakerAspect(CircuitBreakerConfigurationProperties circuitBreakerProperties,
                            io.github.resilience4j.circuitbreaker.CircuitBreakerRegistry circuitBreakerRegistry,
                            @Autowired(required=false)
                            java.util.List<CircuitBreakerAspectExt> circuitBreakerAspectExtList,
                            FallbackDecorators fallbackDecorators)

Method Detail

matchAnnotatedClassOrMethod

public void matchAnnotatedClassOrMethod(io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker circuitBreaker)

circuitBreakerAroundAdvice

public java.lang.Object circuitBreakerAroundAdvice(org.aspectj.lang.ProceedingJoinPoint proceedingJoinPoint,
                                                   @Nullable
                                                   io.github.resilience4j.circuitbreaker.annotation.CircuitBreaker circuitBreakerAnnotation)
                                            throws java.lang.Throwable

Throws:

java.lang.Throwable

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setEmbeddedValueResolver

public void setEmbeddedValueResolver(org.springframework.util.StringValueResolver resolver)

Specified by:

setEmbeddedValueResolver in interface org.springframework.context.EmbeddedValueResolverAware