斷路器在項(xiàng)目中的重要性：保護(hù)遠(yuǎn)程接口調(diào)用的穩(wěn)定運(yùn)行
環(huán)境：SpringBoot2.4.12 + Spring Cloud Hoxton.SR12
簡(jiǎn)介
Spring Cloud 斷路器提供了不同斷路器實(shí)現(xiàn)之間的抽象。它提供了在應(yīng)用程序中使用的一致API，讓開(kāi)發(fā)人員選擇最適合應(yīng)用程序需求的斷路器實(shí)現(xiàn)。
Spring Cloud支持以下斷路器實(shí)現(xiàn):
- Resilience4J
- Sentinel
- Spring Retry
阻塞式應(yīng)用
要在代碼中創(chuàng)建斷路器，可以使用CircuitBreakerFactory API。當(dāng)你在類(lèi)路徑中包含Spring Cloud Circuit Breaker starter時(shí)，將自動(dòng)為你創(chuàng)建實(shí)現(xiàn)此API的bean。下面的例子展示了如何使用這個(gè)API的一個(gè)簡(jiǎn)單例子:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-circuitbreaker-resilience4j</artifactId>
</dependency>或者（反應(yīng)式）<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-circuitbreaker-reactor-resilience4j</artifactId>
</dependency>簡(jiǎn)單API應(yīng)用
@Service
public static class UsersService {
private RestTemplate rest;
private CircuitBreakerFactory cbFactory;
public DemoControllerService(RestTemplate rest, CircuitBreakerFactory cbFactory) {
this.rest = rest;
this.cbFactory = cbFactory;
}
public Users getUser() {
// 這里remoteUser是唯一標(biāo)識(shí)，下面你會(huì)看到為這id配置
return cbFactory.create("remoteUser").run(() -> rest.getForObject("/100", Users.class), throwable -> "用戶(hù)用戶(hù)信息失敗");
}
}CircuitBreakerFactory.create API創(chuàng)建一個(gè)名為CircuitBreaker的類(lèi)實(shí)例。run方法接受一個(gè)Supplier和一個(gè)Function。Supplier是你要包裝在斷路器中的代碼。Function是在斷路器跳閘時(shí)運(yùn)行的后備功能。Function被傳遞導(dǎo)致觸發(fā)回退的Throwable。如果你不想提供一個(gè)回退，你可以選擇排除它。
反應(yīng)式應(yīng)用
如果Project Reactor位于類(lèi)路徑上，你還可以為響應(yīng)式代碼使用ReactiveCircuitBreakerFactory。下面的例子展示了如何做到這一點(diǎn):
@Service
public static class DemoControllerService {
private ReactiveCircuitBreakerFactory cbFactory;
private WebClient webClient;
public DemoControllerService(WebClient webClient, ReactiveCircuitBreakerFactory cbFactory) {
this.webClient = webClient;
this.cbFactory = cbFactory;
}
public Mono<Users> getUser() {
return webClient.get().uri("/100").retrieve().bodyToMono(Users.class).transform(
it -> cbFactory.create("remoteUser").run(it, throwable -> return Mono.just("獲取用戶(hù)失敗")));
}
}ReactiveCircuitBreakerFactory.create API創(chuàng)建一個(gè)名為ReactiveCircuitBreaker的類(lèi)實(shí)例。run方法將一個(gè)Mono或Flux包在一個(gè)斷路器中。你可以選擇配置一個(gè)回退函數(shù)，該函數(shù)將在斷路器被觸發(fā)并傳遞導(dǎo)致故障的Throwable時(shí)被調(diào)用。
配置
你可以通過(guò)創(chuàng)建Customizer類(lèi)型的bean來(lái)配置斷路器工廠。Customizer接口有一個(gè)方法(稱(chēng)為customize)
// 對(duì)斷路器工廠進(jìn)行自定義
@Component
public class PackCircuitBreakerCustomizer implements Customizer<Resilience4JCircuitBreakerFactory> {
@Override
public void customize(Resilience4JCircuitBreakerFactory tocustomize) {
tocustomize.configure(builder -> {
// 配置超時(shí)
builder.timeLimiterConfig(
TimeLimiterConfig.custom()
.timeoutDuration(Duration.ofMillis(3000))
.build()
) ;
// 配置熔斷
builder.circuitBreakerConfig(
CircuitBreakerConfig.custom()
.failureRateThreshold(0.1f) // 當(dāng)故障率大于等于故障閾值時(shí)，斷路器切換到開(kāi)路狀態(tài)，開(kāi)始短路調(diào)用。
.minimumNumberOfCalls(3) // 斷路器打開(kāi)的前提是至少有3次的調(diào)用
.build()
) ;
}, "a1", "a2", "a3", "remoteUser") ;// 這里指定了只有哪些id都會(huì)被應(yīng)用這些配置
// 為所有的斷路器提供默認(rèn)配置
tocustomize.configureDefault(id -> new Resilience4JConfigBuilder(id)
.circuitBreakerConfig(CircuitBreakerConfig.ofDefaults())
.timeLimiterConfig(TimeLimiterConfig.ofDefaults()).build());
}
}有關(guān)如何自定義給定實(shí)現(xiàn)的詳細(xì)信息，請(qǐng)參閱以下文檔:
Resilience4J：
https://docs.spring.io/spring-cloud-commons/spring-cloud-circuitbreaker/current/reference/html/spring-cloud-circuitbreaker.html#configuring-resilience4j-circuit-breakers
Sentinel:
https://github.com/alibaba/spring-cloud-alibaba/blob/2.2.x/spring-cloud-alibaba-docs/src/main/asciidoc/circuitbreaker-sentinel.adoc#circuit-breaker-spring-cloud-circuit-breaker-with-sentinel%E2%80%94%E2%80%8Bconfiguring-sentinel-circuit-breakers
Spring Retry:
https://docs.spring.io/spring-cloud-circuitbreaker/docs/current/reference/html/spring-cloud-circuitbreaker.html#configuring-spring-retry-circuit-breakers
一些 CircuitBreaker 實(shí)現(xiàn)，如Resilience4JCircuitBreaker，在每次調(diào)用CircuitBreaker#run時(shí)調(diào)用自定義方法。它可能是低效的。在這種情況下，你可以使用CircuitBreaker#once方法。
下面的例子展示了io.github.resilience4j.circuitbreaker.CircuitBreaker的方法。斷路器消耗事件。
Customizer.once(circuitBreaker -> {
circuitBreaker.getEventPublisher()
.onStateTransition(event -> log.info("{}: {}", event.getCircuitBreakerName(), event.getStateTransition()));
}, CircuitBreaker::getName)完畢！??！
