Feign远程调用
先来看我们以前利用RestTemplate发起远程调用的代码:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-T0v19FlM-1692966428312)(C:\Users\19627\AppData\Roaming\Typora\typora-user-images\image-20230825184934500.png)]
存在下面的问题:
•代码可读性差,编程体验不统一
•参数复杂URL难以维护
Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
1使用Feign代替RestTemplate
1.引入依赖
<!--feign客户端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2.添加注解
在order-service的启动类添加注解开启Feign功能
@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
3.编写Feign客户端
在order-service中新建一个接口,内容如下
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable Long id);
}
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
4.测试
修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate
@Autowired
private UserClient userClient;
public Order queryOrderById(Long orderId) {
// 1.查询订单
Order order = orderMapper.findById(orderId);
//2.使用feign远程调用
User user = userClient.findById(order.getUserId());
order.setUser(user);
// 4.返回
return order;
}
5.总结
使用Feign的步骤:
1引入Feign起步依赖
2添加@EnableFeignClients注解
3编写FeignClient接口
4使用FeignClient中定义的方法
2自定义配置
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即可。
2.1配置文件方式
基于配置文件修改feign的日志级别可以针对单个服务
1)全局配置
feign:
client:
config:
default: #default为全局配置
loggerLevel: FULL #FULL级别为全部日志
2)针对单个微服务的配置
feign:
client:
config:
userservice: #default为全局配置
loggerLevel: FULL #FULL级别为全部日志
2.2Java代码方式
也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level level() {
return Logger.Level.BASIC;
}
}
- 全局生效 将其放到启动类的@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
- 局部生效 则把它放到对应的@FeignClient这个注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
3Feign的性能优化
Feign底层发起http请求,依赖于其他的框架,底层客户端实现包括:
•URLConnection:默认实现,不支持连接池
•Apache HttpClient :支持连接池
•OKHttp:支持连接池
因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。
这里我们用Apache的HttpClient来演示。
3.1引入依赖
在order-service中的pom文件引入Apache的HttpClient依赖
<!--引入HttpClient依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
3.2配置连接池
在order-service的application.yml中添加配置
feign:
httpclient:
enabled: true #支持httpclient开关
max-connections: 200 #最大连接数
max-connections-per-route: 50 #单个请求路径是最大连接数
总结:feign的优化:
1.日志级别尽量使用basic或者不添加
2.使用HttpClient或者OKHttp来代替URLConnection
3.引入feign-httpClient依赖
4.配置文件开启httpClient功能,设置连接池参数
4Feign的最佳实践
4.1继承方法
一样的代码可以通过继承来共享:
1)定义一个API接口,利用定义方法,并给予SpringMVC注解做声明
2)Feign客户端和Controller都继承改接口
优点:
- 简单
- 实现了代码共享
缺点:
- 服务提供方,服务消费方紧耦合
- 参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法,参数列表和注解
4.2抽取方式
将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-n0pVJMNg-1692966428314)(C:\Users\19627\AppData\Roaming\Typora\typora-user-images\image-20230825200753091.png)]
4.3实现抽取方式的最佳实践
抽取
新建一个模块,命名为feign-api
在feign-api中然后引入feign的starter依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
在order-service中使用feign-api
首先,order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
然后,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。
在order-service的pom文件中引入feign-api依赖
<!--引入feign的api-->
<dependency>
<groupId>cn.itcast</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
解决扫描包的问题
因为UserClient现在在cn.itcast.feign.clients包下,
而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。
- 方法一:指定Feign应该扫描的包
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
- 方法二:指定需要加载的Client接口
@EnableFeignClients(clients = {UserClient.class})
n.clients包下,
而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。
- 方法一:指定Feign应该扫描的包
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
- 方法二:指定需要加载的Client接口
@EnableFeignClients(clients = {UserClient.class})