SpringCloud 2021.0.9 OpenFeign 与 circuitbreaker-resilience4j 使用示例

背景

OpenFeign是微服务中服务远程调用组件。
circuitbreaker 是断路器的抽象接口。
resilience4j是断路器的一种实现。

在服务间远程调用过程中,为了避免服务雪崩,需要设置失败保护机制,当下游服务超时或者不可用时,上游服务可以快速返回,同时下游服务会降级,上游服务短时间不去请求下游服务。

实现远程调用

服务提供者

服务提供者就是正常的SpringBoot项目,为了让服务调用者可以请求该服务,需要将服务信息注册到Consul注册中心。

1依赖如下:

<dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-circuitbreaker-resilience4j</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>

2配置如下:

spring:
  application:
    name: system-application
  cloud:
    consul:
      discovery:
        service-name: ${spring.application.name}
        instance-id: system-service
      host: localhost
      port: 8500
      config:
        format: yaml
        data-key: system
        enabled: true
        watch:
          enabled: true
          wait-time: 5

  config:
    import: optional:consul:${spring.cloud.consul.host}:${spring.cloud.consul.port}/test

hello:
  name

3还需要自己实现一个普通controller。

启动服务提供者,打开consul控制台,服务成功注册即可。

服务消费

1 添加依赖


 <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-config</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</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-circuitbreaker-resilience4j</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>

相比服务提供者,多了一个断路器的依赖:

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-circuitbreaker-resilience4j</artifactId>
        </dependency>

2 配置:

spring:
  application:
    name: portal-application
  cloud:
    consul:
      discovery:
        service-name: ${spring.application.name}
        instance-id: portal-service
      host: localhost
      port: 8500

  config:
    import: optional:consul:${spring.cloud.consul.host}:${spring.cloud.consul.port}


feign:
  circuitbreaker:
    enabled: true
#  client:
#    config:
#      default:
#        connectTimeout: 1000
#        readTimeout: 1000

server:
  port: 8081


配置文件中只添加如下配置,用于打开circuitbreaker。
feign:
circuitbreaker:
enabled: true

3 配置断路器, 这里配置了1ms的超时。

@Configuration
public class BreakerConfig {

    @Bean
    public Customizer<Resilience4JCircuitBreakerFactory> defaultCustomizer() {
        return factory -> factory.configureDefault(id -> new Resilience4JConfigBuilder(id)
                .timeLimiterConfig(TimeLimiterConfig.custom().timeoutDuration(Duration.ofMillis(1)).build())
                .circuitBreakerConfig(CircuitBreakerConfig.ofDefaults())
                .build());
    }
}

4 实现FeignClient调用,主要是加入fallback逻辑,用于失败后的处理

@FeignClient(name ="system-application",  fallback = UserClient.Fallback.class)
@Component
public interface UserClient {

    @GetMapping("")
    String getName();

    @Component
    static class Fallback implements UserClient {

        @Override
        public String getName() {
            return "00000000000000000000000";
        }
    }
}

至此,基本的Demo已经完成。

启动服务消费者,访问feignClient的接口,发现返回了fallback类中配置的信息。证明断路器配置起作用。

除了断路器的配置外,如下的配置和断路器无关,支持配置了http请求的超时时间,如果超时,会报错,不会触发Fallback。

  client:
    config:
      default:
        connectTimeout: 1000
        readTimeout: 1000

总结

  1. 加入断路器依赖
  2. feign.circuitbreaker.enabled: true 开启断路器
  3. 注入Resilience4JConfigBuilder

以上三步在服务调用方实现。

相关推荐

  1. springcloud4使用resilience4j实现服务流量治理

    2024-04-14 06:12:05       30 阅读
  2. SpringCloudResilience4j相关配置信息

    2024-04-14 06:12:05       47 阅读
  3. Hystrix、Resilience4j和Sentinel对比

    2024-04-14 06:12:05       37 阅读
  4. Resilience4j 实现接口限流

    2024-04-14 06:12:05       25 阅读
  5. Resilience4j相关面试题及答案

    2024-04-14 06:12:05       51 阅读
  6. SpringBoot整合resilience4j实现接口限流

    2024-04-14 06:12:05       61 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-04-14 06:12:05       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-04-14 06:12:05       100 阅读
  3. 在Django里面运行非项目文件

    2024-04-14 06:12:05       82 阅读
  4. Python语言-面向对象

    2024-04-14 06:12:05       91 阅读

热门阅读

  1. 打不动的蓝桥杯

    2024-04-14 06:12:05       34 阅读
  2. 使用低空无人机图像对树种进行实例分割

    2024-04-14 06:12:05       36 阅读
  3. git 如何合并两个分支中的某些文件

    2024-04-14 06:12:05       38 阅读
  4. python 今日小知识1——parser

    2024-04-14 06:12:05       39 阅读
  5. tomcat按顺序启动应用

    2024-04-14 06:12:05       32 阅读
  6. xxl-job调度任务原理解析

    2024-04-14 06:12:05       32 阅读
  7. Qt | .pro开发经验笔记

    2024-04-14 06:12:05       37 阅读
  8. uniapp——长按识别二维码

    2024-04-14 06:12:05       38 阅读
  9. c#raft算法实现

    2024-04-14 06:12:05       33 阅读
  10. 蓝桥杯3527 阶乘的和 Python

    2024-04-14 06:12:05       38 阅读
  11. 使用Spring Cloud构建微服务时的一些经验

    2024-04-14 06:12:05       29 阅读
  12. React中常见的Hook

    2024-04-14 06:12:05       43 阅读