文章目录
- 1、RestTemplate远程调用
- 2、基于Feign远程调用
- 3、Feign的自定义配置
- 4、Feign性能优化
- 5、Feign的最佳实践思路
- 6、案例
1、RestTemplate远程调用
在说基于Feign远程调用之前,先看一下RestTemplate发起远程调用的问题:
String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url,User.class);
url路径在代码中拼接,对于复杂的URL,这样难以维护。
2、基于Feign远程调用
Feign是一个声明式的http客户端,即声明出调谁、什么方式、参数是啥、返回类型是啥就好。调用的事有Feign帮你做。
官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
Feign的使用步骤:
- 引入依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 在对应的服务启动类添加注解
@EnableFeignClients
开启Feign功能
//在order的启动类中开启Feign
@EnableFeignClients
@MapperScan("com.llg,order.mapper")
@SpringBootApplication
public class OrderApplication{
public static void main(String[] args){
SpringApplication.run(OrderApplication.class,args);
}
}
- 编写Feign客户端,即在调用方声明接口
("userservice")
public interface UserClient{
("/user/{id}")
User findById(("id") Long id);
}
# 方法名随便起
# 路径、服务名、参数、返回类型声明正确就行
主要是基于SpringMVC的注解来声明远程调用的信息,比如:
➢服务名称:userservice
➢请求方式:GET
➢请求路径:/user/{id}
➢请求参数:Long id
➢返回值类型:User
- 声明完成后,注入FeignClient类,直接调用声明的那个方法
@Autowired
private UserClient userClient;
public Order queryOrderById(Long orderId){
//查询订单
Order order = orderMapper.findById(orderId);
//利用feign发起http请求,查用户
User user = userClient.findById(order.getUserId());
//封装,对象的某个属性也是个对象,即引用类型
order.setUser(user);
return order;
}
- 最后,Feign已经集成了负载均衡,用户无需额外操作
3、Feign的自定义配置
Feign可以运行自定义配置来覆盖默认配置,可以修改的配置如下:
自定义Feign有两种方式:
配置文件方式:
①全局生效:
feign:
client:
config:
default: # 这里用default就是全局配置,远程调用所有服务都这样。如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
②局部生效:
feign:
client:
config:
userservice: # 这里写服务名称,则是针对某个微服务的配置,只有远程调用userservice,日志级别才是FULL
loggerLevel: FULL # 日志级别
Java代码声明Bean
在config目录下加个配置类,类中声明个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)
public interface UserClient{
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
4、Feign性能优化
Feign性能调优的两个主要方向是:
- ①使用连接池代替默认的URLConnection
- ②日志级别,最好用basic或none
Feign底层的客户端实现默认用URLConnection实现,不支持连接池,可改为:
- Apache HttpClient:支持连接池
- OKHttp:支持连接池
以HttpClient为例:
- 引入HttpClient的依赖
<!--httpClient的依赖-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
- 修改application.yaml,配置连接池
feign:
client:
config:
default: # default全局的配置
loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
httpclient:
enabled: true #开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50#每个路径的最大连接数
5、Feign的最佳实践思路
思路一:继承
给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。这个父接口就像是一个契约。
但这种方式有缺陷,看官方说明:
即不推荐在服务端和客户端之间共享接口,因为它会造成紧耦合,而且SpringMVC中,父接口中方法参数继承不下来。
思路二:抽取为独立模块
将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
如上图,之前的写法,有n个服务消费者,就得写n遍FeignClient,重复开发。引入独立模块后:
服务消费者只需引入FeignClient的模块坐标依赖。这个依赖里定义了所有的远程调用接口。
6、案例
以上思路二的实现:
➢ 首先创建一个module,命名为feign-api,然后引入feign的starter依赖
➢将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
➢在order-service中引入feign-api的依赖
➢修改order-service中的所有与上述三个组件有关的import部分,改成导入feign-api中的包
➢重启测试
报错:xxxService required a bean of type 'com.feign.client.UserClient' that could not be found.
报错分析:
有UserClient这个类,但是无法注入成功,因为这个类没有创建对象,在Spring的容器里找不到这个Bean。
====>
之前没单独抽出Feign-api模块时,有UserClient对象,是因为UserClient在扫描范围内,Spring扫描到@FeignClient注解,就会创建对象。但现在扫描不到了。
orderservice扫描的包是启动类所在的包。
UserClient所在的包扫描不到,对象不会被创建,Spring容器里没有UserClient的Bean
。
当定义的FeignClient不在服务调用者的启动类SpringBootApplication的扫描包范围时,这些FeignClient无法使用。 有两种方式解决:
在启动类的@EnableFeignClients注解上加backPackages属性,指定FeignClient所在的包
@EnableFeignClients(basePackages ="cn.itcast.feign.clients")
字节码格式直接指定要哪个FeignClient类
@EnableFeignClients(clients = {UserClient.class})
两种解决方式,basePackages属性是把所有的FeignClient加载进来了,而clients属性是要哪个加载哪个,精准加载。