【微服务技术08】基于Feign远程调用
案例代码:https://gitee.com/pikachu2333/spring-cloud-hexuan
1、RestTemplate方式调用存在的问题
String url = "http://nacos-user-service/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);
代码可读性差,编程体验 不统一
参数复杂URL难以维护
2、Feign介绍
https://github.com/OpenFeign/feign
Feign是一个声明式的http客户端,其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
3、定义和使用Feign客户端
1、引入依赖
<!--feign客户端依赖-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2、在order-service的启动类添加注解开启Feign的功能:
@EnableFeignClients
3、编写Feign客户端:
@FeignClient("nacos-user-service")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
主要是基于SpringMVC的注解来声明远程调用的信息,比如:
服务名称:userservice
请求方式:GET
请求路径:/user/{id}
请求参数:Long id
返回值类型:User
4、用Feign客户端代替RestTemplate
@Autowired
private UserClient userClient;
// ...
userClient.findById(order.getUserId());
Feign的使用步骤总结:
引入依赖
添加@EnableFeignClients注解
编写FeignClient接口
使用FeignClient中定义的方法代替RestTemplate
4、自定义Feign的配置
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
配置Feign日志
方式一:配置文件方式
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL
方式二:java代码方式(推荐,后面feign-api用)
声明bean
public class FeignClientConfiguration {
@Bean
public Logger.Level feignLogLevel() {
return Logger.Level.BASIC;
}
}
1、全局配置
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
2、局部配置
`@FeignClient(value = “userservice”, configuration = FeignClientConfiguration.class)
Feign的日志配置:
方式一是配置文件,feign.client.config.xxx.loggerLevel
如果xxx是default则代表全局
如果xxx是服务名称,例如userservice则代表某服务
方式二是java代码配置Logger.Level这个Bean
如果在@EnableFeignClients注解声明则代表全局
如果在@FeignClient注解中声明则代表某服务
5、Feign性能优化
Feign底层的客户端实现:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient :支持连接池
- OKHttp:支持连接池
因此优化Feign的性能主要包括:
- 使用连接池代替默认的URLConnection
- 日志级别,最好用basic或none
1、引入HttpClient依赖
<!--引入HttpClient依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
2、配置连接池
feign:
client:
config:
default: # default全局的配置
loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
httpclient:
enabled: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
日志级别尽量用basic
使用HttpClient或OKHttp代替URLConnection
引入feign-httpClient依赖
配置文件开启httpClient功能,设置连接池参数
6、Feign的最佳实践
方式一(继承)(不推荐,提供者和消费者紧耦合,对springMVC不起作用):给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用
创建Feign-api项目模块,引入feign-starter依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
将之前消费者做的User返回对象、client、feign配置都放到此模块
在消费者模块引入自定义的feign-api;在消费者模块删除⬆️,修改引入的地址
具体看代码案例中的feign-nacos-order-service模块和feignapi模块
<!--引入feign的统一api-->
<dependency>
<groupId>com.shinchan</groupId>
<artifactId>feign-api</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。有两种方式解决:
方式一:指定FeignClient所在包
@EnableFeignClients(basePackages = "com.shinchan.feign.clients")
方式二:指定FeignClient字节码
@EnableFeignClients(clients = {UserClient.class})
不同包的FeignClient的导入有两种方式:
在@EnableFeignClients注解中添加basePackages,指定FeignClient所在的包
在@EnableFeignClients注解中添加clients,指定具体FeignClient的字节码