Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送
用Feign就可以替代RestTemplate了

Feign的使用

1.引入依赖

在消费者order-service里面引入远程调用的依赖

  1. <dependency>
  2. <groupId>org.springframework.cloud</groupId>
  3. <artifactId>spring-cloud-starter-openfeign</artifactId>
  4. </dependency>

2.添加注解

在消费者的配置类上面加一个注解@EnableFeignClients

  1. package cn.itcast.order.config;
  2. //配置类上要指定Feign客户端的包名,不然客户端无法注入 ,如果写在启动类上,默认扫描启动类包下的,可以不用写具体的包名,应为启动类包下包含了client包
  3. @EnableFeignClients(basePackages = "cn.itcast.order.client")
  4. @Configuration
  5. public class MyConfig {
  6. @Bean
  7. public IRule myRule(){
  8. return new NacosRule();
  9. }
  10. }

3.编写Feign的客户端

类似controller,这个客户端主要是基于SpringMVC的注解来声明远程调用的信息。

  1. package cn.itcast.order.client;
  2. //这个注解指定了提供者是userservice
  3. @FeignClient("userservice")
  4. public interface UserClient {
  5. @GetMapping("/user/{id}")
  6. User findById(@PathVariable("id") Long id);
  7. }

Feign自定义配置

Feign可以支持很多的自定义配置,如下表所示:

类型 作用 说明
feign.Logger.Level 修改日志级别 包含四种不同的级别:
- NONE:不记录任何日志信息,这是默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
feign.codec.Decoder 响应结果的解析器 http远程调用的结果做解析,例如解析json字符串为java对象
feign.codec.Encoder 请求参数编码 将请求参数编码,便于通过http请求发送
feign. Contract 支持的注解格式 默认是SpringMVC的注解
feign. Retryer 失败重试机制 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试

一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
我们用自定义日志来测试。

配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务:

  1. feign:
  2. client:
  3. config:
  4. userservice: # 针对某个微服务的配置
  5. loggerLevel: FULL # 日志级别

也可以针对所有服务:

  1. feign:
  2. client:
  3. config:
  4. default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
  5. loggerLevel: FULL # 日志级别

配置类方式

也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:

  1. package cn.itcast.order.config;
  2. public class DefaultFeignConfiguration {
  3. @Bean
  4. public Logger.Level feignLogLevel(){
  5. return Logger.Level.BASIC; // 日志级别为BASIC
  6. }
  7. }

如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:
或者在DefaultFeignConfiguration上加一个@Configuration注解,两种全局生效的办法。

  1. @EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

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

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

Feign连接池优化

Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:

  • URLConnection:默认实现,不支持连接池
  • Apache HttpClient :支持连接池
  • OKHttp:支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
这里我们用Apache的HttpClient来演示。

引入依赖

  1. <!--httpClient的依赖 -->
  2. <dependency>
  3. <groupId>io.github.openfeign</groupId>
  4. <artifactId>feign-httpclient</artifactId>
  5. </dependency>

配置连接池

  1. feign:
  2. client:
  3. config:
  4. default: # default全局的配置
  5. loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  6. httpclient:
  7. enabled: true # 开启feign对HttpClient的支持
  8. max-connections: 200 # 最大的连接数
  9. max-connections-per-route: 50 # 每个路径的最大连接数

Feign最佳实践

所谓最佳实践,就是使用过程中总结的经验,最好的一种使用方式。
观察可以发现,Feign的客户端与服务提供者的controller代码非常相似。
有没有一种办法简化这种重复的代码编写呢?

1.继承方式

一样的代码可以通过继承来共享:

  1. 定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
  2. Feign客户端和Controller都集成改接口

image-20210714190640857.png :::warning 优点:

  • 简单
  • 实现了代码共享

缺点:

  • 服务提供方、服务消费方紧耦合
  • 参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解 :::

    2.抽取方式

    将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
    例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。
    image-20210714214041796.png :::warning 基于抽取方式步骤:
  1. 新建一个maven模块,feign-api
  2. 将该抽取的feign客户端,需要的实体类,feign配置等都写到这个feign-api模块下
  3. 在消费者的pom.xml中引入这个feign-api
  4. 把消费者里面调用feign客户端的地方,都改成feign.api下面的包
  5. @EnableFeignClients扫描包,不在同一个包,扫不到的情况
    1. 指定Feign应该扫描的包@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
    2. 指定需要加载的Client接口,用哪一个就加哪一个@EnableFeignClients(clients = {UserClient.class})
    3. 指定加载的配置,@EnableFeignClients(clients = {UserClient.class},defaultConfiguration = DefaultFeignConfiguration.class) :::