微服务04_http客户端Feign

RestTemplate 的问题：

我们以前利用 RestTemplate 发起远程调用的代码：
通过URL地址指明要访问的服务名称和请求路径，以及请求的参数信息。
由restTemplate帮我们发起请求，再把结果转为对应类型。

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

一、Feign介绍：

Feign 是一个声明式的 http 客户端，官方地址：https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现 http 请求的发送，解决上面提到的问题。

二、Feign使用

1、基本使用

1.引入依赖

我们在 order-service 引入 feign 依赖

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

2.添加注解

在 order-service 启动类添加注解开启 Feign @EnableFeignClients

3.申明请求接口

在 order-service 中新建一个接口，内容如下

申明一个远程调用，定义接口xxxClient，里面封装的是：所有对xxx发起的远程调用。

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;

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

-----
@FeignClient("userservice")：其中参数填写的是微服务名

@GetMapping("/user/{id}")：其中参数填写的是请求路径

这个客户端主要是基于 SpringMVC 的注解 @GetMapping 来声明远程调用的信息

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

主要是基于SpringMVC的注解来声明远程调用的信息：

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

4.测试：

@Autowired
private UserClient userClient;

public Order queryOrderAndUserById(Long orderId) {
    // 1.查询订单
    Order order = orderMapper.findById(orderId);
    // TODO: 2021/8/20 使用feign远程调用
    User user = userClient.findById(order.getUserId());
    // 3. 将用户信息封装进订单
    order.setUser(user);
    // 4.返回
    return order;
}

2、自定义配置

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

方式一：修改日志级别：配置文件：全局、局部

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的 @Bean 覆盖默认 Bean 即可。下面以日志为例来演示如何自定义配置。

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

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

也可以针对所有服务：

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

• 而日志的级别分为四种：
  NONE：不记录任何日志信息，这是默认值。
  BASIC：仅记录请求的方法，URL以及响应状态码和执行时间。【日常最多需要BASIC】
  HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
  FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。【调试错误才会用到】

方式二：java代码修改日志级别：全局、局部

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

package cn.itcast.order.config;

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

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

日志模式：BASIC模式：仅记录请求的方法，URL以及响应状态码和执行时间。【日常最多需要BASIC】
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

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

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

三、性能优化

Feign底层的客户端实现：

• URLConnection：默认实现，不支持连接池
• apache HttpClient：支持连接池
• OKHttp：支持连接池

默认URLConnection不带连接池，替换带有连接池的

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

URLConnection：默认实现，不支持连接池
Apache HttpClient ：支持连接池
OKHttp：支持连接池

Feign是一个声明式客户端，将申明变为http请求，最终发送http请求时，还是会用到其他客户端。
默认是URLConnection客户端，是JDK中自带的一种，而实现性能不是最优的，并且不支持连接池【连接池的作用：减少连接创建和销毁的性能损耗，因为每次创建都需要三次握手、断开需要四次挥手。】从而浪费资源性能，从而尽可能的减少操作。所以说需要连接池

因此提高 Feign 性能的主要手段就是使用连接池代替默认的 URLConnection
另外，日志级别应该尽量用 basic/none，可以有效提高性能。

这里我们用 Apache 的HttpClient来演示连接池。

1.引入依赖

在 order-service 的 pom 文件中引入 HttpClient 依赖
已经被spring管理起来了

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

2. 配置连接池

配置连接池

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

在 FeignClientFactoryBean 中的 loadBalance 方法中打断点

Debug 方式启动 order-service 服务，可以看到这里的 client，底层就是 HttpClient

四、最佳实践

1、继承方式。让controller和FeignClient继承同一接口

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

1）定义一个 API 接口，利用定义方法，并基于 SpringMVC 注解做声明

2）Feign 客户端、Controller 都集成该接口

• 优点
  简单
  实现了代码共享

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

2、抽取方式。

例如有一个用户信息模块，当订单模块和物流模块，甚至有很多模块都需要查用户模块时。
那么userClient相当于写了很多遍【因为在每个调用用户模块都需要写一遍client】

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

步骤：

1. 首先创建一个module，命名为feign-api，然后引入feign的starter依赖
2. 将order-service中编写的UserClient、User、DefaultFeignConfigruation都复制到feign-api项目中
3. 在order-service中引入feign-api的依赖
4. 修改order-service中的所有与上述三个组件相关的import部分，改为导入feign-api中的包

接下来我们就用该方法在代码中实现

首先创建一个 module，命名为 feign-api

在 feign-api 中然后引入依赖

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

order-service中的 UserClient、User 都复制到 feign-api 项目中

在order-service中使用 feign-api

首先，删除 order-service 中的 UserClient、User

在 order-service 中引入 feign-api

<dependency>
    <groupId>com.xn2001.feign</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

• 启动项目：oder/ user：发现问题是： spring扫描不到bean了
  

解决方法是：修改注解

当定义的 FeignClient 不在 SpringBootApplication 的扫描包范围下时，这些 FeignClient 就不能使用。

• 方式一：指定FeignClient所在包：
  修改 order-service 启动类上的 @EnableFeignClients 注解
  @EnableFeignClients(basePackages = "com.itcast.feign.clients")

• 方式二：指定加载FeignClient字节码文件（是数组，或多个）
  @EnableFeignClients(clients={UserClient.class})