Spring Cloud OpenFeign 的使用及踩坑指南

2023-08-04 13:44 由顔宸发表于 #后端开发

name/value：指定FeignClient的名称，如果项目使用了Ribbon，name属性会作为微服务的名称，用于服务发现
contextId：指定beanID
url: url一般用于调试，可以手动指定@FeignClient调用的地址
decode404:当发生http 404错误时，如果该字段位true，会调用decoder进行解码，否则抛出FeignException
configuration: Feign配置类，可以自定义Feign的Encoder、Decoder、LogLevel、Contract
fallback: 定义容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback指定的类必须实现@FeignClient标记的接口
fallbackFactory: 工厂类，用于生成fallback类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复的代码
path: 定义当前FeignClient的统一前缀

注意事项

在使用fallback、fallbackFactory属性时，需要使用@Component注解，保证fallback类被Spring容器扫描到
在使用FeignClient时，Spring会按name创建不同的ApplicationContext，通过不同的Context来隔离FeignClient的配置信息，在使用配置类时，不能把配置类放到Spring App Component scan的路径下，否则，配置类会对所有FeignClient生效.

启用OpenFeign

我们需要在服务的启动类上开启 OpenFeign ，只需要在 **Application 启动类上添加 @EnableFeignClients即可。

3. 日志配置

logging:
  level:
    xx.template.cloud.web.service.feign.ServiceServiceFeign: debug

通过loggin.level.xx=debug来设置日志级别。然而这个对Feign客户端不会产生效果。因为@FeignClient注解修饰的客户端在被代理时，都会创建一个新的Feign.Logger实例。我们需要额外指定这个日志的级别才可以。

  /** 
   * feign 日志级别配置
   * @return 
   */
  @Bean
  public Logger.Level feignLoggerLevel(){
    return Logger.Level.FULL;
  }

或者在配置文件中配置

feign: 
  client:
    config:
      # 全局配置
      default:
        loggerLevel: full

Feign支持4种级别：
NONE：不记录任何日志，默认值
BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
HEADERS：在BASIC基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据

4. 数据压缩

用户在网络请求过程中，如果网络不佳、传输数据过大，会造成体验差的问题，我们需要将传输数据压缩提升体验。SpringCloud OpenFeign支持对请求和响应进行GZIP压缩，以减少通信过程中的性能损耗。

在客户端中配置数据压缩

feign:
  compression:
    request:
     enabled: true # 开启请求压缩
    response:
     enabled: true # 开启响应压缩

也可以对请求的数据类型，以及触发压缩的大小下限进行设置

feign:
  compression:
    request:
      enabled: true # 开启请求压缩
      mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
      min-request-size: 2048 # 设置触发压缩的大小下限
      #以上数据类型，压缩大小下限均为默认值
      response:
        enabled: true # 开启响应压缩

OpenFeign高级应用

OpenFeign熔断降级的两种方式-降级方法和降级工厂

首先在配置文件中配置如下，开启熔断降级

feign.hystrix.enabled=true

Feign 定义降级方法

feign接口定义

/**
 * FeignClient 注解的 fallback 属性指定降级类
 */
@FeignClient(name = "xx-template-cloud-service", fallback = ServiceServiceFeignFallBack.class)
public interface ServiceServiceFeign {

    @GetMapping("/order/getOrder")
    Result getOrder(String id);
}

feign接口降级方法定义

@Slf4j
@Component
class ServiceServiceFeignFallBack implements ServiceServiceFeign {

    @Override
    public Result getOrder(String id) {
        log.error("Feign接口熔断 熔断方式：ServiceServiceFeignFallBack");
        return Result.error("500", "Feign接口熔断");
    }
}

Feign 定义降级工厂

feign接口定义

/**
 * FeignClient 注解的 fallback 属性指定降级类
 */
@FeignClient(name = "xx-template-cloud-service", fallback = UserCenterFeignClientFallbackFactory.class)
public interface ServiceServiceFeign {

    @GetMapping("/order/getOrder")
    Result getOrder(String id);
}

feign接口降级工厂定义

@Component
@Slf4j
class UserCenterFeignClientFallbackFactory implements FallbackFactory<ServiceServiceFeign> {

    @Override
    public ServiceServiceFeign create(Throwable cause) {
        return new ServiceServiceFeign() {
            @Override
            public Result getOrder(String id) {
                log.error("Feign接口熔断，熔断方式：UserCenterFeignClientFallbackFactory");
                return Result.error("500", "Feign接口熔断");
            }
        };
    }
}

踩坑指南

坑一：Http Client

OpenFeign默认使用jdk自带的HttpURLConnection，我们知道HttpURLConnection没有连接池、性能和效率比较低，如果采用默认，很可能会遇到性能问题导致系统故障

可以采用Apache HttpClient

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
    <version>9.3.1</version>
</dependency>

feign.httpclient.enabled=true

也可以采用OkHttpClient

<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-okhttp</artifactId>
    <version>10.2.0</version>
</dependency>

feign.okhttp.enabled=true

ribbon中的Http Client

通过OpenFeign作为注册中心的客户端时，默认使用Ribbon做负载均衡，Ribbon默认也是用jdk自带的HttpURLConnection，需要给Ribbon也设置一个Http client，比如使用okhttp，在properties文件中增加下面配置

ribbon.okhttp.enabled=true

坑二：全局超时时间

OpenFeign可以设置超时时间，简单粗暴，设置一个全局的超时时间。如果不配置超时时间，默认是连接超时10s，读超时60s。

feign.client.config.default.connectTimeout=2000
feign.client.config.default.readTimeout=60000

但是如果某个服务的并发量很高，服务的超时时间过长会导致占用大量连接资源，导致系统崩溃，要防止这样的故障发生，最好的做法就是给服务单独设置超时时间。

当然，如果开启熔断后，不配置hystrix和ribbon的超时时间，那么Hystrix与ribbon的默认请求超时时间都是1秒，建议配置Hystrix的超时时间要大于ribbon的超时时间，否则会在接口调用还未完成的时候直接进入回调方法。

# 开启熔断
feign.hystrix.enabled: true

坑三：单服务设置超时时间

上文所述，对单个服务设置超时时间。

feign.client.config.serviceA.connectTimeout=2000
feign.client.config.serviceA.readTimeout=60000

但是如果serviceA中有多个接口，其中X接口又调用serviceB的Feign接口，为了保证X接口请求不被单服务超时时间影响，需要单独对X接口设置超时时间。

几个组件的关系

hystrix+ribbon。hystrix在最外层，然后再到Ribbon，最后里面的是http请求。所以说。hystrix的熔断时间必须大于ribbon的 ( ConnectTimeout + ReadTimeout )。而如果ribbon开启了重试机制，还需要乘以对应的重试次数（注意这里的重试可以是ribbon的重试也可能是feign的重试），保证在Ribbon里的请求还没结束时，Hystrix的熔断时间不会超时。

遇到的问题

1. 使用Spring MVC注解，但请求方式不正确

参数没有通过注解指定，此时的参数会自动封装到body中，Feign检测到body里面有请求参数就会默认使用POST请求。
Feign默认使用的是POST方法，如果想使用GET方法，需要在配置文件中设置spring.cloud.openfeign.client.config.default.method.name=get。
如果使用了Spring Cloud Netflix Feign,那么可能是因为您的应用程序使用了Spring Cloud Netflix Ribbon来处理HTTP负载均衡。在这种情况下，您需要确保Ribbon的配置正确，并且不会影响Feign的GET请求。

2. 使用nacos做注册中心，Feign调用时拉取的服务列表为空

我用的spring cloud版本是Hoxton.SR8

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR8</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

原因是Feign 在spring cloud Hoxton.M2版本之后，不再使用ribbon,所以我们在pom文件中还需要导入loadbalancer依赖，并排除掉nacos的ribbon依赖。

        <!--nacos-discovery-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2021.1</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-loadbalancer</artifactId>
        </dependency>

并在配置文件中添加


spring.cloud.loadbalancer.ribbon.enabled: false

Spring Cloud OpenFeign 的使用及踩坑指南

目录

Feign 和OpenFeign

Feign

OpenFeign

openFeign的优势

OpenFeign应用

1. 导入依赖

2. 使用