前情提要:
一、Fegin介绍:
- Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
- 作用:帮助我们实现http请求的发送替代RestTemplate,解决上面提到的问题。
- 这里只是讲的简单的调用,实际开发需要可能需要在请求头里设置鉴权信息
二、Fegin的使用
Fegin的使用步骤如下,以order-service(消费者)为例:
a).引入依赖
我们在order-service(消费者)服务的pom文件中引入feign的依赖:
<!-- Feign远程调用 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
b).添加注解
在order-service的启动类添加注解 @EnableFeignClients 开启Feign的功能:
c).编写Feign的客户端
- 启动类下创建一个文件夹clients–>创建接口UserClient
- 注解FeignClient需要指定服务名称
- 完成接口的声明,就可以使用了
@FeignClient("userservice") // 指定服务名称
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable Long id);
}
说明:
- 这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
-
服务名称:userservice
-
请求方式:GET
-
请求路径:/user/{id}
-
请求参数:Long id
-
返回值类型:User
-
d).测试
- 记得打开Nacos哦:sh startup.sh -m standalone
修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:
@Autowired
private UserClient userClient;
// 利用 Fegin 向另一个服务器发起发起http请求
public Order queryOrderById(Long orderId) {
// 1.查询订单
Order order = orderMapper.findById(orderId);
// 2.利用 Fegin 向另一个服务器发起发起http请求
User user = userClient.findById(orderId);
// 封装到Order表
order.setUser(user);
// 4.返回
return order;
}
三、自定义配置
介绍:
Feign可以支持很多的自定义配置,例如如下五种类型以及配置:
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
一般情况下,只需要修改日志参数,其他的默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
以修改日志级别为例来演示如何自定义配置(两种实现方式)
日志的4种级别:
- NONE:不记录任何日志信息,这是默认值。
- BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
- HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
- FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
- 方式一:
基于配置文件(例如yml)修改feign的日志级别- 1.局部生效:针对单个服务(具体的服务名称):
feign: client: config: userservice: # 写具体服务名称,针对某个微服务的配置 loggerLevel: FULL # 日志级别
- 2.全局生效:针对所有服务(一定要是default这个标签)
feign: client: config: default: # 使用default为全局配置 loggerLevel: FULL # 日志级别
- 方式二:
基于Java代码来修改日志级别- 先声明一个配置类,然后声明一个Logger.Level的对象:
public class DefaultFeignConfiguration { @Bean public Logger.Level feignLogLevel(){ return Logger.Level.BASIC; // 日志级别为BASIC } }
- 选择生效范围:
- 全局生效:
- 将其放到启动类的@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
- 局部生效:
- 把它放到对应的Feing客户端–>Client的@FeignClient注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
- 全局生效:
建议:一般情况下使用BASIC或默认的NONE,因为占用性能
四、使用优化
- Feign底层的客户端实现:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient :支持连接池
- OKHttp:支持连接池
每次发送请求都需要经历连接(三次握手)和断开(四次挥手)浪费性能
- 优化手段:
-
- 日志级别最好用默认的(NONE,不记录任何日志信息)
-
- 使用连接池,替代URLConnection
-
优化:提高Feign性能(使用连接池)
- 在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 # 每个路径的最大连接数
- 接下来,在FeignClientFactoryBean中的loadBalance方法中打断点:
Debug方式启动order-service服务,可以看到这里的client,底层就是Apache HttpClient:
- 总结:
- 日志用默认的,啥也不输出
- 使用HttpClient或OKHttp代替URLConnection- 引入依赖
- 配置文件开启httpClient功能,设置连接池参数
Feign调用优化
服务的提供者和消费者之间有很多相同的地方,可以抽取出来,做一个整体的模块
有两种实现方式:
缺点:耦合度太高了,并且SpringMVC不支持
缺点:会有冗余
操作:
- 首先创建一个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项目中
- 在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中的包
!注意:他们不在同一个包,无法扫描到UserClient。
-
解决方式一:
- 在启动类中指定Feign应该扫描的包:
@EnableFeignClients(basePackages = “cn.itcast.feign.clients”)
-
解决方式二:(推荐)
- 在启动类中指定需要加载的Client接口字节码:
@EnableFeignClients(clients = {UserClient.class})
附:
链接: Fegin最佳实践分析