Feign远程调用

矫情吗；* 2024-03-27 13:32 169阅读 0赞

1. Feign远程调用

为啥需要学Feign呢？我们先来回顾之前写的代码

先来看我们以前利用RestTemplate发起远程调用的代码：

img

这里就有几个问题：

  • 代码可读性差，编程体验不统一
  • 参数复杂URL难以维护

而Feign是一个声明式的http客户端。其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题

1.1. Feign替代RestTemplate

1.1.1. 引入依赖

我们在order-service服务的pom文件中引入feign的依赖：

  1. <dependency>
  2.     <groupId>org.springframework.cloud</groupId>
  3.     <artifactId>spring-cloud-starter-openfeign</artifactId>
  4. </dependency>

1.1.2. 添加注释

在order-service的启动类添加注解开启Feign的功能：

img

1.1.3. 编写Feign的客户端

在order-service中新建一个接口，内容如下：

  1. @FeignClient("userservice")
  2. public interface UserClient {
  5.     @GetMapping("/user/{id}")
  6.     User findById(@PathVariable("id") Long id);
  7. }

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

  • 服务名称：userservice
  • 请求方式：GET
  • 请求路径：/user/{id}
  • 请求参数：Long id
  • 返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了

1.1.4. 总结

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

1.2. 自定义配置

Feign可以支持很多的自定义配置，如下表所示：

般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可

下面以日志为例来演示如何自定义配置：

1.2.1. 配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务：

  1. feign:  
  2.   client:
  3.     config: 
  4.       userservice: # 针对某个微服务的配置
  5.         loggerLevel: FULL #  日志级别

也可以针对所有服务：

  1. feign:  
  2.   client:
  3.     config: 
  4.       default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
  5.         loggerLevel: FULL #  日志级别

1.2.2. 2.2 Java代码方式

也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

  1. public class DefalutFeignConfiguration {
  4.     @Bean
  5.     public Logger.Level feignLogLevel(){
  8.         return Logger.Level.BASIC; // 日志级别为BASIC
  9.     }
  10. }

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

  1. @EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

  1. @FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

1.3. Feign使用优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

这里我们用Apache的HttpClient来演示：

1）引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

  1. <!--httpClient的依赖 -->
  2. <dependency>
  3.     <groupId>io.github.openfeign</groupId>
  4.     <artifactId>feign-httpclient</artifactId>
  5. </dependency>

2）配置连接池

在order-service的application.yml中添加配置：

  1. feign:
  2.   client:
  3.     config:
  4.       default: # default全局的配置
  5.         loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  6.   httpclient:
  7.     enabled: true # 开启feign对HttpClient的支持
  8.     max-connections: 200 # 最大的连接数
  9.     max-connections-per-route: 50 # 每个路径的最大连接数

总结Feign的优化：

使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能，设置连接池参数

1.4. 最佳实践

所谓最佳实践，就是使用过程中总结的经验，最好的一种使用方式。

自习观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端：

img

UserController：

img

有没有一种办法简化这种重复的代码编写呢？

1.4.1. 继承方式

一样的代码可以通过继承来共享：

  1. 定义一个API接口，利用定义方法，并基于SpringMVC注解做声明
  2. Feign客户端和Controller都集成改接口

img

优点：

  • 简单
  • 实现了代码共享

缺点：

参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

1.4.2. 抽取方式

Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用

img

1.4.3. 实现基于抽取的最佳实践

1.4.3.1. 抽取

首先创建一个module，命名为feign-api：

img

项目结构：

img

在 feign-api 中然后引入feign的starter依赖：

  1. <dependency>
  2.     <groupId>org.springframework.cloud</groupId>
  3.     <artifactId>spring-cloud-starter-openfeign</artifactId>
  4. </dependency>

然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

img

1.4.3.2. 在order-service中使用 feign-api

首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口

在order-service的pom文件中中引入feign-api的依赖：

  1. <dependency>
  2.     <groupId>com.xn2001.feign</groupId>
  3.     <artifactId>feign-api</artifactId>
  4.     <version>1.0</version>
  5. </dependency>

修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包

1.4.3.3. 重启测试

重启后，发现服务报错了：

img

这是因为UserClient现在在cn.itcast.feign.clients包下，

而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。

1.4.3.4. 解决扫描包问题

方式一：

指定Feign应该扫描的包：（不推荐）

  1. @EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二：

指定需要加载的Client接口：

  1. @EnableFeignClients(clients = {
  3.         UserClient.class})

发表评论

表情：
评论列表 （有 0 条评论，169人围观）

还没有评论，来说两句吧...

相关阅读

    相关 Feign远程调用

    1. Feign远程调用 > 为啥需要学Feign呢？我们先来回顾之前写的代码 先来看我们以前利用RestTemplate发起远程调用的代码： ![img][] 这

    矫情吗；*矫情吗；*/ 0 赞/ 170 阅读

    相关 Feign远程调用

    Feign远程调用 先来看我们以前利用RestTemplate发起远程调用的代码： ![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-

    短命女短命女/ 0 赞/ 80 阅读