SpringCloud快速入门——Feign远程调用

大家好，我是讯享网，很高兴认识大家。

前言

我们以前利用RestTemplate发起远程调用的方式有什么弊端呢？
在这里插入图片描述
讯享网
从上述代码我们可以得知

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

讯享网

于是有这样一个组件，一个声明式的http客户端——Feign，它可以帮助我们优雅的实现http请求的发送

官网地址：https://github.com/OpenFeign/feign

一、Feign替代RestTemplate

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

讯享网<!-- fegin --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>

2.添加注解：在order-service的启动类添加注解开启Feign的功能
在这里插入图片描述
3.编写Feign的客户端：在order-service中新建一个接口

package cn.beizhen.order.client; import cn.beizhen.order.pojo.User; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; / * @author : Bei-Zhen * @date : 2021-12-13 21:02 */ @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来发送了

4.测试：修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate
在这里插入图片描述
在浏览器访问

二、自定义配置

Feign可以支持很多的自定义配置，如下
在这里插入图片描述
自定义配置只需要创建自定义的@Bean覆盖默认Bean，下面以日志为例来演示如何自定义配置

1.配置文件方式：

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

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

也可以针对所有服务

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

日志的级别分为四种：

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

2.Java代码方式

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

讯享网package cn.beizhen.order.config; import feign.Logger; import org.springframework.context.annotation.Bean; / * @author : Bei-Zhen * @date : 2021-12-13 21:40 */ public class DefaultFeignConfiguration { 
    @Bean public Logger.Level feignLogLevel(){ 
    return Logger.Level.BASIC; // 日志级别为BASIC } }

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

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

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

成功日志如下
在这里插入图片描述

三、Feign使用优化

Feign底层的客户端实现如下

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

因此优化Feign的性能主要包括

使用连接池代替默认的URLConnection
日志级别，最好用basic或none

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

2.配置连接池：在order-service的application.yml中添加配置

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

四、**实践

Feign的客户端与服务提供者的controller代码非常相似，有没有一种办法简化这种重复的代码编写呢？

1.继承：给消费者的FeignClient和提供者的controller定义统一的父接口作为标准

在这里插入图片描述
缺点：服务紧耦合、父接口参数列表中的映射不会被继承

2.抽取：将FeignClient抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用
在这里插入图片描述

五、实现基于抽取的**实践

1.首先创建一个module，命名为feign-api，然后引入feign的starter依赖

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

2.将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
在这里插入图片描述
3.在order-service中引入feign-api的依赖

删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口,在order-service的pom文件中中引入feign-api的依赖

讯享网<dependency> <groupId>cn.itcast.demo</groupId> <artifactId>feign-api</artifactId> <version>1.0</version> </dependency>

4.修改order-service中的所有与上述三个组件有关的import部分，改成导入feign-api中的包

5.重启测试：发现报错
在这里插入图片描述
这是因为UserClient现在在cn.beizhen.feign.clients包下，而order-service的@EnableFeignClients注解是在cn.beizhen.order包下，不在同一个包，无法扫描到UserClient

6.解决扫描包问题：两种方式如下

指定Feign应该扫描的包

@EnableFeignClients(basePackages = "cn.beizhen.feign.clients")

指定需要加载的Client接口

讯享网@EnableFeignClients(clients = { 
   UserClient.class})

六、总结

1.Feign的使用步骤

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

如果xxx是default则代表全局
如果xxx是服务名称，例如userservice则代表某服务

方式二是java代码配置Logger.Level这个Bean

如果在@EnableFeignClients注解声明则代表全局
如果在@FeignClient注解中声明则代表某服务

3.Feign的优化：

日志级别尽量用basic
使用HttpClient或OKHttp代替URLConnection

4.不同包的FeignClient的导入有两种方式

在@EnableFeignClients注解中添加basePackages，指定FeignClient所在的包
在@EnableFeignClients注解中添加clients，指定具体FeignClient的字节码