http客户端Feign
1. RestTemplate方式调用存在的问题
- 以前利用
RestTemplate
发起远程调用的代码:
String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);
- 存在下面的问题:
①代码可读性差,编程体验不统一
②参数复杂URL难以维护
2. Feign的介绍
- Feign是一个声明式的
http
客户端,官方地址:https://github.com/OpenFeign/feign - 其作用就是帮助我们优雅的实现
http
请求的发送,解决上面提到的问题。
3. 定义和使用Feign客户端
- 使用Feign的步骤如下:
在order-service服务的pom文件中引入feign的依赖:
- 引入依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 添加注解
在order-service的启动类添加注解开启Feign的功能:
- 编写Feign的客户端
编写FeignClient的接口
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
-
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
-
restTemplate 方式调用
-
Feign远程调用方式:
// 2. 使用 Feign 远程调用
User user = userClient.findById(order.getUserId());
-
启动 orderservice 和 两个 userservice 服务,刷新 order 服务请求的列表,在userservice日志中发现,请求的规律也是遵循ribbon负载均衡的原理
-
查看 spring-cloud-starter-openfeign 依赖中可以看到已经有 ribbon
-
所以 feign 已经集成了 ribbon,自动实现了负载均衡
4. 小结
- Feign的使用步骤
①引入依赖
②添加@EnableFeignClients注解
③编写FeignClient接口
④使用FeignClient中定义的方法代替RestTemplate
5. 自定义 Feign 配置
-
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
-
一般需要配置的就是日志级别
-
日志的级别分为四种:
NONE
:不记录任何日志信息,这是默认值。BASIC
:仅记录请求的方法,URL以及响应状态码和执行时间HEADERS
:在BASIC的基础上,额外记录了请求和响应的头信息FULL
:记录所有请求和响应的明细,包括头信息、请求体、元数据。
-
下面以日志为例来演示如何自定义配置
-
配置Feign日志有两种方式:
- 方式一:配置文件方式
①全局生效:
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
- 重启服务查看完整的日志,可以看到请求和响应的日志
②局部生效:
基于配置文件修改feign的日志级别可以针对单个服务:
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
- 方式二:java代码方式,需要先声明一个Bean:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level logleavel() {
return Logger.Level.BASIC;
}
}
- 如果要全局生效,将其放到启动类的
@EnableFeignClients
注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
测试java方式全局生效如下,日志级别为 BASIC
,所以只显示记录请求的方法,URL以及响应状态码和执行时间
- 如果是局部生效,则放到对应的
@FeignClient
注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
6. 小结
Feign的日志配置:
1、方式一是配置文件,feign.client.config.xxx.loggerLevel
①如果xxx是default则代表全局
②如果xxx是服务名称,例如userservice则代表某服务
2、方式二是java代码配置Logger.Level
这个Bean
①如果在@EnableFeignClients
注解声明则代表全局
②如果在@FeignClient
注解中声明则代表某服务
7. Feign的性能优化
-
Feign底层的客户端实现:
①URLConnection
:默认实现,不支持连接池
②Apache HttpClient
:支持连接池
③OKHttp
:支持连接池 -
因此优化Feign的性能主要包括:
①使用连接池代替默认的URLConnection
②日志级别,最好用basic
或none
-
因此提高Feign的性能主要手段就是使用连接池代替默认的
URLConnection
。
7.1 Feign的性能优化-连接池配置
- 使用Apache的HttpClient来演示
- Feign添加HttpClient的支持:
- 引入依赖:
在order-service的pom文件中引入Apache的HttpClient依赖:
<!--httpClient的依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
- 配置连接池
在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 # 每个路径的最大连接数
8. 小结
Feign的优化:
- 日志级别尽量用
basic
- 使用
HttpClient
或OKHttp
代替URLConnection
①引入feign-httpClient依赖
②配置文件开启httpClient功能,设置连接池参数
9. Feign的最佳实践
- 方式一(继承):给消费者的
FeignClient
和提供者的controller
定义统一的父接口作为标准。
-
服务紧耦合
-
父接口参数列表中的映射不会被继承
-
通常不建议在服务器和客户端之间共享接口。它引入了紧密耦合,并且实际上,当前形式的Spring MVC也不适用(方法参数映射不是继承的)。
- 方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用
10. 小结
Feign的最佳实践:
①让controller和FeignClient继承同一接口
②将FeignClient、POJO、Feign的默认配置都定义到一个项目中,供所有消费者使用
11. 抽取 FeignClient
实现最佳实践方式二的步骤如下:
- 首先创建一个module,命名为feign-api,然后引入feign的starter依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
-
将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
-
在order-service中引入feign-api的依赖
<dependency>
<groupId>cn.xdr630.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
- 修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
- 重启测试
重启后,发现报错了
- 这是因为UserClient现在在cn.itcast.feign.clients包下,而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。
- 解决扫描包问题
方式一:
指定Feign应该扫描的包:
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
方式二:
指定需要加载的Client接口
@EnableFeignClients(clients = {UserClient.class})
- 重启后就没有问题了
12. 小结:
不同包的FeignClient的导入有两种方式:
①在@EnableFeignClients
注解中添加basePackages
,指定FeignClient
所在的包
②在@EnableFeignClients
注解中添加clients
,指定具体FeignClient
的字节码
- 点赞
- 收藏
- 关注作者
评论(0)