十、SpringCloud实用篇_Feign远程调用

Feign [feɪn]
先来看我们以前利用RestTemplate发起远程调用的代码&＃xff1a;

存在下面的问题&＃xff1a;

• 代码可读性差&＃xff0c;编码体验不统一
• 参数复杂URL&＃xff0c;难以维护

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

Feign is a Java to Http client binder inspired by Retrofit, JAXRS-2.0, and WebSocket. Feign’s first goal was reducing the complexity of binding Denominator uniformly to Http APIs regardless of ReSTfulness.
翻译&＃xff1a;Feign是受Retrofit&＃xff0c;JAXRS-2.0和WebSocket启发的Java到Http客户端绑定程序。 Feign的第一个目标是减少与ReSTfulness无关的将Denominator统一绑定到Http API的复杂性。
Feign是一个声明式的伪HTTP客户端&＃xff0c;它使得写HTTP客户端变得更简单。使用Feign&＃xff0c;只需要创建一个接口并注解。

1.1、Feign替代RestTemplate

Feign的使用步骤如下&＃xff1a;

1.1.1、引入依赖

我们在order-service服务的pom文件中引入feign的依赖&＃xff1a;

<dependency><groupId>org.springframework.cloudgroupId><artifactId>spring-cloud-starter-openfeignartifactId>
dependency>


1.1.2、添加注解

在order-service的启动类添加注解开启Feign的功能&＃xff1a;

1.1.3、编写Feign的客户端

在order-service中新建一个接口&＃xff0c;内容如下&＃xff1a;

package com.xbmu.order.client;import com.xbmu.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;&＃64;FeignClient("userservice")
public interface UserClient {&＃64;GetMapping("/user/{id}")User findById(&＃64;PathVariable("id") Long id);
}


这个客户端主要是基于SpringMVC的注解来声明远程调用的信息&＃xff0c;比如&＃xff1a;

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

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

1.1.4、测试

修改order-service中的OrderService类中的queryOrderById方法&＃xff0c;使用Feign客户端代替RestTemplate&＃xff1a;

是不是看起来优雅多了。

多请求几次http://localhost:8080/order/101&＃xff0c;发现UserApplication&＃xff08;8082&＃xff09;与UserApplication&＃xff08;8081&＃xff09;两个服务&＃xff0c;都处理了请求。

由下图可见&＃xff0c;Feign组件中已经引入了Ribbon实现负载均衡。

1.1.5、总结

使用Feign的步骤:

1. 引入依赖
2. 添加&＃64;EnableFeignClients注解
3. 编写FeignClient接口
4. 使用FeignClient中定义的方法代替RestTemplate

1.2、自定义配置

Feign可以支持很多的自定义配置&＃xff0c;如下表所示&＃xff1a;

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

1.2.1、配置文件方式

基于配置文件修改Feign的日志级别可以针对单个服务&＃xff1a;

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


也可以针对所有服务&＃xff1a;

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


测试&＃xff0c;查看日志信息&＃xff1a;

日志的级别分为四种&＃xff1a;

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

1.2.2、Java代码方式

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

package com.xbmu.order.config;import feign.Logger;
import org.springframework.context.annotation.Bean;public class DefaultFeignConfiguration {&＃64;Beanpublic Logger.Level feignLogLevel(){return Logger.Level.BASIC; // 日志级别为BASIC}
}


如果要全局生效&＃xff0c;将其放到启动类的&＃64;EnableFeignClients这个注解中&＃xff1a;

&＃64;EnableFeignClients(defaultConfiguration &＃61; DefaultFeignConfiguration.class)

如果要局部生效&＃xff0c;则把它放到对应的&＃64;FeignClient这个注解中&＃xff1a;

&＃64;FeignClient(value &＃61; "userservice",configuration &＃61; DefaultFeignConfiguration.class)

1.3、Feign使用优化

Feign底层发起http请求&＃xff0c;依赖于其它的框架。其底层客户端实现包括&＃xff1a;

• URLConnection&＃xff1a;默认实现&＃xff0c;不支持连接池
• Apache HttpClient&＃xff1a;支持连接池
• OKHttp&＃xff1a;支持连接池

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

1.3.1、引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖&＃xff1a;


<dependency><groupId>io.github.openfeigngroupId><artifactId>feign-httpclientartifactId>
dependency>


1.3.2、配置连接池

在order-service的application.yml中添加配置&＃xff1a;

feign:client:config:default: # 这里用default就是全局配置&＃xff0c;如果是写服务名称&＃xff0c;则是针对某个微服务的配置loggerLevel: BASIC #日志级别&＃xff0c;BASIC就是基本的请求和响应信息httpclient:enabled: true # 开启feign对HttpClient的支持max-connections: 200 # 最大的连接数max-connections-per-route: 50 # 每个路径的最大连接数


接下来&＃xff0c;在FeignClientFactoryBean中的loadBalance方法中打断点&＃xff1a;

Debug方式启动order-service服务&＃xff0c;可以看到这里的client&＃xff0c;底层就是Apache HttpClient&＃xff1a;

1.3.3、总结

Feign的优化&＃xff1a;

1. 日志级别尽量用BASIC
2. 使用HttpClient或OkHttp代替URLConnection
   引入feign-httpclient依赖
   配置文件开启httpclient功能&＃xff0c;设置连接池 参数

1.4、最佳实践

所谓最佳实践&＃xff0c;就是使用过程中总结的经验&＃xff0c;最好的一种使用方式。
仔细观察可以发现&＃xff0c;Feign的客户端于服务提供者的Controller代码非常相似&＃xff1a;

Feign客户端&＃xff1a;

UserController&＃xff1a;

有没有一种办法简化这种重复的代码编写呢&＃xff1f;

1.4.1、继承方式

一样的代码可以通过继承来共享&＃xff1a;

1. 定义一个API接口&＃xff0c;利用定义方法&＃xff0c;并基于SpringMVC注解做声明。
2. Feign客户端和Controller都继承该接口。
   

优点&＃xff1a;

• 简单
• 实现了代码共享

缺点&＃xff1a;

• 服务提供方、服务消费方紧耦合

• 参数列表中的注解映射并不会继承&＃xff0c;因此Controller中必须再次声明方法、参数列表、注解

1.4.2、抽取方式

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

1.4.3、实现基于抽取的最佳实践

1.4.3.1、抽取

首先创建一个module&＃xff0c;命名为feign-api&＃xff1a;

项目结构&＃xff1a;

在feign-api中&＃xff0c;引入feign的start依赖

<dependency><groupId>org.springframework.cloudgroupId><artifactId>spring-cloud-starter-openfeignartifactId>
dependency>


然后&＃xff0c;order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

1.4.3.2、在order-service中使用feign-api

首先&＃xff0c;删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。
在order-service的pom文件中引入feign-api的依赖&＃xff1a;

1.4.3.3、重启测试

重启后&＃xff0c;发现服务报错了&＃xff1a;

这是因为UserClient现在在com.xbmu.feign.client包下&＃xff0c;
而order-service的&＃64;EnableFeignClients注解是在com.xbmu.order包下&＃xff0c;不在同一个包&＃xff0c;无法扫描到UserClient。

1.4.3.4、解决扫描包问题

• 方式一&＃xff1a;
  指定feign应用扫描的包&＃xff1a;
  &＃64;EnableFeignClients(basePackages &＃61; "com.xbmu.feign.client")
  
• 方式二&＃xff1a;
  指定需要加载的Client接口&＃xff1a;
  &＃64;EnableFeignClients(clients &＃61; {UserClient.class})
  
  重启&＃xff0c;成功&＃xff1a;