HTTP 客户端 Feign
RestTemplate 方式调用存在的问题:
- 代码可读性差,编程体验不统一
- 参数复杂的 URL 难以维护
Feign的介绍
Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
步骤:
- 引入依赖:
<dependency>
<groupId>org.springframework cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 在order-service的启动类添加注解开启Feign的功能:
@EnableFeignClients
@MapperScan("cn.itcast.order mapper")
@SpringBootApplication
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
- 编写Feign客户端:
@FeignClient ("userservice")
pubtic interface userCLRtt{
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
主要是基于SpringMVC的注解来声明远程调用的信息,比如:
- 服务名称:userservice
- 请求方式:GET
- 请求路径:/user/{id}
- 请求参数:Long id
- 返回值类型:User
- 使用 feign :
@Autowired
private UserClient userClient;
public Order queryOrderById(Long orderId) {
// 1.查询订单
Order order = orderMapper.findById(orderId);
User user = userClient.findById(order.getUserId());
order.setUser(user);
return order;
}
自定义 feign 的配置
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
一般我们需要配置的就是日志级别。
方式一:配置文件方式
① 全局生效:
loggerLevel: FULL # 日志级别
feign:
client:
config:
default: #这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loqaerLevel:FULL # 日志级别
② 局部生效:
feign:
client:
config:
userservige: #这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loqaerLevel:FULL # 日志级别
配置Feign日志的方式二:java代码方式,需要先声明一个Bean:
public class FeignclientConfiguration {
@Bean
public Logger.Level feignLogLevel){
return Logger .Level.BASIC;
}
}
① 而后如果是全局配置,则把它放到@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)
② 如果是局部配置,则把它放到@FeignClient这个注解中:
@Feignclient (value = "userservice", configuration = FeignclientConfiguration.class)
Feign的性能优化
Feign底层的客户端实现:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient: 支持连接池
- OKHttp:支持连接池
Feign 添加 HttpClient 的支持
引入依赖:
<!--httpClient的依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
配置连接池:
feign:
client:
config:
default: # default全局的配置
LoggerLevel:BASIC #日志级别,BASIC就是基本的清求和响应信息
httpclient:
enabled: true # 开启feign对HttpClient的支持max-connections:200 # 最大的连接数
max-connections-per-route:50 # 每个路径的最大连接数
Feign 的最佳实践
方式一(继承):给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
方式二(抽取):将FeignClient抽取为独立模块,并且把接口有关的PQJ0、默认的Feign配置都放到这个模块中,提供给所有消费者使用
总结:
- 让controller和FeignClient继承同一接口
- 将FeignClient、POJO、Feign的默认配置都定义到一个项目中,供所有消费者使用
抽取 FeignClient 实现
- 首先创建一个module,命名为feign-api,然后引入feign的starter依赖
- 将Userclient、User、DefaultFeignConfiguration都复制到feign-api项目中
- 在order-service中引入feign-api的依赖
- 修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
- 重启测试
注:
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。有两种方式解决:
方式一:指定FeignClient所在包
@EnableFeignClients(basePackages = "cn.itcast.feign.clients")
方式二:指定FeignClient字节码
@EnableFeignClients(clients = {UserClient.class})