树屋
🏠 主页 📚 文章 🧩 标签 🗂 分类
树屋

目录

Feign远程调用

流水不争先，争得是滔滔不绝

 收录于 微服务
   约 2489 字   预计阅读 5 分钟 

Feign远程调用

RestTemplate方式存在的问题

之前利用RestTemplate发起远程调用的代码：

1
2

String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);

存在一些问题：

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

Feign的介绍

Feign是一个声明式的http客户端

官方地址：OpenFeign

官方文档地址：OpenFeign官网文档

作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

https://s2.loli.net/2022/11/28/YVvzhrqMKc4u5nd.png

1.Feign代替RestTemplate

使用Feign的步骤如下：

1、引入依赖

1
2
3
4
5

<!-- Feign客户端依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、添加注解

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

1
2
3
4
5
6
7
8

@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

3、编写Feign客户端

在order-service中新建一个接口：

1
2
3
4
5

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

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

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

这样Feign就可以帮助我们发送http请求，不需要用RestTemplate发送请求了。

4、测试

使用Feign客户端代替RestTemplate：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

@Service
public class OrderService {

    @Resource
    private OrderMapper orderMapper;

    @Resource
    private FeignClients feignClients;

    public Order queryOrderById(Long orderId) {
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 2.利用Feign发起http请求，查询用户
        User user = feignClients.findById(order.getUserId());
        // 3.封装user到order
        order.setUser(user);
        // 4.返回
        return order;
    }
}

5、总结

使用Feign的步骤：

  • 引入依赖
  • 添加@EnableFeignClients注解
  • 编写FeignClient接口
  • 使用FeignClient中定义的方法代替RestTemplate

2.自定义Feign的配置

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下表：

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

一般需要我们配置的就是日志级别。

日志的级别分为四种：

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

同时有两种配置方式

1、配置文件方式

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

1
2
3
4
5

feign:
  client:
    config:
      userservice: #写服务名表示针对某个微服务的配置
        loggerLevel: FULL

也可以针对所有服务：

1
2
3
4
5

feign:
  client:
    config:
      default: #写default就是全局配置，针对所有微服务
        loggerLevel: FULL

2、Java代码方式

先声明一个类，然后声明一个Logger.Level对象：

1
2
3
4
5
6
7

public class DefaultFeignConfiguration {

    @Bean
    public Logger.Level log() {
        return Logger.Level.BASIC;
    }
}

如果要全局生效，那么需要在启动类的@EnableFeignClients注解中添加：

1

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)

如果要针对某个微服务生效，那么需要在对应的@FeignClient注解中添加：

1

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

3.Feign的性能优化

Feign底层的客户端实现：

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

因此优化Feign的性能主要包括：

① 使用连接池代替默认的URLConnection

② 日志级别，最好用basic或none

连接池配置

Feign添加HttpClient的支持

1.引入依赖：

1
2
3
4
5

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

2.配置连接池：

1
2
3
4
5
6
7
8
9

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

4.Feign的最佳实践

方式一（继承）： 给消费者的FeignClient和提供者的Controller定义统一的父接口作为标准

1、定义一个API接口，利用定义方法，并基于SpringMVC注解做声明

1
2
3
4

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

2、Feign客户端和Controller都继承该接口

1
2

@FeignClient(value = "userservice")
public interface UserClient extends UserAPI{}

1
2
3
4
5
6

@RestController
public class UserController implements UserAPI{
    public User findById(@PathVariable("id") Long id){
        // ...实现业务
    }
}

优点：

  • 简单，实现了代码共享

缺点：

  • 服务紧耦合
  • 父接口参数列表中的映射并不会被继承，因此Controller中必须再次声明方法、参数列表、注解

方式二（抽取）： 将FeignClient抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用

https://s2.loli.net/2022/11/28/f6Ub3nQ8KCpzuTr.png

实现基于抽取方案的最佳实践

1、新建一个module，命名为feign-api，然后引入feign的starter依赖：

1
2
3
4
5

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

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

3、在order-service中使用feign-api

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

引入feign-api的依赖：

1
2
3
4
5

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

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

4、重启并解决扫描包的问题

重启order-service服务后会报错，这是因为@EnableFeignClients注解与UserClient类不在同一包下，无法扫描到UserClient，有两种方式可以解决这个问题。

方式一：指定Feign应该扫描的包

1

@EnableFeignClients(basePackages = "包名路径")

方式二：指定需要加载的Client接口（例如UserClient）

1

@EnableFeignClients(clients = {UserClient.class})
更新于 2022-07-10
 Feign
返回 | 主页