Feign远程调用

---

利用RestTemplate发起远程调用的代码存在下面的问题：

• 代码可读性差，编程体验不统一
• 参数复杂URL难以维护

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

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

使用步骤

---

① 引入依赖
② 添加@EnableFeignClients注解
③ 编写FeignClient接口
④ 使用FeignClient中定义的方法代替RestTemplate

扩展：查看依赖可以知道feign底层是依赖了ribbon的包

1）引入依赖

我们在order-service服务的pom文件中引入feign的依赖：

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

2）添加注解

在order-service的启动类添加注解开启Feign的功能：

可以注释掉以下代码

@Bean
@LoadBalanced
public RestTemplate restTemplate() {
    return new RestTemplate();
}

3）编写Feign的客户端

1. 在order-service中创建一个包client
2. 新建一个接口，内容如下：
   1. 指定服务的名字
   2. 指定访问地址
   3. 方法参数的注入

package cn.itcast.order.client;

import cn.itcast.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * Fegin客户端职责：声明要调用的接口信息
 */

@FeignClient("userservice")  //指定服务的名字
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

• 服务名称：userservice
• 请求方式：GET
• 请求路径：/user/{id}
• 请求参数：Long id
• 返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

检查一下order-service中application.yml中nocas服务器地址是否正确，注：注释掉命名空间和集群的配置

spring:
  application:
    name: orderservice

  cloud:
    nacos:
      server-addr: localhost:80
#      discovery:
#        cluster-name: HZ
#        namespace: a8ace27d-a737-4122-9f3f-92f5ee795b62
#        ephemeral: false

自定义配置

---

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

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE(默认)、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign.Contract	支持的注解格式	默认是SpringMVC的注解
feign.Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

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

配置文件方式

以修改order-service为例：

1. 基于配置文件修改feign的日志级别可以针对单个要调用的服务：

feign:  
  client:
    config: 
      userservice:  # 针对某个微服务的配置
        loggerLevel: BASIC #  日志级别

2. 也可以针对所有服务：default

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

注：配置default.loggerLevel的时候idea中没有提示信息，如果同时两个都配置，则优先使用userservice。

要想看到输出的日志信息，需要将系统日志级别设置为debug才能看到。

logging:
  level:
    cn.itcast: debug

feign:
  client:
    config:
      userservice:
        loggerLevel: BASIC
      default:
        loggerLevel: FULL

而日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。
• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

Java代码方式

1. 也可以基于Java代码来修改日志级别，先声明一个类放在config包中，然后声明一个Logger.Level的对象：

package cn.itcast.order.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;

public class DefaultFeignConfiguration {

    @Bean
    public Logger.Level loggerLevel() {
        // 日志级别为BASIC，这是个枚举类型
        return Logger.Level.BASIC;
    }
}

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)

3. 如果是局部生效，则把它放到UserClient接口对应的@FeignClient这个注解中，将上面的defaultConfiguration部分去掉

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

Feign使用优化

---

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

• URLConnection：默认实现，不支持连接池。每次创建连接要三次握手，结束连接还要四次挥手。
• Apache HttpClient ：支持连接池
• OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

使用Apache的HttpClient

1）引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

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

2）配置连接池

在order-service的application.yml中添加配置，默认是开启的，所以就算没有配置也会一些默认的配置参数

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

说明：每个不同的微服务连接路径是不同的，如：访问user-service这个微服务就是一条路径，最多有50个连接。通常最大连接数除以一共有多少个微服务，则每个微服务平均占用多少个连接。后期可再根据访问性能的变化进行调整。

在FeignClientFactoryBean中的loadBalance方法335行中打断点可以查看实现类对象

注：只有重启的时候会进来一次断点，后面访问就不再进入这个断点了

Feign最佳使用方式

---

由于远程调用是每个微服务几乎都需要进行的，所以Feign的代码重用度就会很高，于是就可以把Feign客户端及所依赖的类抽取到一个公共模块，要调用Feign客户端接口服务就依赖公共模块即可。

抽取方式

将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。

在feign-api模块中导入相关依赖

<dependencies>
  <!-- feign的依赖 -->
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
  </dependency>
  <!--httpClient的依赖 -->
  <dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
  </dependency>
</dependencies>

解决扫描包问题

方式一：

指定Feign应该扫描的包：对整个包下所有的接口生成代理对象

@EnableFeignClients(basePackages = "cn.itcast.feign.client")

方式二：

指定需要加载的Client接口：对指定的接口生成代理对象

@EnableFeignClients(clients = {UserClient.class})