一:🧸问题引入
前面介绍了可以利用RestTemplate来进行远程调用,见如下代码
// 2.利用RestTemplate发起Http请求,查询用户 //2.1 url路径 String url = "http://userServer/user/" + order.getUserId(); //2.2 发送http请求,实现远程调用 User user = restTemplate.getForObject(url,User.class);
但是这种方式也是采用硬编码形式完成的,存在两个很明显的问题,一是代码可读性很差,编程体验不统一;二是参数复杂的URL难以进行维护。
这时候Feign就出现了,Feign是一个声明式的http客户端(官网地址),其作用就是帮助我们优雅地实现http请求发送,解决上面提到的两个问题。
二:🧸Feign的引入配置
- 在服务提供者的pom文件引入Feign客户端依赖
<!--feign客户端依赖--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency>
- 在服务消费者的启动类添加注解开启Feign的功能
@SpringBootApplication @EnableFeignClients //开启Feign功能 public class OrderApplication { public static void main(String[] args) { SpringApplication.run(OrderApplication.class, args); } /** * 创建RestTemplate并注入Spring容器 */ @Bean @LoadBalanced public RestTemplate restTemplate() { return new RestTemplate(); } }
- 在服务消费者中编写Feign客户端
package cn.itcast.order.client; import cn.itcast.user.pojo.User; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; @FeignClient("userServer") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }
- 在服务消费者中调用Feign客户端进行远程调用
/** * feign * @param orderId * @return */ public Order queryOrderById(Long orderId) { // 1.查询订单 Order order = orderMapper.findById(orderId); // 2.利用Feign发起Http请求,查询用户 User user = userClient.findById(order.getUserId()); // 3.封装user到Order order.setUser(user); // 4.返回 return order; }
三:🧸自定义Feign日志级别
1.方式一:配置文件方式
- 全局生效
feign: client: config: default: # 这里填写default就是全局配置,如果填写服务名称,就是针对某个具体微服务进行配置 logger-level: basic # 日志级别
- 局部生效
feign: client: config: userServer: # 这里填写default就是全局配置,如果填写服务名称,就是针对某个具体微服务进行配置 logger-level: basic # 日志级别
2.方式二:java代码方式
- 先声明一个Bean
package cn.itcast.order.config; import feign.Logger; import org.springframework.context.annotation.Bean; public class FeignClientConfig { @Bean public Logger.Level feignLogLevel() { return Logger.Level.BASIC; } }
- 全局配置
@MapperScan("cn.itcast.order.mapper") @SpringBootApplication @EnableFeignClients(defaultConfiguration = FeignClientProperties.FeignClientConfiguration.class) //开启Feign功能 public class OrderApplication { public static void main(String[] args) { SpringApplication.run(OrderApplication.class, args); } /** * 创建RestTemplate并注入Spring容器 */ @Bean @LoadBalanced public RestTemplate restTemplate() { return new RestTemplate(); } }
- 局部配置
@FeignClient(value = "userServer", configuration = FeignClientProperties.FeignClientConfiguration.class) public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }
四:🧸Feign性能优化
Feign底层客户端的实现主要有下面三个:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient:支持连接池
- OKHttp:支持连接池
因此优化Feign的性能主要包括:
- 使用连接池代替默认的URLConnection
- 日志级别,最好使用basic或者none
使用连接池进行优化
- 引入依赖:
<!--引入HttpClient依赖--> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-httpclient</artifactId> </dependency>
- 配置连接池:
feign: client: config: userServer: # 这里填写default就是全局配置,如果填写服务名称,就是针对某个具体微服务进行配置 logger-level: BASIC # 日志级别 httpclient: enabled: true # 开启feign对httpClient的支持 max-connections: 200 # 最大连接数 max-connections-per-route: 50 # 每个路径最大连接数
五:🧸最佳实践分析
我们注意到,服务提供者UserController中的请求接口和服务消费者UserClient中的接口是一样的,见下面代码
UserController
@GetMapping("/{orderId}") public Order queryOrderByUserId(@PathVariable("orderId") Long orderId) { // 根据id查询订单并返回 return orderService.queryOrderById(orderId); }
UserClient
@FeignClient(value = "userServer") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }
既然两者是一样的,那么我们可否考虑将该方法统一起来谁要用的时候直接进行调用呢?这样就可以减少很多代码量,答案是肯定的,经过最佳实践得出(不断踩坑总结出)有两种方法解决上面提到的问题,一个是继承,另一个是抽取。
1.方式一:继承
继承就是给消费者FeignClient和提供者的Controller定义统一的父接口作为标准。就举上面那个例子来说,我们可以将其封装成一个API接口,然后UserClient只需要继承这个API接口,UserController只需要实现这个接口即可,如下图所示:
但是这样做会存在一些问题,Spring中是这样介绍的:这是不被建议的,因为这样做会造成紧耦合,而且方法参数在Spring MVC中是不被接受的,也就是说Conroller层实现这个API接口时候要自己将参数进行重新定义。
2.方式二:抽取
抽取就是将FeignClient抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用,见下图:
下面介绍如何实现方式二:
- 创建一个moudle,命名为feign-api,然后引入feign的starter依赖
- 将order-service中编写的UserClient、User、DefaultFeignConfig都复制到feign-api项目中
- 在order-service中引入feign-api的依赖
<!--引入feign的统一api--> <dependency> <groupId>cn.itcast.demo</groupId> <artifactId>feign-api</artifactId> <version>1.0</version> </dependency>
- 修改order-service中所有与上述三个组件有关的import部分,改成导入feign-api中的包
package cn.itcast.order.service; import cn.itcast.feign.clients.UserClient; import cn.itcast.feign.pojo.User;
- 重启测试
可以看到启动Order服务时候报错了,提示信息为找不到实例对象,这就不对了呀,UserClient不是已经导入了吗,编译时候都通过了。说明这时候这个类确实是存在的,但是这个类无法创建对象,因此在Spring容器中无法找到该对象。原来没有将方法抽取出来时候由于启动类扫描的是自己所在的包,也是UserClient所在的包,因此可以创建对象,但是抽取出来之后UserClient类在feign包中,OrderApplication启动时候没有对这个包进行扫描,因此无法创建该对象,Spring容器中就没有这个Bean,自然就注入不成功。
这时候有两种解决方案,第一种是指定FeiginClient所在的包,即:
@MapperScan("cn.itcast.order.mapper") @SpringBootApplication @EnableFeignClients(basePackages = "cn.itcast.feign.clients") //开启Feign功能并指定扫描FeignClient所在的包 public class OrderApplication { }
不过一般不建议上面这种方式,因为扫描范围比较大,假如client中有很多client,这种方法就会将所有client拿过来,我们可以更精确地定义我们需要哪个client,因此推荐使用下面方式(当需要多个client时候可以添加逗号继续添加):
@EnableFeignClients(clients = {UserClient.class}) //开启Feign功能并指定扫描FeignClient字节码 public class OrderApplication { }
可以看到OrderApplication成功启动起来