Feign入门

2023-11-08 09:04:28

Feign介绍

Feign是一个声明式的http客户端
官方地址：https://github.com/OpenFeign/feign

Feign是Netflix开发的声明式、模板化的HTTP客户端， Feign可以帮助我们更快捷、优雅地调用HTTP API。

在Spring Cloud中，使用Feign非常简单——创建一个接口，并在接口上添加一些注解，代码就完成了。Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。

Spring Cloud对Feign进行了增强，使Feign支持了Spring MVC注解，并整合了Ribbon和Eureka，从而让Feign的使用更加方便。

Spring Cloud Feign是基于Netflix feign实现，整合了Spring Cloud Ribbon和Spring Cloud Hystrix，除了提供这两者的强大功能外，还提供了一种声明式的Web服务客户端定义的方式。

Spring Cloud Feign帮助我们定义和实现依赖服务接口的定义。在Spring Cloud feign的实现下，只需要创建一个接口并用注解方式配置它，即可完成服务提供方的接口绑定，简化了在使用Spring Cloud Ribbon时自行封装服务调用客户端的开发量。

Spring Cloud Feign具备可插拔的注解支持，支持Feign注解、JAX-RS注解和Spring MVC的注解。

Feign的使用与配置

Springboot集成Feign

pom文件中引入feign的依赖：

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

添加注解启动类添加注解开启Feign的功能：

@SpringBootApplication
@EnableFeignClients

编写Feign的客户端:

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/getUser/{id}")
    User queryById(@PathVariable("id") Long id);
}

日志配置

使用application.yml配置

feign:
  client:
    config:
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL # 四种不同的级别
        
#NONE：不输出日志。
#BASIC：只输出请求方法的 URL 和响应的状态码以及接口执行的时间。
#HEADERS：将 BASIC 信息和请求头信息输出。
#FULL：输出完整的请求信息。

使用Java类注解配置

@Configuration
public class FeignConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class);

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class);

请求压缩

Spring Cloud Feign 支持对请求和响应进行GZIP压缩，以减少通信过程中的性能损耗。
只有当 Feign 的 Http Client 不是 okhttp3 的时候，压缩才会生效。
通过下面的参数即可开启请求与响应的压缩功能：

feign:
  client:
    config:
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL # 四种不同的级别：NONE、BASIC、HEADERS、FULL
  compression:
    request:
      mime-types: application/json,application/xml
      enabled: true
      min-request-size: 2048

客户端组件

Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求。
我们可以集成别的组件来替换掉 URLConnection，比如 Apache HttpClient，OkHttp。
pom文件中引入Apache的HttpClient依赖

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

application.yml中添加配置

feign:
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

重试机制

Feign的重试机制在源码中默认关闭的，因为Ribbon的重试机制和Fiegn原来的重试机制冲突，所以在一般情况下，Feign的重试机制指的就是Ribbon的重试机制。

码农公寓