spring-cloud使用resilience4j实现熔断、限流

由于hystrix官方已经停止维护了,目前spring-cloud推荐使用resilience4j来代替hystrix实现熔断、限流 。
熔断一般指客户端调用服务端接口出现异常时客户端侧的处理,当然也可以是服务端的处理出现异常时熔断快速返回,可以暂时切断对下游服务的调用,是一种牺牲局部保全整体的有效措施(同时此客户端也可能是服务端) 。
限流一般是指限制在指定时间间隔内的请求量,避免因请求过多导致服务崩溃,限流被看作是服务端的自我保护能力 。
1、客户端openfeign使用resilience4j实现熔断模拟一个客户端,通过feign调用一个服务端接口来模拟此功能
使用spring-boot的版本为2.7.3,spring-cloud版本为2021.0.4,关键的依赖如下

  • 1.1、引入关键依赖
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-circuitbreaker-resilience4j</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-loadbalancer</artifactId></dependency><dependency><groupId>io.github.resilience4j</groupId><artifactId>resilience4j-feign</artifactId></dependency>
  • 1.2、Application.yaml增加以下熔断配置
resilience4j:circuitbreaker:instances:ApiService:registerHealthIndicator: trueslidingwindowsize: 7slidingWindowType: COUNT_BASEDwaitDurationInOpenState: 5000permittedNumberOfCallsInHalfOpenState: 6feign:client:config:default:readTimeout: 1000connectTimeout: 1000circuitbreaker:enabled: truelogging:level:root: infopattern:console: "%d{${LOG_DATEFORMAT_PATTERN:HH:mm:ss.SSS}} %m%n"
需要注意的是feign需要开启circuitbreaker,并在启动类中增加@EnableFeignClients,
spring-boot默认情况下会使用logback来管理日志,为了便于观察调整参数后的效果调整一下日志格式,在此案例中默认的日志格式在
org.springframework.boot.logging.logback.DefaultLogbackConfiguration类中defaults方法中定义,此类在包spring-boot:2.7.3中 。
增加feign客户端请求类并需要增加fallback方法处理熔断后的默认返回,简单写一个测试类完成测试,观察对应的参数情况
  • 1.3、编写一个feign client端
//ApiClient.JAVA@FeignClient(name = "ApiService", url = "http://localhost:8082")public interface ApiClient {@GetMapping("/api/test")@CircuitBreaker(name = "ApiService", fallbackMethod = "getUserFallback")String getUser(@RequestParam(name = "param") String param, @RequestParam(name = "time") int time);default String getUserFallback(String param, int time, Exception exc) {return "default value";}}
  • 1.3、编写一个单元测试模拟调用
//ResilienceTest.java@Slf4j@SpringBootTestclass ResilienceTest {@Autowiredprivate ApiClient apiClient;@Autowiredprivate CircuitBreakerRegistry circuitBreakerRegistry;@Testvoid test() throws Exception {for (int i = 0; i < 1000; i++) {apiClient.getUser("test", 500);status();Thread.sleep(500);}}private void status() {CircuitBreaker breaker = circuitBreakerRegistry.circuitBreaker("ApiService");CircuitBreaker.Metrics metrics = breaker.getMetrics();log.info("state={},metrics[failureRate={},bufferedCalls={},failedCalls={},successCalls={},maxBufferCalls={},notPermittedCalls={}]", breaker.getState(), metrics.getFailureRate(), metrics.getNumberOfBufferedCalls(), metrics.getNumberOfFailedCalls(), metrics.getNumberOfSuccessfulCalls(), metrics.getNumberOfBufferedCalls(), metrics.getNumberOfNotPermittedCalls());}}
在没有任务服务端的情况下,运行单元测试即可模拟熔断的效果 。另外需要注意配置的feign调用的超时,单元测试中增加获取metrics并打印以便观察效果;
运行结果如下
spring-cloud使用resilience4j实现熔断、限流

文章插图
 
简单分析一下,滑动窗口的大小slidingWindowSize为7,滑动窗口类型slidingWindowType为计数器,熔断器从打开到半开的状态等待时间为5秒,熔断器半开状态下允许的数量
permittedNumberOfCallsInHalfOpenState为6 。
failureRateThreshold的含义:如60(即%60),这个阈值控制两个状态的变化,从CLOSE=>OPEN时,表示当错误率高于60%时开启熔断,而状态从HALF_OPEN=>CLOSE时,表示当错误率低于60%时关闭熔断;
spring-cloud使用resilience4j实现熔断、限流


推荐阅读