当前位置： 首页 > news >正文

SpringCloud(6)-优雅实现远程调用-OpenFeign

news 2025/9/9 3:02:11

1.RestTemplatec存在问题

观察远程调用的代码

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

2.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 发布，之后⼀直持续发布到现在.

可以简单理解为 Netflix Feign 是OpenFeign的祖先, 或者说OpenFeign 是Netflix Feign的升级版.

OpenFeign 是Feign的⼀个更强⼤更灵活的实现.

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 官⽅⽂档: GitHub - OpenFeign/feign: Feign makes writing java http clients easier

Spring Cloud Feign⽂档: Spring Cloud OpenFeign

3.快速上手

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的注解来声明远程调用的信息

import com.bite.order.model.ProductInfo;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;@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 远程调用

修改远程调用的方法

 @Autowiredprivate 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;}

代码对比：

3.5 测试

启动服务，访问接口，测试远程调用：

http://127.0.0.1:8080/order/1

可以看出来, 使⽤Feign也可以实现远程调⽤.

Feign 简化了与HTTP服务交互的过程, 把REST客⼾端的定义转换为Java接⼝, 并通过注解的⽅式来声明请求参数,请求⽅式等信息, 使远程调⽤更加⽅便和间接.

4.OpenFeign参数传递

4.1 传递单个参数

服务提供方product-service

 @RequestMapping("/product")@RestControllerpublic 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);}

注意：@RequestParam 做参数绑定，不能省略

服务消费方order-service

@RequestMapping("/feign")
@RestController
public class TestFeignController {@Autowiredprivate 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客户端

 @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);
}

测试远程调⽤

http://127.0.0.1:8080/feign/o3?id=5&productName=zhangsan

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);
}

测试远程调⽤

http://127.0.0.1:8080/feign/o4

5.最佳实践

最佳实践, 其实也就是经过历史的迭代, 在项⽬中的实践过程中, 总结出来的最好的使⽤⽅式.通过观察, 我们也能看出来, 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 接⼝的时候, 直接继承这个接⼝

具体参考: Spring Cloud OpenFeign Features :: Spring Cloud Openfeign

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模块中

import com.bite.model.ProductInfo;
import org.springframework.cloud.openfeign.SpringQueryMap;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;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 打Jar包

通过Maven打包

观察Maven本地仓库, Jar包是否打成功

[INFO] Installing D:\Git\spring-cloud\spring-cloud-feign2\product

api\target\product-api-1.0-SNAPSHOT.jar to 

D:\Maven\.m2\repository\org\example\product-api\1.0-SNAPSHOT\product-api-1.0-

SNAPSHOT.jar

 [INFO] ------------------------------------------------------------------------

 [INFO] BUILD SUCCESS

 [INFO] ------------------------------------------------------------------------

 [INFO] Total time: 2.796 s

 [INFO] Finished at: 2024-01-03T19:31:35+08:00

 [INFO] ------------------------------------------------------------------------

5.1.5 服务提供方

服务提供方实现接口ProductInterface

@RequestMapping("/product")
@RestController
public class ProductController implements ProductInterface {@Autowiredprivate 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.6 服务消费方

服务消费方继承ProductInterface

import com.bite.api.ProductInterface;
import org.springframework.cloud.openfeign.FeignClient;@FeignClient(value = "product-service", path = "/product")
public interface ProductApi extends ProductInterface {}

5.1.7 测试

测试远程调用

http://127.0.0.1:8080/order/1

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模块中

5.2.4 打Jar包

通过Maven打包

观察Maven本地仓库，Jar包是否打成功

[INFO] Installing D:\Git\spring-cloud\spring-cloud-feign\product

api\target\product-api-1.0-SNAPSHOT.jar to 

D:\Maven\.m2\repository\org\example\product-api\1.0-SNAPSHOT\product-api-1.0-

SNAPSHOT.jar

 [INFO] ----------------------------------------------------------------------

 [INFO] BUILD SUCCESS

 [INFO] ------------------------------------------------------------------------

 [INFO] Total time: 3.441 s

 [INFO] Finished at: 2024-01-03T17:55:14+08:00

 [INFO] ------------------------------------------------------------------------

5.2.5 服务消费方使用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"})

完整代码如下:

@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})

5.2.6 测试

测试远程调用

http://127.0.0.1:8080/order/1​​​​​​

6.服务部署

1. 修改数据库, Nacos等相关配置

2. 对两个服务进⾏打包

Maven打包默认是从远程仓库下载的, product-api 这个包在本地, 有以下解决⽅案:

◦ 上传到Maven中央仓库(参考: 如何发布Jar包到Maven中央仓库, ⽐较⿇烦)[不推荐]

◦ 搭建Maven私服, 上传Jar包到私服[企业推荐]

◦ 从本地读取Jar包[个⼈学习阶段推荐]

前两种⽅法⽐较复杂, 咱们使⽤第三种⽅式

修改pom⽂件

<dependency><groupId>org.example</groupId><artifactId>product-api</artifactId><version>1.0-SNAPSHOT</version><!-- scope 为system. 此时必须提供systemPath即本地依赖路径. 表⽰maven不会去中央仓库查找依赖 不推荐使⽤--><scope>system</scope><systemPath>D:/Maven/.m2/repository/org/example/product-api/1.0-SNAPSHOT/product-api-1.0-SNAPSHOT.jar</systemPath>
</dependency>//....
<build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><includeSystemScope>true</includeSystemScope></configuration></plugin></plugins>
</build>

3. 上传jar到Linux服务器

4. 启动Nacos

启动前最好把data数据删除掉.

5. 启动服务

#后台启动order-service, 并设置输出⽇志到logs/order.log

 nohup java -jar order-service.jar >logs/order.log &

 #后台启动product-service, 并设置输出⽇志到logs/order.log

 nohup java -jar product-service.jar >logs/product-9090.log &

 #启动实例, 指定端⼝号为9091

 nohup java -jar product-service.jar --server.port=9091 >logs/product-9091.log &

观察Nacos控制台

6. 测试

观察远程调⽤的结果:


文章转载自：

http://7UNdf9L5.zqbrd.cn
http://yIqHB09L.zqbrd.cn
http://TSjidQ7M.zqbrd.cn
http://FS02ip6G.zqbrd.cn
http://0DuSIxhh.zqbrd.cn
http://xu4mgTSo.zqbrd.cn
http://oT2VAdnS.zqbrd.cn
http://RlIrSYFg.zqbrd.cn
http://uPrlYZDU.zqbrd.cn
http://QIJ92BCQ.zqbrd.cn
http://XhTy3jp1.zqbrd.cn
http://gMZb66Rs.zqbrd.cn
http://4NzE4u1q.zqbrd.cn
http://aDYUhQra.zqbrd.cn
http://AZwTC0mv.zqbrd.cn
http://qDnvtdmo.zqbrd.cn
http://QBDCkaRj.zqbrd.cn
http://TvwI9Qqh.zqbrd.cn
http://NJYeKOPP.zqbrd.cn
http://dxAWlX0A.zqbrd.cn
http://AClHob1F.zqbrd.cn
http://uTKNSPVz.zqbrd.cn
http://eMFcMPzB.zqbrd.cn
http://bRrVdV0u.zqbrd.cn
http://5Obtelwf.zqbrd.cn
http://TZNrFQoJ.zqbrd.cn
http://yIJvcUP0.zqbrd.cn
http://6Z729Yno.zqbrd.cn
http://YhiQGD78.zqbrd.cn
http://9VdAl1uZ.zqbrd.cn
http://www.dtcms.com/a/363185.html

相关文章：

  • 基于springboot的“衣依”服装销售平台
  • git通过https和SSH上传gitee仓库
  • MongoDb（①免安装）
  • ​​​​​​​Blender 重拓扑修改器实战指南：从基础操作到细节优化​
  • Meta AIUCSD放大招：DeepConf 让大语言模型推理既快又准，84.7%的token节省+近乎完美的准确率！
  • WMT2014：机器翻译领域的“奥林匹克盛会“
  • 大模型RAG项目实战：RAG技术原理及核心架构
  • (TMLR-2024)DINOv2：在无监督条件下学习鲁棒的视觉特征
  • 【Element-Plus】媒体预览模态框优化实战：从复杂到简洁的设计之路
  • WHAT - HTMLRewriter 介绍（页面优化、SEO、广告注入）
  • C++入门自学Day17-- 模版进阶知识
  • 从程序员到「认识罕见病 DAO」发起人，他用 Web3 承载爱与责任
  • C# 简述委托，Func与Action委托。 他们之前有什么区别？
  • MCU上跑AI—实时目标检测算法探索
  • 将css中的线性渐变，径向渐变，锥心渐变，转成canvas中的渐变
  • 【高并发内存池】三、线程缓存的设计
  • SpringBoot3中使用Caffeine缓存组件
  • Ruoyi-vue-plus-5.x第三篇Redis缓存与分布式技术：3.2 缓存注解与使用
  • 悬停头部的实现方式之一 css: position: sticky
  • SQL Server-查询事务日志
  • 血缘元数据采集开放标准：OpenLineage Guides 在 Spark 中使用 OpenLineage
  • B2B营销面临的一些主要问题
  • 3025. 人员站位的方案数 I
  • HDI线路板与普通板有何区别？厂家生产难度在哪？
  • 【leetcode】236. 二叉树的最近公共祖先
  • 《“人工智能+”行动意见》深度解析：从智能红利到产业落地，直播SDK的技术价值与应用路径
  • Kafka：Java开发的消息神器，你真的懂了吗？
  • 货运系统源码 货运物流小程序 货运平台搭建 货运软件开发
  • 深度学习——基于卷积神经网络实现食物图像分类【4】（使用最优模型）
  • Directus搜索功能：全文检索和高级过滤的技术实现