Feign远程调用

2024-08-06 245

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

本文涉及的产品

容器镜像服务 ACR，镜像仓库100个不限时长

应用实时监控服务-可观测链路OpenTelemetry版，每月50GB免费额度

MSE Nacos/ZooKeeper 企业版试用，1600元额度，限量50份

简介： 本节基于Feign实现替换RestTemplate发起Http请求，在此过程中会发现技术演进的过程是不断变化的，最初引入RestTemplate的确帮我们解决了跨服务调用，但是随着更为优雅的技术出现时，我们会毫不犹豫去实践更佳的解决方案，这也是我们最初提出单体架构-->分布式架构的演变过程。本节希望能重点关注Feign提出的初衷，最佳实践，并能够结合最佳实践在日后工作中得以落地。

回顾最初我们为了实现跨服务调用时，在不使用Dubbo这种RPC协议时，我们借助了RestTemplate对象实现跨服务调用，为了解决跨服务调用时调用地址写死的问题我们又引入了注册中心，从而实现根据服务名的调用。但是回过头来查看我们这段调用方法，依然存在服务地址硬编码、代码阅读性差的问题。

// 2.1 拼接请求用户中心的地址
String url = "http://userservice/user/" +  userId;

// 2.2 请求用户中心
return restTemplate.getForObject(url, User.class);

那么就没有更优雅的HTTP协议跨服务调用解决方案吗？本章节Feign就是解决我们上述问题的方案之一。

1 Feign替代RestTemplate

1.依赖引入

在order-service中引入feign依赖

<!--feign依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2.添加注解

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

3.编写Feign客户端

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

package cn.itcast.order.client;

import cn.itcast.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

此客户端作用是基于SpringMVC的注解来声明远程调用的信息，Feign就可以发送http请求，如：

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

4.测试

修改order-service中OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate：

2.自定义配置

Feign可以支持多种自定义配置，总结如下

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

一般情况下默认值即可满足使用，如需自定义只需创建自定义的@Bean覆盖默认即可，以日志级别为例：

1.配置文件修改

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

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别

也可以针对全部服务：

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

日志的级别分为四种：

NONE：不记录任何日志信息，这是默认值。
BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据

2.Java代码修改

除了配置文件类型，也可通过Java代码创建自定义Bean来覆盖默认Bean即可，对应此处即声明一个Logger.Level的对象：

package cn.itcast.order.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;

/**
* @author  波波
* @version 1.0.0
* @desc    自定义日志级别
* @since 2023/1/10 16:36
*/
public class DefaultFeignConfiguration {

    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果想全局生效，将其放在启动类的@EnableFeignClients注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果想局部生效，则将其放在对应@FeignClient这个注解中：

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

3.Feign使用优化

Feign底层发起http请求，底层客户端有其他依赖存在，主要包括：

URLConnection：默认实现，不支持连接池
Apache HttpClient：支持连接池
OKHttp：支持连接池

因此对于Feign的优化，主要手段是使用连接池代替默认的URLConnection，下面用Apache HttpClient示例

1.引入依赖

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

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

2.配置连接池

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

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

3.验证

接下来，在FeignClientFactoryBean中的loadBalance方法中打断点：

debug方式启动order-service服务，可以看到这里的client，底层就是Apache HttpClient：

4.最佳实践

基于上述的种种Feign使用特性，不免会让新手会有一些困惑：实际使用时Feign到底是如何体现的。在最后我们将基于经验，总结出一种不错的使用方式。

观察可以发现，目前Feign客户端代码与服务提供者Controller代码非常相似，那如何简化这种重复代码就变成了一个新的难题。

1.继承

重复的代码可以继承来共享代码，因此我们可基于此进行代码优化

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

优点：

简单
实现代码共享

缺点：

服务提供方、服务消费方紧耦合
参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

2.抽取

将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。

2.1 模块抽取

新建一个：feign-api 的module

feign-api中引入依赖

<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

在order-service中的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中，结构如下

2.2 order-service中使用feign-api

删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。然后在order-service的pom文件中中引入feign-api的依赖：

<dependency>
    <groupId>cn.itcast.demo</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

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

cn.itcast.order.pojo.Order
cn.itcast.order.service.OrderService

2.3 重启测试

启动发现会有如下报错信息：

原因是因为UserClient目前在feign-api这个module里：cn.itcast.feign.clients包下，而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。

2.4 解决包路径扫描问题

注意：以下调整均在OderApplication这个启动类中处理

方式一：指定Feign扫描包路径

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

方式二：指定需要加载的Client接口

@EnableFeignClients(clients = {UserClient.class})

引包是：feign-api下的别引错了，需修改后重启服务，可正常访问。