springcloud-Feign常见问题总结

TIPS

本文基于Spring Clou Greenwich SR1，理论支持Spring Cloud Finchley及更高版本。

本文总结Feign常见问题及解决方案。

一、使用案例

• 如何使用Feign构造多参数的请求
  

• 使用Spring Cloud Feign上传文件
  

• 使用Feign实现Form表单提交
  

二、FeignClient接口如使用@PathVariable ，必须指定value属性

代码示例：

@FeignClient("microservice-provider-user")
public interface UserFeignClient {
  @RequestMapping(value = "/simple/{id}", method = RequestMethod.GET)
  public User findById(@PathVariable("id") Long id);
  ...
}

在一些早期版本中，其中的@PathVariable("id") 中的"id"，也就是value属性，必须指定，不能省略。

三、Java代码自定义Feign Client的注意点与坑

代码示例：

@FeignClient(name = "microservice-provider-user", configuration = UserFeignConfig.class)
public interface UserFeignClient {
  @GetMapping("/users/{id}")
  User findById(@PathVariable("id") Long id);
}

/**
 * 该Feign Client的配置类，注意：
 * 1. 该类可以独立出去；
 * 2. 该类上也可添加@Configuration声明是一个配置类；
 * 配置类上也可添加@Configuration注解，声明这是一个配置类；
 * 但此时千万别将该放置在主应用程序上下文@ComponentScan所扫描的包中，
 * 否则，该配置将会被所有Feign Client共享，无法实现细粒度配置！
 * 个人建议：像我一样，不加@Configuration注解
 *
 * @author zhouli
 */
class UserFeignConfig {
  @Bean
  public Logger.Level logger() {
    return Logger.Level.FULL;
  }
}

• 配置类上也可添加@Configuraiton 注解，声明这是一个配置类；但此时千万别将该放置在主应用程序上下文@ComponentScan 所扫描的包中，否则，该配置将会被所有Feign Client共享（相当于变成了通用配置，其实本质还是Spring父子上下文扫描包重叠导致的问题），无法实现细粒度配置！

• 个人建议：像我一样，不加@Configuration注解，省得进坑。

• 最佳实践：尽量用配置属性自定义Feign的配置！！！详见：跟我学Spring Cloud（Finchley版）-10-Feign深入

四、@FeignClient 注解属性

@FeignClient(name = "microservice-provider-user")
在早期的Spring Cloud版本中，无需提供name属性，从Brixton版开始，@FeignClient必须提供name属性，否则应用将无法正常启动！

另外，name、url等属性支持占位符。例如：

@FeignClient(name = "${feign.name}", url = "${feign.url}")

五、类级别的@RequestMapping会被Spring MVC加载

@RequestMapping("/users")
@FeignClient(name = "microservice-user")
public class TestFeignClient {
    // ...
}

类上的@RequestMapping 注解也会被Spring MVC加载。该问题现已经被解决，早期的版本有两种解决方案：

方案1：不在类上加@RequestMapping 注解；

方案2：添加如下代码：

@Configuration
@ConditionalOnClass({ Feign.class })
public class FeignMappingDefaultConfiguration {
    @Bean
    public WebMvcRegistrations feignWebRegistrations() {
        return new WebMvcRegistrationsAdapter() {
            @Override
            public RequestMappingHandlerMapping getRequestMappingHandlerMapping() {
                return new FeignFilterRequestMappingHandlerMapping();
            }
        };
    }

    private static class FeignFilterRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
        @Override
        protected boolean isHandler(Class<?> beanType) {
            return super.isHandler(beanType) && !beanType.isInterface();
        }
    }
}

相关Issue：https://github.com/spring-cloud/spring-cloud-netflix/issues/466

六、首次请求失败

造成该问题的原因

Hystrix默认的超时时间是1秒，如果超过这个时间尚未响应，将会进入fallback代码。而首次请求往往会比较慢（由于Ribbon是懒加载的，在首次请求时，才会开始初始化相关类），这个响应时间可能就大于1秒了。知道原因后，我们来总结一下解决方案。以feign为例，解决方案有如下四种。

• 方法一、将Hystrix超时设长

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 5000

该配置是让Hystrix的超时时间改为5秒，这是最容易想到的办法，不过有点治标不治本。

• 方法二、禁用Hystrix超时

hystrix.command.default.execution.timeout.enabled: false

该配置，用于禁用Hystrix的超时时间，一般不建议使用。

• 方法三、为Feign禁用Hystrix
  全局禁用

feign.hystrix.enabled: false

索性禁用feign的hystrix，该做法比较极端，除非一些特殊场景，不推荐使用。
局部禁用 为名为microservice-provider-user 的Feign Client禁用Hystrix

@FeignClient(name = "microservice-provider-user")
public interface UserFeignClient {
  @GetMapping("/users/{id}")
  User findById(@PathVariable("id") Long id);
}
class FooConfiguration {
  @Bean
  @Scope("prototype")
  public Feign.Builder feignBuilder(){
    return Feign.builder();
  }
}

• 方法四、Ribbon配置饥饿加载（最佳）
  从Dalston开始，Ribbon支持配置eager load实现在启动时就初始化Ribbon相关类。

ribbon:
  eager-load:
    enabled: true
    clients: client1, client2, client3

Dalson之前版本可以通过一些Hack的机制实现eager load，不过成本略高，不建议，这里就不贴了

七、如需产生Hystrix Stream监控信息，需要做一些额外操作

• Feign本身已经整合了Hystrix，可直接使用@FeignClient(value = "microservice-provider-user", fallback = XXX.class) 来指定fallback类，fallback类继承@FeignClient所标注的接口即可。

• 但是假设如需使用Hystrix Stream进行监控，默认情况下，访问http://IP:PORT/actuator/hystrix.stream 是会返回404，这是因为Feign虽然整合了Hystrix，但并没有整合Hystrix的监控。如何添加监控支持呢？需要以下几步：

第一步：添加依赖，示例：

<!-- 整合hystrix，其实feign中自带了hystrix，引入该依赖主要是为了使用其中的hystrix-metrics-event-stream，用于dashboard -->
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-hystrix</artifactId>
</dependency>

第二步：在启动类上添加@EnableCircuitBreaker 注解，示例：

@SpringBootApplication
@EnableFeignClients
@EnableDiscoveryClient
@EnableCircuitBreaker
public class MovieFeignHystrixApplication {
  public static void main(String[] args) {
    SpringApplication.run(MovieFeignHystrixApplication.class, args);
  }
}

第三步：在application.yml中添加如下内容，暴露hystrix.stream端点：

management:
  endpoints:
    web:
      exposure:
        include: 'hystrix.stream'

这样，访问任意Feign Client接口的API后，再访问http://IP:PORT/actuator/hystrix.stream ，就会展示一大堆Hystrix监控数据了。

Q.E.D.