[Java知识库]Feign自定义配置详解

Feign简介

Feign是Netflix开源的声明式HTTP客户端。Feign致力于让编写HTTP Client更加简单。 Feign也是通过Ribbon实现负载均衡的。

Feign的基本组成

我们追踪到他的源码

发现他的函数其实并不多，最主要的是这个Feign.Builder静态内部类，它里面定义了大部分配置：

其中主要的配置与作用如下所示：

Feign远程调用整合

Feign是Netflix开源的声明式HTTP客户端，所以使用起来非常简单，用如其名，就是声明就好了

代码流程

第一步： 在pom.xml中引入openfeign的依赖：

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

第二步： 启动类添加开启Feign注解

@EnableFeignClients

第三步：编写Feign客户端

@FeignClient("你的客户微服务服务名")
public interface NacosDiscoveryClientFeign {

    @GetMapping("/hello")
    String hello(@RequestParam(name = "name") String name);
}

测试

@Slf4j
@RestController
public class TestController {

    @Autowired
    private NacosDiscoveryClientFeign nacosDiscoveryClientFeign;

    @GetMapping("/test")
    public String test() {
        String result = nacosDiscoveryClientFeign.hello("wolf");
        return "Return : " + result;
    }
}

流程总结：

• 这里主要先通过 @EnableFeignClients注解开启扫描Spring Cloud Feign客户端的功能；
• 然后又创建一个Feign的客户端接口定义。
• 使用@FeignClient注释来指定这个接口所要调用的服务名称
• 接口中定义的各个函数使用SpringMVC的注释就可以来绑定服务提供方的REST接口。
• 最后在Controller中，注入Client接口的实现，并调用hello方法来触发对服务提供方的调用。

Feign配置

Feign的日配置

Feign的日志级别

Feign日志级别配置解析

细粒度：具体微服务

方式一：代码实现

第一步：添加Feign配置类，可以添加在主类下，但是不用添加@Configuration。如果添加了@Configuration而且又放在了主类之下，那么就会所有Feign客户端实例共享，同Ribbon配置类一样父子上下文加载冲突；如果一定添加@Configuration，就放在主类加载之外的包。
（建议还是不用加@Configuration）

public class FeignConfig {
  @Bean
  public Logger.Level Logger() {
      return Logger.Level.FULL;
   }
}

第二步：给@FeignClient添加配置类

//@FeignClient configuration = GoodsFeignConfig.class 细粒度配置，指定配置类
@FeignClient(name = "你的微服务服务名"，configuration = FeignConfig.class)
public interface NacosDiscoveryClientFeign {

    @GetMapping("/hello")
    String hello(@RequestParam(name = "name") String name);
}

方式二：配置文件实现

feign:
  client:
    config:
      #想要调用的微服务名称
      你的微服务服务名:
        loggerLevel: FULL

全局配置

方式一：代码实现

在启动类上为@EnableFeignClients注解添加defaultConfiguration配置

//在启动类上为@EnableFeignClients注解添加defaultConfiguration配置
@EnableFeignClients(defaultConfiguration = FeignConfig.class)

方式二：配置文件属性实现

feign:
  client:
    config:
      #将调用的微服务名称改成default就配置成全局的了
      default:
        loggerLevel: FULL

Feign支持的其他配置项

代码方式支持配置项

配置文件属性支持配置项，其他配置项的示例配置代码如下：

feign:
  client:
    config:
      feignName（你的微服务服务名）:
        connectTimeout: 5000  # 相当于Request.Optionsn 连接超时时间
        readTimeout: 5000     # 相当于Request.Options 读取超时时间
        loggerLevel: full     # 配置Feign的日志级别，相当于代码配置方式中的Logger
        errorDecoder: com.example.SimpleErrorDecoder  # Feign的错误解码器，相当于代码配置方式中的ErrorDecoder
        retryer: com.example.SimpleRetryer  # 配置重试，相当于代码配置方式中的Retryer
        requestInterceptors: # 配置拦截器，相当于代码配置方式中的RequestInterceptor
          - com.example.FooRequestInterceptor
          - com.example.BarRequestInterceptor
        # 是否对404错误解码
        decode404: false
        encode: com.example.SimpleEncoder
        decoder: com.example.SimpleDecoder
        contract: com.example.SimpleContract

Feign还支持对请求和响应进行GZIP压缩，以提高通信效率，配置方式如下：

# 配置请求GZIP压缩
feign.compression.request.enabled=true
# 配置响应GZIP压缩
feign.compression.response.enabled=true
# 配置压缩支持的MIME TYPE
feign.compression.request.mime-types=text/xml,application/xml,application/json
# 配置压缩数据大小的下限
feign.compression.request.min-request-size=2048

配置的优先级

优先级：细粒度属性配置 > 细粒度代码配置 > 全局属性配置 > 全局代码配置

细粒度属性配置 > 细粒度代码配置 > 全局属性配置 > 全局代码配置