文章目录
- 七、Feign远程调用
- 7.1 Feign 替代 RestTemplate
- 1）引入依赖
- 2）添加注解
- 3）编写Feign的客户端
- 4）测试
- 5）总结
- 7.2 自定义配置
- 7.2.1 配置文件方式
- 7.2.2 Java代码方式
- 7.3 Feign 使用优化
- 1）引入依赖
- 2）配置连接池
- 7.4 最佳实践
- 7.4.1 继承方式
- 7.4.2 抽取方式
- 7.4.3 实现基于抽取的最佳实践
- 1）抽取
- 2）在order-service中使用feign-api
- 3）重启测试
- 4）解决扫描包问题
七、Feign远程调用
先来看我们以前利用
RestTemplate
发起远程调用的代码：
存在下面的问题：
- 代码可读性差，编程体验不统一
- 参数复杂，
URL
Feign
是一个声明式的
http客户端
，官方地址：https://github.com/OpenFeign/feign，其作用就是帮助我们优雅的实现
http
请求的发送，解决上面提到的问题。
7.1 Feign 替代 RestTemplate
Fegin的使用步骤如下：
1）引入依赖
我们在
order-service
服务的
pom
文件中引入
feign
的依赖：
<!-- openfeign依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency> 2）添加注解
在
order-service
的启动类添加注解开启
Feign
的功能：
返回顶部
3）编写Feign的客户端
在
order-service
中新建一个接口，内容如下：
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);
} 这个客户端主要是基于
SpringMVC
的注解来声明远程调用的信息，比如：
- 服务名称：userservice
- 请求方式：GET
- 请求路径：/user/{id}
- 请求参数：Long id
- 返回值类型：User
这样，
Feign
就可以帮助我们发送
http
请求，无需自己使用
RestTemplate
来发送了。
返回顶部
4）测试
修改
order-service
中的
OrderService
类中的
queryOrderById
方法，使用
Feign
客户端代替
RestTemplate
：
是不是看起来优雅多了。
然后我们使用
nacos
的
standalone
模式(端口：
8848
)进行测试，重新运行应用程序，并在页面进行
UserClient
的测试：
可以发现查询了四次均成功了：
可以看到，在使用
RestTemplate
的时候使用
@LoadBalanced
注解使用了负载均衡，但是当我们使用
Feign
的客户端时并没有配置负载均衡，但是实际的效果可以看出
userservice：8081
、
userservice：8082
都被使用了，所以说是使用到了
Feign
集成的负载均衡：
下面我们进入依赖进一步查看，为了方便我们可以安装一个插件：
然后找到如下位置：
然后选择所有依赖进行查找，我们可以发现在
Fegin
核心下面就集成了
Ribbon
来实现负载均衡:
所以，
Feign
集成了
Ribbon
，利用
Ribbon
维护了
Payment
的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与
Ribbon
不同的是,通过
feign
只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。
返回顶部
5）总结
使用Feign的步骤：
- ① 引入依赖
- ② 添加 @EnableFeignClients 注解
- ③ 编写 FeignClient 接口
- ④ 使用 FeignClient 中定义的方法代替 RestTemplate
返回顶部
7.2 自定义配置
Feign
可以支持很多的自定义配置，如下表所示：
| 类型 | 作用 | 说明 |
| feign.Logger.Level | 修改日志级别 | 包含四种不同的级别： |
| feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做 |
| feign.codec.Encoder | 请求参数编码 | 将请求参数 |
| feign. Contract | 支持的注解格式 | 默认是 |
| feign. Retryer | 失败重试机制 | |
一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的
@Bean
覆盖默认
Bean
即可。
7.2.1 配置文件方式
下面以日志为例来演示如何自定义配置
基于配置文件修改
feign
的日志级别可以针对单个服务：
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别 也可以针对所有服务：
feign:
client:
config:
default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
loggerLevel: FULL # 日志级别 默认的日志：
FULL级别日志：
而日志的级别分为四种：
- NONE：不记录任何日志信息，这是默认值。
- BASIC：仅记录请求的方法、URL以及响应状态码和执行时间
- HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
- FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。
返回顶部
7.2.2 Java代码方式
也可以基于
Java
代码来修改日志级别，先声明一个类，然后声明一个
Logger.Level
的对象：
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) 返回顶部
7.3 Feign 使用优化
Feign
底层发起
http请求
，依赖于其它的框架。其底层客户端实现包括：
- URLConnection：默认实现，不支持连接池
- Apache HttpClient：支持连接池
- OKHttp：支持连接池
因此提高
Feign
的性能主要手段就是使用
连接池
代替默认的
URLConnection
。
这里我们用Apache的HttpClient来演示
1）引入依赖
在
order-service
的
pom.xml
中添加依赖配置：
<!--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 # 每个路径的最大连接数 接下来，在
FeignClientFactoryBean
中的
loadBalance
方法中打断点：
Debug
方式启动
order-service
服务，可以看到这里的
client
，底层就是
Apache HttpClient
：
总结，
Feign
的优化：
- 日志级别尽量用basic
- 使用
HttpClient
OKHttp
URLConnection
- ① 引入
feign-httpClient
- ② 配置文件开启
httpClient
连接池参数
返回顶部
7.4 最佳实践
所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式
自习观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：
UserController：
有没有一种办法简化这种重复的代码编写呢？
7.4.1 继承方式
一样的代码可以通过继承来共享：
1）定义一个
API接口
，利用定义方法，并基于
SpringMVC注解
做声明。
2）
Feign客户端
和
Controller
都继承（实现）该接口
优点：
- 简单
- 实现了代码共享
缺点：
- 服务提供方、服务消费方紧耦合
- 参数列表中的注解映射并不会继承，因此
Controller
返回顶部
7.4.2 抽取方式
将
Feign
的
Client
抽取为独立模块，并且把接口有关的
POJO
、默认的
Feign配置
都放到这个模块中，提供给所有消费者使用。
例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。
返回顶部
7.4.3 实现基于抽取的最佳实践
1）抽取
首先创建一个
module
，命名为
feign-api
：
项目结构：
在
feign-api
中然后引入
feign
的
starter
依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency> 然后，
order-service
中编写的
UserClient
、
User
、
DefaultFeignConfiguration
都复制到
feign-api
项目中
2）在order-service中使用feign-api
首先，删除
order-service
中的
UserClient
、
User
、
DefaultFeignConfiguration
等类或接口。
在
order-service
的
pom
文件中中引入
feign-api
的依赖：
<!-- feign-api的依赖 -->
<dependency>
<groupId>cn.itcast.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency> 修改
order-service
中的所有与上述三个组件有关的导包部分，改成导入
feign-api
中的包
3）重启测试
重启后，发现服务报错了：
这是因为
UserClient
现在在
cn.itcast.feign.clients
包下，而
order-service
的
@EnableFeignClients注解
是在
cn.itcast.order
包下，不在同一个包，无法扫描到
UserClient
。
4）解决扫描包问题
方式一：指定
Feign
应该扫描的包：
@EnableFeignClients(basePackages = "cn.itcast.feign.clients") 方式二：指定需要加载的
Client接口
：
@EnableFeignClients(clients = {UserClient.class})