一、OpenFeign替代RestTemplate
RestTemplate 存在的问题
我们以前利用RestTemplate发起远程调用的代码
public Order queryOrderById(Long orderId) {
// 1.查询订单
Order order = orderMapper.findById(orderId);
// 2.利用restTemplate发起http请求
// 为了负载均衡使用服务名称
String url = "http://userservice/user/" + order.getUserId();
// 得到的结果是json风格,getForObject()可以将json反序列化!
User user = restTemplate.getForObject(url, User.class);
// 3.封装user到Order
order.setUser(user);
// 4.返回
return order;
}
但是这样子写,是有一定缺陷的:
代码可读性差,编程体验不统一
参数复杂URL难以维护
OpenFeign是一个声明式的http客户端。
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
1.引入依赖
我们在order-service服务的pom文件中引入OpenFeign的依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2.添加注解
在order-service的启动类添加注解开启OpenFeign的功能
3.编写Feign的客户端
定义一个接口,使用@FeignClient注解,并指明服务名称
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
服务名称:userservice
请求方式:GET
请求路径:/user/{id}
请求参数:Long id
返回值类型:User
OpenFeign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
4.测试方法
public Order queryOrderById(Long orderId) {
// 查询订单
Order order = orderMapper.findById(orderId);
// 用OpenFegin远程调用
User user = userClient.findById(order.getUserId());
order.setUser(user);
return order;
}
这样子我们避免了代码量大的时候,会出现一堆的URL路径。
像调API一样的进行远程调用!
5.小结-使用Feign的步骤
① 引入依赖
② 添加 @EnableFeignClients注解
③ 编写 FeignClient接口
④ 使用FeignClient中定义的方法代替RestTemplate
Feign 和 OpenFeign 两者的异同点
相信很多人在这一方面有很多疑问!
具体可以看这一篇文章:【SpringCloud】Feign 和 OpenFeign 两者的异同点
对于这两者,我们可以简单的理解为:OpenFeign是Fegin的升级版!
1.官网地址差异
https://github.com/Netflix/feign 和 https://github.com/OpenFeign/feign。
不过现在访问https://github.com/Netflix/feign 已经被重定向到了后者上。
2. 发布历史
Netflix Feign:1.0.0发布于2013.6,于2016.7月发布其最后一个版本8.18.0
Open Feign:首个版本便是9.0.0版,于2016.7月发布,然后一直持续发布到现在(未停止)
也就是说,Netflix Feign仅仅只是改名成为了Open Feign而已,然后Open Feign项目在其基础上继续发展至今。
9.0版本之前它叫Netflix Feign,自9.0版本起它改名叫 Open Feign了。
3. SpringCloud的1.x与2.x版本差别
spring-cloud-starter-openfeign是为Spring Cloud2.x准备的,只不过维持了一段时间的对1.x的兼容。
而spring-cloud-starter-feign是专为Spring Cloud1.x服务。
1.x版本包名是 org.springframework.cloud.netflix.feign.FeignClient,所在Jar是 spring-cloud-netflix-core
说明:这里的1.x不仅仅指的feign,还包括openfeign的1.4.x版本哦
2.x版本包名是 org.springframework.cloud.openfeign.FeignClient,所在Jar是 spring-cloud-openfeign-core
二、自定义配置
Feign可以支持很多的自定义配置,配置信息如下:
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
下面以日志为例来演示如何自定义配置的!总结下来大致有2种方式:
- 配置文件方式
使用application.yml配置文件来修改feign的日志级别可以针对单个服务、也可以是所有服务(全局)!
单个服务配置
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
全局配置
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
fegin的日志级别(四种)
NONE:不记录任何日志信息,这是默认值。
BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
- Java代码方式
也可以基于Java代码来修改日志级别
(1)先声明一个类,再声明Logger.Level的对象
// 声明一个类
public class DefaultFeignConfiguration {
@Bean
// 声明一个Logger.Level的对象
public Logger.Level logLevel() {
return Logger.Level.BASIC;
}
}
(2)修改相应注解中的参数
使用上一步声明配置类,修改@FeignClient、@EnableFeignClients注解中的参数配置
单个服务配置
如果是局部生效,则把它放到对应的@FeignClient这个注解中
@FeignClient(value = "userservice",
configuration = FeignClientsConfiguration.class)
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
全局配置
如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中
...
@EnableFeignClients(clients = UserClient.class,
defaultConfiguration = DefaultFeignConfiguration.class)
public class OrderApplication {
...
}
三、OpenFeign使用优化
Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
URLConnection:默认实现,不支持连接池
Apache HttpClient :支持连接池
OKHttp:支持连接池
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection!
- 引入依赖
在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 # 每个路径的最大连接数
Feign的连接池中配置的连接数的大小是不一定的,需要我们用压测工具去计算!
优化小结
日志级别尽量用basic或者none,尽量不要使用更高基本的日志!
使用HttpClient或OKHttp代替URLConnection,尽量使用连接池的方式!
四、最佳实践
所谓最佳实践,就是使用过程中总结的经验,最好的一种使用方式!
我们对于Feign来说,大致是有两套方案——继承方式、抽取方式
1.继承方式
我们可以参考一下之前的代码。
feign客户端
UserController
这两者的代码看起来很相似,有没有办法简化???
有,可以使用继承的方式!
(1)定义一个 API接口,利用定义方法,并基于 SpringMVC注解做声明。
(2)Feign客户端和Controller 都集成该接口
如图:
优点
简单
实现了代码共享
缺点
服务提供方、服务消费方紧耦合
参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解
因此,这种方式99.99%没人用!
2. 抽取方式
将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。
抽取后的项目结构图
cloud-demo模块间结构图
抽取过程中的步骤以及可能出现的问题
(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的依赖
<dependency>
<groupId>cn.itcast.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包
(3)BUG描述
将项目重启,发现报错了!!!
这是因为UserClient现在在cn.itcast.feign.clients包下,
而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。
(4)解决方案
给OrderApplication之前的注解添加属性——basePackages、clients
方式一
指定Feign应该扫描的包
@EnableFeignClients(basePackages="cn.itcast.feign.clients")
方式二
指定需要加载的Client接口
@EnableFeignClients(clients= {UserClient.class})