OpenFeign介绍以及使用

已于 2024-12-29 11:25:32 修改
阅读量867 收藏 26
点赞数 12
CC 4.0 BY-SA版权
文章标签： spring spring cloud maven java
于 2024-12-29 11:23:36 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Waitfor_Me/article/details/144799768

介绍

OpenFeign 是一个声明式的 Web 服务客户端，用于简化在 Java 应用中调用 HTTP API 的过程，在 Spring Cloud 体系里被广泛应用，它有以下关键特性：

  • 声明式调用：基于注解，开发人员只需定义接口并添加注解，就能轻松描述对远程服务的 HTTP 请求，无需手动编写大量重复的 HTTP 客户端代码，如使用@FeignClient注解来指定要调用的服务名称。
  • 集成与适配：它能与 Spring Cloud 的服务发现机制（如 Eureka、Consul 等）无缝集成，调用远程服务时，借助服务发现找到目标服务实例的实际网络地址，开发者不用关心服务实例的具体位置和动态变化。同时，OpenFeign 可以方便地整合 Ribbon 实现客户端负载均衡，自动在多个服务实例间分摊请求流量。
  • 可定制化：提供了丰富的编码器和解码器，支持多种数据格式的传输，例如 JSON、XML 等。此外，还允许自定义请求拦截器，可在请求发送前添加公共的请求头、鉴权信息，满足复杂业务场景下的定制需求。
  • 熔断降级：可以结合 Hystrix 等熔断器框架，当被调用的远程服务出现故障、响应超时等异常情况时，快速触发熔断机制，返回预设的兜底数据，避免级联故障，保障整个微服务系统的稳定性。

使用原因

在我的上一章博客中使用了Nacos对微服务实现了服务的注册以及发现：微服务-注册中心-Nacos，但是发现了一个问题，我们在编写远程调用其他微服务的使用需要很长很复杂的一段http代码，如下：

其实远程调用的几个关键点就是：请求方式、请求路径、请求参数、返回值类型，所以本章用OpenFeign来解决微服务之间的远程调用复杂性，提高开发效率。

OpenFeign使用

这个案例是对上一章微服务-注册中心-Nacos的实例进行改造

1.引入依赖

在CloudDemo2中引入如下依赖：

  <!--openFeign-->
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-openfeign</artifactId>
  </dependency>
  <!--负载均衡器-->
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-loadbalancer</artifactId>
  </dependency>

删除启动类上的如下代码：

@Bean
  public RestTemplate restTemplate() {
    return new RestTemplate();
  }

2.启用OpenFeign

接下来，我们在cloudDemo2的CloudDemo2Application启动类上添加注解，启动OpenFeign功能：

@SpringBootApplication
@EnableFeignClients//开启OpenFeign功能支持
public class CloudDemo2Application {
  public static void main(String[] args) {
    SpringApplication.run(CloudDemo2Application.class);
  }
}

3.编写OpenFeign客户端

在cloudDemo2中创建一个client包，然后在下面创建一个OpenFeign客户端：

package com.waitforme.clouddemo2.client;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;

import java.util.List;

@FeignClient("cloudDemo1") //cloudDemo1微服务模块中配置文件所配置的微服务名
public interface CloudDemo1Client {
  /*
    @FeignClient("cloudDemo1") ：声明服务名称
    @GetMapping ：声明请求方式
    @GetMapping("/cloudDemo1/list") ：声明请求路径
    List<Object> ：返回值类型
   */
  @GetMapping("/cloudDemo1/list")
  List<Object> demo1List();
}

编写完上面的代码后，OpenFeign就可以利用动态代理帮我们实现这个方法，并且向http://cloudDemo1/cloudDemo1/list发送一个GET请求，并自动将返回值处理为List<Object>。

我们只需要直接调用这个方法，即可实现远程调用了。

4.使用OpenFeign

修改CloudDemo2ServiceImpl代码

package com.waitforme.clouddemo2.service.impl;

import cn.hutool.core.collection.CollUtil;
import com.waitforme.clouddemo2.client.CloudDemo1Client;
import com.waitforme.clouddemo2.service.CloudDemo2Service;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
@RequiredArgsConstructor//为必要的类成员变量生成构造函数
public class CloudDemo2ServiceImpl implements CloudDemo2Service {
  private final CloudDemo1Client client;

  @Override
  public List<Object> getDemo1List() {
    List<Object> list = client.demo1List();
    if (CollUtil.isEmpty(list)) {
      return null;
    }
    return list;
  }
}

对比修改前后的代码：

修改前，使用restTemplate：

修改后：

5.启动测试

 启动服务，并清空IDEA控制台

在浏览器访问cloudDemo2的getDemo1路径，并刷新看我们的控制台输出

刷新三次页面控制台对比，得出可以使用OpenFeign正常调用，使用的是轮询负载均衡策略

cloudDmoe1的服务实例1

 cloudDmoe1的服务实例2

连接池的使用

OpenFeign 使用连接池主要有以下几方面好处：

  1. 性能提升
    • 减少连接创建开销：在频繁发起 HTTP 请求的场景下，如果不使用连接池，每次请求都需要创建新的 TCP 连接。这个创建过程涉及 TCP 三次握手，会消耗额外的网络往返时间以及系统资源。而连接池能够复用已有的连接，避免了反复创建和销毁连接的开销，显著加快请求响应速度。
    • 并发处理更高效：面对高并发的请求，连接池预先创建并管理了一批连接，多个线程可以同时从池中获取连接发起请求，无需等待新连接的缓慢建立，使得系统能够更从容地应对突发流量，提升整体并发处理能力。
  2. 资源优化
    • 降低系统资源消耗：持续不断地创建新连接会占用大量的系统资源，包括内存、CPU 时间等。连接池通过复用有限数量的连接，将资源消耗维持在一个较低水平，尤其对于资源受限的容器化环境或者小型服务器，这有助于维持系统稳定运行，避免因资源耗尽而出现性能瓶颈甚至崩溃。
  3. 稳定性增强
    • 应对网络波动：网络环境往往存在不稳定因素，如短暂的网络抖动、临时的服务中断。连接池中的连接一旦建立，只要没有出现严重故障，就可以持续复用。当遇到轻微网络波动时，不用频繁重新建立连接，减少因网络异常导致请求失败的概率，增强服务调用的稳定性。
  4. 可配置性与管控
    • 灵活配置：连接池通常提供了丰富的配置参数，例如连接池的最大连接数、最小连接数、连接的空闲时长等。开发人员可以根据实际业务场景和服务器资源状况，精细调整这些参数，实现性能与资源消耗之间的最优平衡。
    • 监控与维护：借助连接池，还能够方便地对连接的使用状态进行监控，了解连接的活跃数量、空闲数量、等待获取连接的线程数等关键信息，以便及时发现潜在问题，并采取诸如清理空闲连接、动态调整连接池大小等维护措施。

 1.引入依赖

在cloudDemo2中引入：

<!--OK http 的依赖 -->
<dependency>
  <groupId>io.github.openfeign</groupId>
  <artifactId>feign-okhttp</artifactId>
</dependency>

2.开启连接池

修改cloudDemo2的yaml配置文件，添加：

feign:
  okhttp:
    enabled: true # 开启OKHttp功能

 OpenFeign进阶使用

思考：如果我们的cloudDemo3模块也要调用cloudDemo1的demo1List方法，也要在cloudDemo3上面写一个OpenFeign客户端吗？

所以我们可以把要与其他微服务进行交互的部分抽取出来，单独提成一个微服务来专门管理远程调用

1.抽取Feign客户端

创建一个远程调用的模块

在openFeignApi的pom.xml中导入依赖，并删除cloudDemo2中的如下两个依赖，因为我们已经把远程连接相关的都提到单独的微服务中了，cloudDemo2中也不需要这两个依赖了。

<dependencies>
        <!--open feign-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!-- load balancer-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>
    </dependencies>

 2.把cloudDemo2中的client包剪切到openFeignApi模块下

3.在cloudDemo2和cloudDemo3的pom.xml中引入openFeign-Api的依赖

<dependency>
    <groupId>com.waitforme</groupId>
    <artifactId>openFeign-Api</artifactId>
    <version>1.0</version>
</dependency>

4.启动测试

 报错？

原因分析：我们把cloudDemo2的feign客户端抽取到了一个独立的微服务中，所以找不到了

解决方案：

1.在cloudDemo2的启动类的EnableFeignClients上声明扫描的包

2.声明要用的FeignClient

最后在浏览器中分别用cloudDemo2和cloudDemo3来访问测试

 日志配置

因为我们把openFeign单独抽出来做了一个微服务，而OpenFeign只会在FeignClient所在包的日志级别为DEBUG时，才会输出日志。它的日志级别有：

  • NONE：不记录任何日志信息，这是默认值。

  • BASIC：仅记录请求的方法，URL以及响应状态码和执行时间

  • HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息

  • FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

Feign默认的日志级别就是NONE，所以默认我们看不到请求日志。

1.定义日志级别

在openFeign-Api下创建一个config包，并创建一个配置类

package com.waitforme.openFeignApi.config;

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

public class DefaultFeignConfig {
  @Bean
  public Logger.Level feignLogLevel() {
    return Logger.Level.FULL;
  }
}

2.配置

让日志级别生效

方式1：

局部配置，在某个FeignClient上加上configuration属性

@FeignClient(value = "cloudDemo1", configuration = DefaultFeignConfig.class) //cloudDemo1微服务模块中配置文件所配置的微服务名

方式2：

全局配置，在启动类添加defaultConfiguration属性，使FeignClient生效

@EnableFeignClients(clients = {CloudDemo1Client.class}, defaultConfiguration = DefaultFeignConfig.class)

3.重启服务，刷新浏览器请求，测试

控制台日志输出格式：

11:16:15:063 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] ---> GET http://cloudDemo1/cloudDemo1/list HTTP/1.1
11:16:15:065 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] ---> END HTTP (0-byte body)
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] <--- HTTP/1.1 200  (176ms)
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] connection: keep-alive
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] content-type: application/json
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] date: Sun, 29 Dec 2024 03:16:15 GMT
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] keep-alive: timeout=60
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] transfer-encoding: chunked
11:16:15:242 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] 
11:16:15:243 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] ["你好","你好，nacos","你好，微服务"]
11:16:15:243 DEBUG 2456 --- [nio-8082-exec-2] c.w.o.client.CloudDemo1Client            : [CloudDemo1Client#demo1List] <--- END HTTP (48-byte body)
Waitfor_Me
关注
【OpenFeign 介绍、使用、发送请求、处理响应】
学无止境
03-30 1939
在这个示例中，@FeignClient注解表示这是一个Feign客户端接口，name属性表示服务的名称，url属性表示服务的地址，@GetMapping注解表示调用远程服务的HTTP请求方式和路径，@RequestParam注解表示传递的参数。它的主要作用是为了简化微服务架构中的服务间调用，因为在微服务架构中，服务间的调用比较频繁，而且可能需要调用多个不同的服务才能完成一个业务流程，这就需要在服务之间建立良好的通信机制。注入Feign客户端接口并调用远程服务。创建一个Feign客户端接口。
Spring Cloud OpenFeign 介绍
黎明就要到来
06-17 976
是一个声明式的 Web 服务客户端，它使 Java 编写 Web 服务客户端变得更加容易。其实就是通过 JDK 代理生成接口的代理对象，方法的执行就是执行 Http 请求。而 OpenFeign 的作用是通过自动装配将 Feign 集成到应用程序中。
OpenFeign的简单介绍和功能实操
weixin_59216829的博客
11-02 1384
OpenFeign全名Spring Cloud OpenFeign，是SpringCloud开发团队基于Feign开发的框架，声明式Web服务客户端Feign是一种声明式、模板化的HTTP客户端，可用于调用HTTP API实现微服务之间的远程服务调用。它的特点是使用少量的配置定义服务客户端接口，可以实现简单和可重用的RPC调用。Feign实现了声明式调用，允许程序员只需定义接口并作出一些小的注释，就可以实现一个完整的客户端，从而开发简单，潜在的问题可以被检测出来，程序的可维护性和可读性也更好。
【OpenFeign】使用详解
最新发布
weixin_54459986的博客
06-13 1013
以订单远程调用商品为例，订单发起远程调用，如果商品服务宕机，或者商品服务卡顿等其他原因，导致迟迟返回不了结果，这样就会导致订单服务一直等待，而假设其他服务又调用了订单服务，又会导致其他服务一直等待返回结果，这样就会导致整条链路全部失败。若是在高并发的情况下，最终会导致集群的资源耗尽，引起服务雪崩。，之前超时控制板块说了，如果商品服务一直不返回，有两种解决办法，一种是快速返回错误数据，还有一种就是返回兜底数据，比如查不到商品，我不返回错，我返回0，以便让后续的逻辑可以继续进行，优化用户体验。
OpenFeign详细使用解析
Crayon26的博客
03-13 1628
本文详解Spring Cloud OpenFeign的核心用法，涵盖声明式接口定义、动态代理原理及REST请求模板配置。通过实例解析注解驱动开发、请求拦截器与日志定制。帮助开发者快速实现微服务间高效通信，简化服务调用代码，提升分布式系统可维护性。适用于需整合多服务的Spring Cloud项目实战参考。
11.OpenFeign之feign使用简介
05-17
Feign使用像Jersey和CXF这样的工具来编写Rest或SOAP服务的java客户端。此外，Feign允许您在诸如Apache HC这样的http库之上编写自己的代码。Feign将你的代码与http API连接起来，通过可定制的解码器和错误处理来将代码与http API连接起来，这些代码可以被写入任何基于文本的http API。
微服务 OpenFeign 解析部署使用全流程
m0_71240584的博客
09-28 2664
Feign是集成了负载均衡、熔断机制、Http请求管理等功能的框架，作用是做微服务通信。Feign目前已经停止维护了，被Spring的OpenFeign接替实现后续功能。负载均衡：服务器承担的压力就是负载，压力越大负载越大；均衡就是降低服务器承担的压力。熔断机制：微服务之间通信的时候，A微服务给B微服务发送请求来获得B微服务里的数据。如果B微服务处于宕机状态，这样当A给B发请 求的时候，A会一直处于等待状态，等待B给出响应。这样对客户来说就不友好了。
SpringCloudNetflix中 ：OpenFeign的使用、Hystrix的使用、zuul网关的使用
qqjiayoua的博客
07-22 263
Feign是一个声明式的http客户端，使用Feign可以实现声明式REST调用，它的目的就是让Web Service调用更加简单。），如果参数多了就拼接就非常繁琐，代码不优雅，效率低下。Fegin基于Ribbon进行了封装，把一些负责的url和参数处理细节屏蔽起来 因此使用Fegin服务调用方式来进行远程微服务调用就会显得代码更优雅，效率更高。我们在使用Ribbon作为客户端负载均衡完成订单服务和用户服务的通讯，通过RestTemplate调用其它服务时，所需要的参数须在请求的URL中进行拼接 （
OpenFeign、Feign以及Ribbon关系介绍
我还可以
06-22 1040
OpenFeign和Feign的区别？ OpenFeign做了哪些优化？ Ribbon又是什么？
【云原生】原来2020.0.X版本开始的OpenFeign底层不再使用Ribbon了
m0_67392811的博客
07-31 739
SpringCloud之Feign实现声明式客户端负载均衡详细案例SpringCloud之OpenFeign实现服务间请求头数据传递（OpenFeign拦截器RequestInterceptor的使用）SpringCloud之OpenFeign的常用配置（超时、数据压缩、日志）SpringCloud之OpenFeign的核心组件（Encoder、Decoder、Contract）SpringBoot启动流程中开启OpenFeign的入口（ImportBeanDefinitionRegistrar详解）...
OpenFeign的理解和使用
cheng的博客
03-21 2万+
一、概述 openFeign是要给声明式的web服务客户端，或叫做声明式REST客户端，它让编写web服务客户端变得简单。 使用它的步骤：创建一个接口并注解它。它支持spring MVC的注解，spring cloud openFeign整合了hystrix，同时，可以和Eureka和ribbon配合使用，可以实现负载均衡的http客户端。 可以理解为是请求转发（RPC调度）的入口。 二、使用步骤 1、引入spring-cloud-starter-openfeign 依赖。 2、启动类上加上@EnableF
OpenFeign简介和使用详解
热门推荐
怪咖@的博客
08-07 4万+
Feign是一个声明式的Web服务客户端（Web服务客户端就是Http客户端），让编写Web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可。
open-feign的使用
u010152183的专栏
02-13 897
代码和配置 1. alibaba-feign-api 第一步:引入依赖 <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring‐cloud‐starter‐openfeign</artifactId> </dependency...
OpenFeign的使用
m0_74197695的博客
09-06 1179
在hm-api模块下新建一个配置类，定义Feign的日志级别：@Bean。
OpenFeign的实际运用
勿在浮沙柱筑高台
05-16 222
1）Ribbon是一个基于HTTP和TCP客户端的负载均衡的工具。它可以在客户端配置RibbonServerList(服务端列表)，使用HttpClient或RestTemplate模拟http请求，步骤相当繁琐。2）Feign是在Ribbon的基础上进行了一次改进，是一个使用起来更加方便的HTTP客户端。采用接口的方式，只需要创建一个接口，然后在上面添加注解即可，将需要调用的其他服务的方法定义成抽象方法即可，不需要自己构建http请求。
Spring Cloud OpenFeign的作用和用法
编程小弟的博客
05-15 548
Spring Cloud OpenFeign 是 Spring Cloud 体系中的一个微服务调用组件，它是一个声明式的 Web 服务客户端，使得编写 Web 服务客户端变得更加容易。OpenFeign 整合了 Ribbon 用于负载均衡，并且它也是 Netflix Feign 的升级版本，提供了更丰富的功能。通过上述步骤，可以在Spring Cloud应用中使用Spring Cloud OpenFeign来实现微服务之间的调用，简化了HTTP客户端的编写，并且提高了系统的灵活性和稳定性。
OpenFeign的简单介绍和快速使用
weixin_46258873的博客
03-21 4479
一、OpenFeign是什么？ 可以用来替换ribbon+restTemplate OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解，如@RequesMapping等等。OpenFeign的@Feignclient可以解析SpringMVc的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。 二、OpenFeign的快速使用 （1）新建消费者maven项目cloud-consumer-feign-ord
为什么使用OpenFeign
qq_42979823的博客
11-06 136
使用了注册中心后每次远程调用都需要自己写代码根据服务名称获取实例 在去负载均衡挑选实例 然后再使用 RestTemplate发起http请求太麻烦，spring-cloud-starter-ladbalancer 负载均衡 之前使用的是ribbon新版使用这个。引入jar spring-cloud-starter-openfeign OpenFeign的包。OpenFeign是一个声明式http客户端。
一文搞懂OpenFeign（VIP典藏版）
慕白Lee的博客
02-19 1563
远程调用说白了可以理解为不同服务之间方法的调用，实质上是两台主机间的网络通信 ，涉及到网络通信又必然会有序列化、反序列化，编解码等一些必须要考虑的问题，现在业界内比较流行的一些 RPC 框架，例如：Dubbo提供的是基于接口的远程方法调用，通过rpc远程调用框架，客户端只需要知道接口的定义即可调用远程服务。......
详细介绍如何使用OpenFeign
05-24
OpenFeign是一个用于简化HTTP API客户端编写的库，它使用注解来定义和配置HTTP请求。OpenFeign由Netflix开发，旨在帮助Java开发人员快速、轻松地编写HTTP客户端。 以下是使用OpenFeign的步骤： 1. 添加依赖 在项目中添加OpenFeign的依赖，例如使用Maven，可以在pom.xml文件中添加以下依赖： ``` <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> ``` 2. 创建接口 创建一个接口，用于定义需要调用的远程服务的API。在接口中使用注解来定义并配置HTTP请求。 例如，假设我们需要调用一个名为“UserService”的远程服务，并调用其“getUser”方法来获取用户信息。我们可以创建一个名为“UserClient”的接口，并在其中使用@FeignClient注解来指定远程服务的名称和URL。 ``` @FeignClient(name = "UserService", url = "http://localhost:8080") public interface UserClient { @GetMapping("/users/{id}") User getUser(@PathVariable("id") Long id); } ``` 3. 调用API 在需要调用远程服务的地方，注入UserClient接口并调用其方法即可。 ``` @Autowired private UserClient userClient; public void getUser(Long id) { User user = userClient.getUser(id); // 处理返回结果 } ``` 以上就是使用OpenFeign的基本步骤，通过使用注解来定义和配置HTTP请求，可以大大简化HTTP API客户端编写的工作。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值