Feign简介

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

Feign的组成

接口

作用

默认值

Feign.Builder

Feign的入口

Feign.Builder

Client

Feign底层用什么去请求

和Ribbon配合时：LoadBalancerFeignClient

不和Ribbon配合时：Fgien.Client.Default

Contract

契约，注解支持

SpringMVCContract

Encoder

解码器，用于将独享转换成HTTP请求消息体

SpringEncoder

Decoder

编码器，将相应消息体转成对象

ResponseEntityDecoder

Logger

日志管理器

Slf4jLogger

RequestInterceptor

用于为每个请求添加通用逻辑（拦截器，例子：比如想给每个请求都带上heared）

无

Feign的日志级别

日志级别

打印内容

NONE（默认）

不记录任何日志

BASIC

仅记录请求方法，URL，响应状态代码以及执行时间（适合生产环境）

HEADERS

记录BASIC级别的基础上，记录请求和响应的header

FULL

记录请求和响应header，body和元数据

如何整合Feign

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

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

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

@EnableFeignClients

第三步：编写Feign客户端

@FeignClient("alibaba-nacos-discovery-server")
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配置类，可以添加在主类下，但是不用添加@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 = "alibaba-nacos-discovery-server"，configuration = FeignConfig.class)
public interface NacosDiscoveryClientFeign {

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

方式二：配置文件实现

feign:
  client:
    config:
      #想要调用的微服务名称
      server-1:
        loggerLevel: FULL
  • 全局配置

方式一：代码实现

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

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

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

Feign支持的配置项

  • 代码方式支持配置项

配置项

作用

Logger.Level

指定日志级别

Retryer

指定重试策略

ErrorDecoder

指定错误解码器

Request.Options

超时时间

Collection<RequestInterceptor>

拦截器

SetterFactory

用于设置Hystrix的配置属性，Fgien整合Hystrix才会用

  • 配置文件属性支持配置项
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