[Spring] OpenFeign的使用

server/2025/1/23 11:41:55/

🌸个人主页:https://blog.csdn.net/2301_80050796?spm=1000.2115.3001.5343
🏵️热门专栏:
🧊 Java基本语法(97平均质量分)https://blog.csdn.net/2301_80050796/category_12615970.html?spm=1001.2014.3001.5482
🍕 Collection与数据结构 (93平均质量分)https://blog.csdn.net/2301_80050796/category_12621348.html?spm=1001.2014.3001.5482
🧀线程与网络(96平均质量分) https://blog.csdn.net/2301_80050796/category_12643370.html?spm=1001.2014.3001.5482
🍭MySql数据库(93平均质量分)https://blog.csdn.net/2301_80050796/category_12629890.html?spm=1001.2014.3001.5482
🍬算法(97平均质量分)https://blog.csdn.net/2301_80050796/category_12676091.html?spm=1001.2014.3001.5482
🍃 Spring(97平均质量分)https://blog.csdn.net/2301_80050796/category_12724152.html?spm=1001.2014.3001.5482
🎃Redis(97平均质量分)https://blog.csdn.net/2301_80050796/category_12777129.html?spm=1001.2014.3001.5482
🐰RabbitMQ(97平均质量分) https://blog.csdn.net/2301_80050796/category_12792900.html?spm=1001.2014.3001.5482
感谢点赞与关注~~~
在这里插入图片描述

目录

  • 1. RestTemplate存在的问题
  • 2. OpenFeign介绍
    • 2.1 引入依赖
    • 2.2 添加注解
    • 2.3 编写OpenFeign客户端
    • 2.4 远程调用
    • 2.5 测试
  • 3. OpenFeign参数传递
    • 3.1 传递单个参数
    • 3.2 传递多个参数
    • 4.3 传递对象
    • 3.4 传递Json
  • 4. 最佳实践
    • 4.1 Feign继承方式
    • 4.2 Feign抽取方式

1. RestTemplate存在的问题

观察我们之前远程调用的代码

java">public OrderInfo selectOrder(Integer id){OrderInfo orderInfo = orderMapper.selectOrderById(id);//把获取到的服务URL拼接到远程调用的URL中String url = "http://product-service/product/select?id=" + orderInfo.getProductId();ProductInfo productInfo = restTemplate.getForObject(url, ProductInfo.class);orderInfo.setProductInfo(productInfo);return orderInfo;
}

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

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

微服务之间的通行主要有两种方式,一种是RPC,一种是HTTP.在SpringCloud中,默认是使用HTTP进行通信的,最常用的实现形式有两种:

  • RestTemplate
  • OpenFeign

接下来我们就来详细介绍一下OpenFeign.

2. OpenFeign介绍

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

2.1 引入依赖

首先我们需要在服务调用方(order-service)中引入依赖

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

2.2 添加注解

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

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

2.3 编写OpenFeign客户端

在调用其他服务的客户端之下,编写API调用接口,基于SpringMVC的注解来声明远程调用的信息.
在这里插入图片描述

java">@FeignClient(name = "product-service")
public interface ProductApi {@RequestMapping("/product/select")ProductInfo getProductInfo(@RequestParam("id")Integer id);
}

[注意]:在接口的参数前面必须使用@RequestParam加上所调用服务接口的对应参数,否则参数无法传入,就相当于在请求的后面加上了?参数=xxx.
在这里插入图片描述

也可以把该服务的接口的统一前缀(放在类上的@RequestMapping)统一放到FeignClient注解的Path参数中.

java">@FeignClient(name = "product-service",path = "/product")
public interface ProductApi {@RequestMapping("/select")ProductInfo getProductInfo(@RequestParam("id")Integer id);
}

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

  • name/value: 指定OpenFeign的名称,也就是被调用的微服务的名称,用于服务发现,Feign底层会使用SpringLoadBalance进行负载均衡.
    当然也可以使用URL属性指定一个具体的URL.
  • Path: 定义当前FeignClient的统一前缀,一般是被调用方Controller层的类注解.

2.4 远程调用

修改远程调用方法

java">@Service
public class OrderService {@Autowiredprivate OrderMapper orderMapper;@Autowiredprivate ProductApi api;//设置原子类public OrderInfo selectOrder(Integer id){OrderInfo orderInfo = orderMapper.selectOrderById(id);//把获取到的服务URL拼接到远程调用的URL中Integer productId = orderInfo.getProductId();ProductInfo productInfo = api.getProductInfo(productId);orderInfo.setProductInfo(productInfo);return orderInfo;}
}

2.5 测试

启动服务.访问接口,测试远程调用.
在这里插入图片描述

3. OpenFeign参数传递

3.1 传递单个参数

我们上面2.4的例子就是单个参数的调用.下面我们再来举一个例子

  1. 服务提供方product-service
java">@RestController
@RequestMapping("/product")
public class ProductController {@RequestMapping("/p1")public String p1(Integer id){return "接收到参数"+id;}
}
  1. FeginClient
java">@FeignClient(value = "product-service")
public interface ProductApi {@RequestMapping("/product/p1")String p1(@RequestParam("id") Integer id);
}

和我们上面提到的一样,@RequestParam是用来做参数绑定的,不能省略.
3. order-service

java">@RequestMapping("/order")
@RestController
public class OrderController {@Autowiredprivate ProductApi api;@RequestMapping("/p1")public String p1(Integer id){return api.p1(id);}
}

远程测试调用:GET http://127.0.0.1:8080/order/p1?id=1
在这里插入图片描述

3.2 传递多个参数

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

  1. 服务提供方product-service
java">@RestController
@RequestMapping("/product")
public class ProductController {@RequestMapping("/p2")public String p2(Integer id1,Integer id2){return "接收到参数1:" + id1 + ",接收到参数2:" + id2;}
}
  1. FeignClient
java">@FeignClient(value = "product-service")
public interface ProductApi {@RequestMapping("/product/p2")String p2(@RequestParam("id1") Integer p1,@RequestParam("id2") Integer p2);
}
  1. 服务消费方order-service
java">@RequestMapping("/order")
@RestController
public class OrderController {@Autowiredprivate ProductApi api;@RequestMapping("/p2")public String p2(Integer p1,Integer p2){return api.p2(p1,p2);}
}

调用接口进行测试:GET http://127.0.0.1:8080/order/p2?p1=1&p2=2
在这里插入图片描述

4.3 传递对象

  1. 服务提供方product-service
java">@RequestMapping("/p3")
public String p3(ProductInfo productInfo){return "接收到对象:" + productInfo;
}
  1. Feign
java">@RequestMapping("/product/p3")
String p3(@SpringQueryMap ProductInfo productInfo);

其中@SpringQueryMap注解表示的是:可以方便地将一个对象的属性作为请求的查询参数添加到请求的 URL中,避免了手动构建查询参数字符串(如json)的繁琐过程.
3. order-service

java">@RequestMapping("/p3")
public String p3(ProductInfo productInfo){return api.p3(productInfo);
}

测试远程调用:GET http://127.0.0.1:8080/order/p3?id=5&productName=zhangsan
在这里插入图片描述

3.4 传递Json

和我们之前学习SpringBoot的时候一样,同样是使用@RequestBody注解进行绑定.
注意由于数据在服务之间一直是按照Json格式传递的,所以服务方,服务调用方,FeignClient的参数上都需要加上注解.

  1. 服务提供方product-service
java">@RequestMapping("/p4")
public String p4(@RequestBody ProductInfo productInfo){return "接收到对象:" + productInfo;
}
  1. FeignClient
java">@RequestMapping("/product/p4")
String p4(@RequestBody ProductInfo productInfo);
  1. 服务消费方order-service
java">@RequestMapping("/p4")
public String p4(@RequestBody ProductInfo productInfo){return api.p4(productInfo);
}

测试远程调用:http://127.0.0.1:8080/order/p4
在这里插入图片描述

4. 最佳实践

通过观察,我们也能看出来,Feign的客户端与服务提供者的controller代码非常相似.
Feign客户端:

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

服务提供方Controller

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

有没有一种方法可以简化这种写法呢?

4.1 Feign继承方式

Feign支持继承的方式,我们可以把一些常见的操作封装到接口里.
我可以定义好一个接口,服务提供方实现这个接口,服务消费方编写Feign接口的时候,直接继承这个接口.
接口可以放在一个公共的jar包中,供服务提供方和服务消费方使用.

  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>
  1. 编写接口
    复制ProductInfo类和ProductApi到product-api模块中.把ProductApi改名为ProductInterface
    在这里插入图片描述
  2. 打jar包,并安装到本地Maven仓库
    在这里插入图片描述
    点击install.该模块就会被安装到本地的Maven仓库.
    在这里插入图片描述
    由于jar包中已经有了ProductInfo类,所以我们就可以把product-service和order-service的ProductInfo类注掉了.
  3. 服务提供方
    需要先在服务方中引入对应模块的依赖.
<dependency><groupId>org.example</groupId><artifactId>product-api</artifactId><version>1.0-SNAPSHOT</version><scope>compile</scope>
</dependency>

服务方product-service直接实现接口ProductInterface.

java">@RestController
@RequestMapping("/product")
public class ProductController implements ProductInterface {@Autowiredprivate ProductService productService;@RequestMapping("/select")public ProductInfo getProductInfo(Integer id){return productService.selectById(id);}@RequestMapping("/p1")public String p1(Integer id){return "接收到参数"+id;}@RequestMapping("/p2")public String p2(Integer id1,Integer id2){return "接收到参数1:" + id1 + ",接收到参数2:" + id2;}@RequestMapping("/p3")public String p3(ProductInfo productInfo){return "接收到对象:" + productInfo;}@RequestMapping("/p4")public String p4(@RequestBody ProductInfo productInfo){return "接收到对象:" + productInfo;}
}
  1. 服务消费方
    同样,首先先添加依赖.
    之后让FeignClient继承ProductInterface
java">@FeignClient(value = "product-service")
public interface ProductApi extends ProductInterface {}

注意在上述步骤中,把ProductInfo类引入包的路径全部改为之前打包的product-api模块下ProductInfo类的路径.

  1. 测试接口
    http://127.0.0.1:8080/order/select?id=1
    在这里插入图片描述

4.2 Feign抽取方式

官方推荐Feign的使用方式为继承的方式,但是企业开发中,更多是把Feign接口抽取为⼀个独立的模块(做法和继承相似,但理念不同).
操作方法:
将Feign的Client抽取为⼀个独立的模块,并把涉及到的实体类等都放在这个模块中,打成⼀个Jar.服务消费方只需要依赖该Jar包即可.这种方式在企业中比较常见,Jar包通常由服务提供方来实现.
前4步和前面继承的方式一样.只不过接口ProductApi在复制到新模块的时候不用修改名字
在这里插入图片描述

  1. 服务消费方使用product-api
    首先引入依赖,之后把该模块中原有的ProductApi接口注掉.
<dependency><groupId>org.example</groupId><artifactId>product-api</artifactId><version>1.0-SNAPSHOT</version>
</dependency>

之后指定扫描类
在启动类中添加需要加载的Feign客户端.

java">@SpringBootApplication
@EnableFeignClients(clients = ProductApi.class)
public class OrderServiceApplication {public static void main(String[] args) {SpringApplication.run(OrderServiceApplication.class,args);}
}
  1. 测试
    远程调用接口http://127.0.0.1:8080/order/select?id=1
    在这里插入图片描述

http://www.ppmy.cn/server/160722.html

相关文章

【大模型】ChatGPT 高效处理图片技巧使用详解

【大模型】ChatGPT 高效处理图片技巧使用详解

目录 一、前言 二、ChatGPT 4 图片处理介绍 2.1 ChatGPT 4 图片处理概述 2.1.1 图像识别与分类 2.1.2 图像搜索 2.1.3 图像生成 2.1.4 多模态理解 2.1.5 细粒度图像识别 2.1.6 生成式图像任务处理 2.1.7 图像与文本互动 2.2 ChatGPT 4 图片处理应用场景 三、文生图操…
阅读更多...
maven常见知识点

maven常见知识点

1、maven是什么&#xff1f; maven是Java的包管理工具&#xff0c;因为java包太多了&#xff0c;使用工具统一管理。 2、引入同一个包时使用哪个&#xff1f; 会遵循 路径最短优先 和 声明顺序优先 两大原则。解决这个问题的过程也被称为 Maven 依赖调解。 3、什么是 POM&…
阅读更多...
某大厂一面：说说ThreadLocal的实现原理

某大厂一面：说说ThreadLocal的实现原理

ThreadLocal 是 Java 中一个非常有用的类&#xff0c;它提供了线程本地存储的功能。其作用是为每个线程提供独立的变量副本&#xff0c;使得不同线程访问时互不干扰。以下是 ThreadLocal 的详细原理&#xff1a; 1. ThreadLocal 类的基本作用 ThreadLocal 通过保证每个线程都…
阅读更多...
Web 音视频（三）在浏览器中创建视频

Web 音视频（三）在浏览器中创建视频

前言 ​ 在 WebCodecs 之前&#xff0c;由于编解码能力的缺失&#xff0c;几乎无法在纯浏览器中编辑、创建视频。 WebCodecs 补齐了编解码能力&#xff0c;相当于在浏览器中提供了视频创作能力。 预计 WebCodecs 将会像 HTML5 技术&#xff08;Video、Audio、MSE...&#xff0…
阅读更多...
arkime和elasticsearch 安装方法三

arkime和elasticsearch 安装方法三

Ubuntu新机 sudo apt upgrade sudo apt install open-vm-tools-desktop -y sudo reboot 然后换源 cp /etc/apt/source.list /etc/apt/source.list.bak sudo apt update nano /etc/apt/source.list deb https://mirrors.aliyun.com/ubuntu/ jammy main restricted unive…
阅读更多...
工业相机 SDK 二次开发-Halcon 插件

工业相机 SDK 二次开发-Halcon 插件

本文介绍了 Halcon 连接相机时插件的使用。通过本套插件可连接海康 的工业相机。 一. 环境配置 1. 拷贝动态库 在 用 户 安 装 MVS 目 录 下 按 照 如 下 路 径 Development\ThirdPartyPlatformAdapter 找到目录为 HalconHDevelop 的文 件夹&#xff0c;根据 Halcon 版本找到对…
阅读更多...
喜报！华普微荣获威星智能“优秀供应商奖”

喜报！华普微荣获威星智能“优秀供应商奖”

近日&#xff0c;华普微凭借着过硬的产品质量和优秀的服务品质&#xff0c;成功荣获了浙江威星智能仪表股份有限公司&#xff08;以下简称“威星智能”&#xff09;授予的“2024年度优秀供应商”奖。这项荣誉不仅代表着威星智能对华普微过往辛勤付出与卓越贡献的高度认可&#…
阅读更多...
【Python运维】Python与Terraform结合：实现云基础设施的自动化部署

【Python运维】Python与Terraform结合：实现云基础设施的自动化部署

《Python OpenCV从菜鸟到高手》带你进入图像处理与计算机视觉的大门！ 解锁Python编程的无限可能：《奇妙的Python》带你漫游代码世界 随着云计算的普及，自动化部署云基础设施成为提升运维效率和降低人为错误的重要手段。本文深入探讨了如何结合Python与Terraform实现云基础…
阅读更多...
最新文章

Copyright @ 2022~2023