【SpringBoot系列】微服务接口调用框架Feign学习指南

toc

前言

通常一个服务需要调用 Http 端点，Feign 来自 OpenFeign 项目使得以声明式方式调用 http 端点变得更加容易。Spring 通过其 Spring Cloud OpenFeign 集成了 openfeign 集成。

一、引入Feign Client

feign 的实际项目是 OpenFeign https://github.com/OpenFeign/feign ，Spring自带启动器，将以下依赖项添加到项目

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

我们创建一个名为 feign-serviceA 的服务，该服务将调用 feign-serviceB 。feign-serviceB 公开一个 GET 端点 /hello，它返回一个简单的 hello 响应正文。为了使用来自 feign-serviceA 的 feign 客户端调用端点，我们需要执行以下操作 -

• 创建一个带有@FeignClient注释的界面，如下所示

@FeignClient(url = "<host:port for serviceB>", name = "serviceB")
public interface ServiceBClient{

    @GetMapping("/hello")
    public ResponseEntity<String> sayHello();
}

• 为主启动类添加@EnableFeignClients 注解

设置好了，我们可以像任何正常的方法调用一样简单地自动连接ServiceBClient并调用方法sayHello。

二、Feign 配置

Feign 自带有一些组件，这些组件用于调用远程端点并编码/解码请求响应。

• 客户端 - 要进行 HTTP 调用，需要 http 客户端。默认情况下，openfeign 带有默认客户端。我们可以用 ApacheHttpClient、OkHttpClient 或 ApacheHC5FeignClient 覆盖它。这些客户端是委托客户端的包装器。例如，ApacheHttpClient 包装一个 httpcomponents、httpclient。
• 解码器 - 需要将 feign Response 转换为 feign 方法返回类型的实际类型。默认情况下，spring 提供了一个 OptionalDecoder，它委托给 ResponseEntityDecoder，后者进一步委托给 SpringDecoder，我们可以通过定义一个 Bean 来覆盖它 解码器 。
• 编码器 - 我们通过向它传递对象来调用feign方法，需要将其转换为 http 请求正文。默认情况下，spring 提供 SpringEncoder。

除了上面的组件外，feign还支持缓存等功能。我们可以创建一个配置类并覆盖上述组件的默认值。如果我们想覆盖单个组件的默认值，@Feign接受配置参数，我们可以使用它来定义默认值的自定义覆盖。

三、重试机制

Feign 已经支持重试机制。但是，默认情况下，它使用 Retry.NEVER_RETRY 。例如，我们可以创建一个自定义重试器，它将重试任何状态代码> 400的请求，以下是我们的 CustomRetryer 的代码：

public class CustomRetryer extends Retryer.Default{
    public CustomRetryer(long period, long maxPeriod, int maxAttempts){
        super(period, maxPeriod, maxAttempts);
    }

    @Override
    public void continueOrPropagate(RetryableException e){
        log.info("Going to retry for ", e);
        super.continueOrPropagate(e);
    }

    @Override
    public Retryer clone(){
        return new CustomRetryer(5,SECONDS.toMillis(1), 5);
    }
}

一个重要的事实是 feign Retry 适用于 IOException 或从某些 errorDecoder 引发的 RetryableException ，以下是自定义解码器的样子：

 @Bean
    public ErrorDecoder errorDecoder(){
        return (methodKey, response) -> {
            byte[] body = {};
            try {
                if (response.body() != null) {
                    body = Util.toByteArray(response.body().asInputStream());
                }
            } catch (IOException ignored) { // NOPMD
            }
            FeignException exception = new FeignException.BadRequest(response.reason(), response.request(), body, response.headers());
            if (response.status() >= 400) {
                return new RetryableException(
                        response.status(),
                        response.reason(),
                        response.request().httpMethod(),
                        exception,
                        Date.from(Instant.now().plus(15, ChronoUnit.MILLIS)),
                        response.request());
            }
            return exception;
        };
    }

四、弹性

我们在前面介绍了通过重试实现的一种弹性形式，Spring 对 feign 有 CircuitBreaker 支持，它通过单独的 Feign 构建器 FeignCircuitBreaker.Builder 来实现它，Circuitbreaker 的实际实现来自 resilience4j 库。

五、拦截器

有时我们想通过添加一些额外的信息来修改请求，例如，我们可以为每个请求添加一些标头，我们可以通过使用 RequestInterceptor 来实现这一点，在下面添加了填充标头 userid 的拦截器。

@Bean
public RequestInterceptor userIdRequestInterceptor(){
     return (template) -> {
        template.header("userid", "somerandomtext");
    };
}

feign-serviceB 读取此标头并返回为标头，我们请求curl，我们得到的响应如下：

< HTTP/1.1 200
< connection: keep-alive
< date: Sat, 20 Aug 2022 15:27:47 GMT
< keep-alive: timeout=60
< userid: somerandomtext
< Content-Type: text/plain;charset=UTF-8
< Content-Length: 7
<
* transfer closed with 7 bytes remaining to read

我们看到 userid 已添加到响应中。一个非常有用的拦截器应用程序是当 feign 必须发送 oauth2 访问令牌时。Out of the spring 提供了一个 OAuth2FeignRequestInterceptor，它为每个请求添加访问令牌。

六、负载均衡

从 spring boot 2.4.0 开始，feign 与 spring-cloud-loadbalancer 集成，后者可以从各种服务发现提供商获取客户端 url 信息，并使该信息可供 feign 使用。feign 的使用简化了发出 http 请求的各个方面。在典型的生产环境中，我们可能需要重写多个组件，如客户端、解码器、errorDecoder 等。同样在 Spring 生态系统中，feign 与弹性、负载平衡、指标等很好地集成在一起，这使得我们在微服务架构中可以自动选择它。

小结

本节我们学习了Spring Feign Client，我们介绍了Feign的配置，重试机制，弹性以及拦截器，负载均衡等能力。Spring Feign Client在微服务调度过程中起到了重要的作用，通过Spring Feign Client，我们可以实现对其他服务的调度能力，后面我们会对Spring Boot系列继续进行深入学习，欢迎大家持续关注，如果你还喜欢小编的风格，请点赞+关注，给小编一个三连赞，小编一定会特别开心哒。

我正在参与2024腾讯技术创作特训营最新征文，快来和我瓜分大奖！