脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring Cloud调用OpenFeign

Spring Cloud实现远程调用OpenFeign组件的方法

 更新时间：2026年02月03日 10:46:47   作者：努力也学不会Java.  
本文主要介绍了SpringCloud中实现远程调用的组件OpenFeign的相关知识与操作,包括OpenFeign的介绍、快速上手、参数传递和最佳实践,感兴趣的朋友跟随小编一起看看吧

一、RestTemplate存在问题

观察之前文章介绍的远程调用的代码：

public OrderInfo selectOrderById(Integer orderId) {
        OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
        String url = "http://product-service/product/"+ orderInfo.getProductId();
        ProductInfo productInfo = restTemplate.getForObject(url,
                ProductInfo.class);
        orderInfo.setProductInfo(productInfo);
        return orderInfo;
    }

虽说RestTemplate 对HTTP封装后, 已经比直接使用HTTPClient简单方便很多, 但是还存在一些问题.

  1. 需要拼接URL, 灵活性高, 但是封装臃肿, URL复杂时, 容易出错.
  2. 代码可读性差, 风格不统⼀.

微服务之间的通信方式, 通常有两种: RPC 和 HTTP.
在SpringCloud中, 默认是使用HTTP来进行微服务的通信, 最常用的实现形式有两种：
• RestTemplate
• OpenFeign

RPC（Remote Procedure Call）远程过程调用，是⼀种通过网络从远程计算机上请求服务，而不需
要了解底层网络通信细节。RPC可以使用多种网络协议进行通信， 如HTTP、TCP、UDP等， 并且在
TCP/IP网络四层模型中跨越了传输层和应用层。简言之RPC就是像调用本地方法⼀样调用远程方法。
常见的RPC框架有:
1 . Dubbo: Apache Dubbo 中文
2 . Thrift : Apache Thrift - Home
3 . gRPC: gRPC

二、OpenFeign介绍

OpenFeign 是一个声明式的 Web Service 客户端. 它让微服务之间的调用变得更简单, 类似controller调用service, 只需要创建⼀个接口，然后添加注解即可使用OpenFeign.

OpenFeign 的前身
Feign 是 Netflix 公司开源的⼀个组件.
• 2013年6月, Netflix发布 Feign的第⼀个版本 1.0.0
• 2016年7月, Netflix发布Feign的最后⼀个版本 8.18.0

2016年，Netflix 将 Feign 捐献给社区
• 2016年7月 OpenFeign 的首个版本 9.0.0 发布，之后⼀直持续发布到现在.

Spring Cloud Feign

Spring Cloud Feign 是 Spring 对 Feign 的封装, 将 Feign 项目集成到 Spring Cloud ⽣态系统中.受 Feign 更名影响，Spring Cloud Feign 也有两个 starter

spring-cloud-starter-feign
spring-cloud-starter-openfeign

由于Feign的停更维护, 对应的, 我们使用的依赖是 spring-cloud-starter-openfeign。

OpenFeign :官方文档
Spring Cloud Feign：官方文档

三、快速上手

3.1 引入依赖

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

3.2 添加注解

在order-service的启动类添加注解 @EnableFeignClients , 开启OpenFeign的功能.

    @EnableFeignClients
    @SpringBootApplication
    public class OrderServiceApplication {
        public static void main(String[] args) {
            SpringApplication.run(OrderServiceApplication.class, args);
        }
    }

3.3 编写OpenFeign的客户端

基于SpringMVC的注解来声明远程调用的信息

    @FeignClient(value = "product-service", path = "/product")
    public interface ProductApi {
        @RequestMapping("/{productId}")
        ProductInfo getProductById(@PathVariable("productId") Integer productId);
    }

@FeignClient 注解作用在接口上, 参数说明:

• name/value：指定FeignClient的名称, 也就是微服务的名称, 用于服务发现, Feign底层会使用Spring Cloud LoadBalance进行负载均衡. 也可以使用 url 属性指定⼀个具体的url.
• path: 定义当前FeignClient的统一前缀.

3.4 远程调用

修改远程调用的方法

    @Autowired
    private ProductApi productApi;
    /**
     * Feign实现远程调⽤
     * @param orderId
     */
    public OrderInfo selectOrderById(Integer orderId) {
        OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
        ProductInfo productInfo =
                productApi.getProductById(orderInfo.getProductId());
        orderInfo.setProductInfo(productInfo);
        return orderInfo;
    }

不同方式之间代码对比：

四、OpenFeign参数传递

通过观察, 我们也可以发现, Feign的客户端和服务提供者的接口声明非常相似
上面例子中, 介绍了Feign 从URL中获取参数, 接下来介绍下Feign参数传递的其他方式。

4.1 传递单个参数

服务提供方：product-service

    @RequestMapping("/product")
    @RestController
    public class ProductController {
        @RequestMapping("/p1")
        public String p1(Integer id){
            return "p1接收到参数:"+id;
        }
    }

Feign客户端：

    @FeignClient(value = "product-service", path = "/product")
    public interface ProductApi {
        @RequestMapping("/p1")
        String p1(@RequestParam("id") Integer id);
    }

服务消费方order-service：

    @RequestMapping("/feign")
    @RestController
    public class TestFeignController {
        @Autowired
        private ProductApi productApi;
        @RequestMapping("/o1")
        public String o1(Integer id){
            return productApi.p1(id);
        }
    }

测试远程调用：
http://127.0.0.1:8080/feign/o1?id=5
测试结果：

4.2 传递多个参数

使用多个@RequestParam 进行参数绑定即可

服务提供方 product-service

    @RequestMapping("/p2")
    public String p2(Integer id,String name){
        return "p2接收到参数,id:"+id +",name:"+name;
    }

Feign客户端：

    @FeignClient(value = "product-service", path = "/product")
    public interface ProductApi {
       @RequestMapping("/p2")
       String p2(@RequestParam("id")Integer id,@RequestParam("name")String name);
    }

服务消费方order-service：

    @RequestMapping("/o2")
    public String o2(@RequestParam("id")Integer id,@RequestParam("name")String name){
        return productApi.p2(id,name);
    }

测试远程调用：

http://127.0.0.1:8080/feign/o2?id=5&name=zhangsan

4.3 传递对象

服务提供方 product-service

   @RequestMapping("/p3")
    public String p3(ProductInfo productInfo){
        return "接收到对象, productInfo:"+productInfo;
    }

Feign客户端：

@RequestMapping("/p3")
String p3(@SpringQueryMap ProductInfo productInfo);

服务消费方order-service：

    @RequestMapping("/o3")
    public String o3(ProductInfo productInfo){
        return productApi.p3(productInfo);
    }

4.4 传递JSON

服务提供方 product-service：

    @RequestMapping("/p4")
    public String p4(@RequestBody ProductInfo productInfo){
        return "接收到对象, productInfo:"+productInfo;
    }

Feign客户端

@RequestMapping("/p4")
String p4(@RequestBody ProductInfo productInfo);

服务消费方order-service：

   @RequestMapping("/o4")
    public String o4(@RequestBody ProductInfo productInfo){
        System.out.println(productInfo.toString());
        return productApi.p4(productInfo);
    }

五、最佳实践

最佳实践, 其实也就是经过历史的迭代, 在项目中的实践过程中, 总结出来的最好的使用方式.
通过观察, 我们也能看出来, Feign的客户端与服务提供者的controller代码非常相似

Feign 客户端：

    @FeignClient(value = "product-service", path = "/product")
    public interface ProductApi {
        @RequestMapping("/{productId}")
        ProductInfo getProductById(@PathVariable("productId") Integer productId);
    }

服务提供方Controller：

    @RequestMapping("/product")
    @RestController
    public class ProductController {
        @RequestMapping("/{productId}")
        public ProductInfo getProductById(@PathVariable("productId") Integer productId){
            //...
        }
    }

有没有⼀种方法可以简化这种写法呢？

5.1 Feign继承方式

Feign 支持继承的方式, 我们可以把⼀些常件的操作封装到接口里.
我们可以定义好⼀个接口, 服务提供方实现这个接口, 服务消费方编写Feign 接口的时候, 直接继承这个接口

5.1.1 创建一个Module

接口可以放在⼀个公共的Jar包里, 供服务提供方和服务消费方使用

5.1.2 引入依赖

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

5.1.3 编写接口

复制 ProductApi, ProductInfo 到product-api模块中

 public interface ProductInterface {
        @RequestMapping("/{productId}")
        ProductInfo getProductById(@PathVariable("productId") Integer productId);
        @RequestMapping("/p1")
        String p1(@RequestParam("id") Integer id);
        @RequestMapping("/p2")
        String p2(@RequestParam("id")Integer id,@RequestParam("name")String name);
        @RequestMapping("/p3")
        String p3(@SpringQueryMap ProductInfo productInfo);
        @RequestMapping("/p4")
        String p4(@RequestBody ProductInfo productInfo);
    }

5.1.4 服务提供方

服务提供方实现接口ProductInterface：

 @RequestMapping("/product")
    @RestController
    public class ProductController implements ProductInterface {
        @Autowired
        private ProductService productService;
        @RequestMapping("/{productId}")
        public ProductInfo getProductById(@PathVariable("productId") Integer
                                                  productId){
            System.out.println("收到请求,Id:"+productId);
            return productService.selectProductById(productId);
        }
        @RequestMapping("/p1")
        public String p1(Integer id){
            return "p1接收到参数:"+id;
        }
        @RequestMapping("/p2")
        public String p2(Integer id,String name){
            return "p2接收到参数,id:"+id +",name:"+name;
        }
        @RequestMapping("/p3")
        public String p3(ProductInfo productInfo){
            return "接收到对象, productInfo:"+productInfo;
        }
        @RequestMapping("/p4")
        public String p4(@RequestBody ProductInfo productInfo){
            return "接收到对象, productInfo:"+productInfo;
        }
    }

5.1.5 服务消费方

服务消费方继承ProductInterface

@FeignClient(value = "product-service", path = "/product")
public interface ProductApi extends ProductInterface {
}

这样通过继承就可以实现远程调用

5.2 Feign 抽取方式

官方推荐Feign的使用方式为继承的方式, 但是企业开发中, 更多是把Feign接口抽取为⼀个独立的模块(做法和继承相似, 但理念不同).
操作方法:
将Feign的Client抽取为⼀个独立的模块, 并把涉及到的实体类等都放在这个模块中, 打成⼀个Jar. 服务消费方只需要依赖该Jar包即可. 这种方式在企业中比较常见, Jar包通常由服务提供方来实现.

5.2.1 创建新module

5.2.2 引入依赖

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

5.2.3 编写API

复制 ProductApi, ProductInfo 到product-api模块中
之后通过Maven打包，可以观察Maven本地仓库检查是否打包成功

5.2.4 服务消费方使用product-api

1 删除 ProductApi, ProductInfo.
2. 引入依赖：

<dependency>
 <groupId>org.example</groupId>
 <artifactId>product-api</artifactId>
 <version>1.0-SNAPSHOT</version>
</dependency>

修改项目中ProductApi, ProductInfo的路径为product-api中的路径

3 .指定扫描类: ProductApi
在启动类添加扫描路径

    @EnableFeignClients(basePackages = {"com.bite.api"})
    @SpringBootApplication
    public class OrderServiceApplication {
        public static void main(String[] args) {
            SpringApplication.run(OrderServiceApplication.class, args);
        }
    }

也可以指定需要加载的Feign客户端
@EnableFeignClients(clients = {ProductApi.class})

六、总结

以上就是本文全部内容，本文主要为大家介绍了Spring Cloud中实现远程调用的另一个组件-OpenFeign的相关知识与操作。感谢各位能够看到最后，如有问题，欢迎各位大佬在评论区指正，希望大家可以有所收获！创作不易，希望大家多多支持。

到此这篇关于Spring Cloud实现远程调用OpenFeign组件的方法的文章就介绍到这了,更多相关Spring Cloud调用OpenFeign内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Android中的LinearLayout布局

    Android中的LinearLayout布局

    在一般情况下,当有很多控件需要在一个界面列出来时,我们就可以使用线性布局(LinearLayout)了,线性布局是按照垂直方向(vertical)或水平方向(horizontal)的顺序依次排序子元素,每一个子元素都位于前一个元素之后,下面我们就简单的了解一下吧
    2017-01-01
  • spring boot(四)之thymeleaf使用详解

    spring boot(四)之thymeleaf使用详解

    Thymeleaf 是一个跟 Velocity、FreeMarker 类似的模板引擎，它可以完全替代 JSP 。接下来通过本文给大家介绍spring boot(四)之thymeleaf使用详解,需要的朋友可以参考下
    2017-05-05
  • SpringBoot操作Redis三种方案全解析

    SpringBoot操作Redis三种方案全解析

    这篇文章主要介绍了SpringBoot操作Redis三种方案全解析，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-06-06
  • java实现的图片裁剪功能示例

    java实现的图片裁剪功能示例

    这篇文章主要介绍了java实现的图片裁剪功能,涉及java针对图片的读取、转换、保存等相关操作技巧,需要的朋友可以参考下
    2017-10-10
  • Java反射机制之如何获取对象动态字段值

    Java反射机制之如何获取对象动态字段值

    文章介绍了Java反射机制,可动态获取对象字段值（包括私有及父类字段）,通过遍历类结构、设置访问权限和递归查找实现,适用于复杂继承场景和JSON映射,但需注意性能与安全风险
    2025-07-07
  • 详解Mybatis是如何解析配置文件的

    详解Mybatis是如何解析配置文件的

    这篇文章主要介绍了详解Mybatis是如何解析配置文件的，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • MyBatis-Plus多数据源的示例代码

    MyBatis-Plus多数据源的示例代码

    本文主要介绍了MyBatis-Plus多数据源的示例代码,包括依赖配置、数据源配置、Mapper 和 Service 的定义,具有一定的参考价值,感兴趣的可以了解一下
    2024-05-05
  • 基于servlet的执行原理与生命周期(全面解析)

    基于servlet的执行原理与生命周期(全面解析)

    下面小编就为大家分享一篇servlet的执行原理与生命周期全面解析，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • 浅谈Spring Data如何简化数据操作的方法

    浅谈Spring Data如何简化数据操作的方法

    这篇文章主要介绍了看Spring Data如何简化数据操作的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2019-04-04
  • Java使用IO模拟注册登录

    Java使用IO模拟注册登录

    这篇文章主要为大家详细介绍了Java使用IO模拟注册登录，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-04-04

最新评论