http客户端Feign
1 RestTemplate方式调用存在的问题:
先来看我们以前利用RestTemplate发起远程调用的代码:
String url = "http://userservice/user/"+order.getUserId();
User user = restTemplate.getForObject(url, User.class);
存在下面的问题:
-
代码可读性差,编程体验不统一 -
参数复杂URL难以维护
Feign的介绍
Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
定义和使用Feign客户端
使用Feign的步骤如下∶
-
引入依赖:
<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客户端:
- 编写UserClient接口,声明Url请求路径和需要调用的方法
@FeignClient("userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable ("id") Long id);
}
@Autowired
private UserClient userClient;
public Order queryOrderById(Long orderId) {
Order order = orderMapper.findById(orderId);
User user = userClient.findById(order.getUserId());
order.setUser(user);
return order;
}
主要是基于SpringMVC的注解来声明远程调用的信息,比如∶
-
服务名称: userservice -
请求方式:GET -
请求路径:/user/ {id} -
请求参数:Long id -
返回值类型:User
2 自定义Feign配置
Feign运行自定义配置来覆盖默认配置,可以修改的配置如下:
一般我们需要配置的就是日志级别。
配置Feign日志有两种方式:
方式一:配置文件方式
- 全局生效
feign:
client:
config:
default:
loggerLevel: Full
- 局部生效
feign:
client:
config:
orderservice:
loggerServer: Full
方式二:java代码方式,需要声明一个Bean:
public class DefaultFeignConfiguration {
@Bean
public Logger logLevel(){
return Logger.Level.BASIC;
}
}
- 而后如果是全局配置,则把它放到@EnableFeignClients这个注解中:
- 如果是局部配置,则把它放到@FeignClient这个注解中:
3 Feign的性能优化
Feign底层的客户端实现:
因此优化Feign的性能主要包括:
- 使用连接池代替默认的URLConnection
- 日志级别,最好用basic或none
Feign添加HttpClient的支持:
引入依赖:
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
配置连接池:
feign:
httpclient:
enabled: true
max-connections: 200
max-connections-per-route: 50
4 Feign的最佳实践
方式一(继承)∶给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。
方式二(抽取)︰将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用
将公共业务抽取出来作为一个独立的模块,通过调用的方式进行访问
抽取FeignClient:
实现最佳实践方式二的步骤如下:
- 首先创建一个module,命名为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的依赖
<dependency>
<groupId>cn.itcast.demo</groupId>
<artifactId>feign-api</artifactId>
<version>1.0</version>
</dependency>
-
修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包 -
重启测试
当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些FeignClient无法使用。有两种方式解决:
方式一:指定FeignClient所在包(扫描全部,不需要的也会扫描到)
@EnableFeignclients(basePackages = "cn.itcast.feign.clients" )
方式二:指定FeignClient字节码(推荐使用,只扫描你指定的)
@EnableFeignclients(clients = {Userclient.class})
方式一:指定FeignClient所在包(扫描全部,不需要的也会扫描到)
@EnableFeignclients(basePackages = "cn.itcast.feign.clients" )
方式二:指定FeignClient字节码(推荐使用,只扫描你指定的)
@EnableFeignclients(clients = {Userclient.class})
|