SpringCloud - OpenFeign 参数传递和响应处理(全网最详细)

news2024/11/26 10:41:24

目录

一、OpenFeign 参数传递和响应处理

1.1、feign 客户端参数传递

1.1.1、零散类型参数传递

1. 例如 querystring 方式传参

2. 例如路径方式传参

1.1.2、对象参数传递

1. 对象参数传递案例

1.1.3、数组参数传递

1. 数组传参案例

1.1.4、集合类型的参数传递(了解)

1.2、feign 客户端响应处理

1.2.1、天坑!

1.2.2、解决办法

案例一

案例二(复杂数据类型)


一、OpenFeign 参数传递和响应处理


1.1、feign 客户端参数传递

1.1.1、零散类型参数传递

OpenFeign 对零散类型参数传递有以下限制

  • querystring 方式传递参数(例如 "/user?name=cyk" ):在 openfeign 接口声明中必须要给参数加入 @RequestParam 注解/
  • restful 路径传参(例如 "/user/{id}/{name}" ):在 openfeign 接口声明中必须要给参数加入注解 @PathVariable 注解.

为什么 openfeign 要这样区分呢?

因为 openfeign 是 伪HttpClient 对象,我们在远程调用他的客户端提供的接口时,并不知道你到底是路径传参还是问号传参,因此需要通过注解的方式来指明传参方式(就像 Spring Web 一样,只不过 Spring Web 中如果没指明传参类型,底层会按默认方式走,而 openfeign 则没有).

1. 例如 querystring 方式传参

a)远程调用方

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private ProductClient productClient;

    @GetMapping("/test1")
    public String test1(Long id) {
        String info = productClient.getInfo(id);
        System.out.println(info);
        return "user ok! \n" + info;
    }

}

b)服务提供方

@RestController
@RequestMapping("/product")
public class ProductController {

    @GetMapping("/get_info")
    public String getInfo(Long id) {
        return "product ok! id=" + id;
    }

}

c)feign 客户端

@FeignClient(value = "product", configuration = LoadBalancerClientConfiguration.class)
public interface ProductClient {

    @GetMapping("/product/get_info")
    String getInfo(@RequestParam("id") Long id);

}

d)测试结果:

2. 例如路径方式传参

a)远程调用方

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private ProductClient productClient;

    @GetMapping("/test2")
    public String test2(String name) {
        String info = productClient.getName(name);
        System.out.println(info);
        return "user ok! \n" + info;
    }

}

b)服务提供方

@RestController
@RequestMapping("/product")
public class ProductController {

    @GetMapping("/{name}")
    public String getName(@PathVariable("name") String name) {
        return "product ok! name=" + name;
    }

}

c)feign 客户端

@FeignClient(value = "product", configuration = LoadBalancerClientConfiguration.class)
public interface ProductClient {

    @GetMapping("/product/{name}")
    String getName(@PathVariable("name") String name);

}

d)测试结果:

扩展:restful 和 问号传参的区别

RESTful 风格是一种基于 HTTP 协议的 API 设计风格,它通过使用不同的 HTTP 方法(GET、POST、PUT、DELETE 等)和不同的 URL 来表示不同的操作和资源。RESTful 风格的优点包括:

  1. 清晰、简洁的 URL 设计:RESTful 风格的 URL 通常比较简洁,易于理解和记忆,能够清晰地表达出资源的结构和操作。
  2. 良好的可扩展性:RESTful 风格的设计允许你在原有的 API 上添加新的资源和方法,而不会对原有的 API 造成影响。
  3. 支持缓存:RESTful 风格的 API 可以利用 HTTP 缓存机制,提高 API 的响应速度和性能。
  4. 跨平台、跨语言:RESTful 风格的 API 可以被不同的平台和语言调用,具有很好的兼容性和可集成性。

问号传参风格是一种通过在 URL 中使用问号传参的方式来传递参数的 API 设计风格。它的优点包括:

  1. 动态参数传递:问号传参风格允许你在 URL 中直接传递参数,可以方便地实现动态参数的传递。
  2. 支持复杂参数类型:问号传参风格可以支持复杂的数据类型,例如对象、数组等,能够更好地满足复杂参数传递的需求。
  3. 易于开发和实现:问号传参风格的 API 开发起来相对简单,容易实现和调试。

总的来说,如果你需要设计一个简单的 API,并且对性能和扩展性要求不高,问号传参风格可能是一个不错的选择。而如果你需要设计一个复杂的 API,需要支持缓存、扩展性、跨平台和跨语言等要求,那么 RESTful 风格可能更适合你的需求。

1.1.2、对象参数传递

对象参数传递方式有两种,一种是 form 表单提交,另一种是 application/json 方式(推荐),这里主要讲第二种方式(实际开发中用的).

openfeign 接口要求对象传参必须要使用 @RequestBody 注解指明类型.

原因:这就像是我们给后端传递一个 json 格式数据类型,然后后端使用 一个对象接收参数,并通过 @RequestBody 指明他是 json 格式.

注意:openfeign 中对象传参只能使用 POST,并且也符合使用习惯,最主要是因为 GET 请求传对象会报错 Method Not Allowed.

1. 对象参数传递案例

a)远程调用方

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private ProductClient productClient;

    @GetMapping("/test3")
    public String test3(@RequestBody User user) {
        user.setUsername(user.getUsername());
        user.setPassword(user.getPassword());
        String userinfo = productClient.getUser(user);
        return "user ok! \n" + userinfo;
    }

}

 b)服务提供方

@RestController
@RequestMapping("/product")
public class ProductController {

    @PostMapping("/get_user")
    public String getUser(@RequestBody User user) {
        return "product ok! " + user.toString();
    }

}

c)feign 客户端

@FeignClient(value = "product", configuration = LoadBalancerClientConfiguration.class)
public interface ProductClient {

    //注意:openfeign 中对象传参只能使用 POST,并且也符合使用习惯
    //GET 请求传对象会报错: Method Not Allowed
    @PostMapping("/product/get_user")
    String getUser(@RequestBody User user);

}

d)测试结果:

1.1.3、数组参数传递

数组参数传递要求在 feign 客户端接口使用 @RequestParam 注解指明参数类型.

原因:数组参数传递,实际上就是 querystring 方式传参,例如 " /user/?name=123&name=456&name=789 ",其中 name 就是数组.

1. 数组传参案例

a)远程调用方

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private ProductClient productClient;

    @GetMapping("/test4")
    public String test4(String[] arr) {
        String result = productClient.getArr(arr);
        return "user ok! \n" + result;
    }

}

b)服务提供方

@RestController
@RequestMapping("/product")
public class ProductController {

    @GetMapping("/get_arr")
    public String getArr(@RequestParam("arr") String[] arr) {
        return "product ok!" + Arrays.toString(arr);
    }

}

c)feign 客户端

@FeignClient(value = "product", configuration = LoadBalancerClientConfiguration.class)
public interface ProductClient {

    @GetMapping("/product/get_arr")
    String getArr(@RequestParam("arr") String[] arr);

}

d)测试结果

1.1.4、集合类型的参数传递(了解)

spring mvc 不能直接接收集合类型参数(例如 List)!如果一定要接收,需要将集合类型参数放入对象中,然后使用对象的方式传递.

例如如下:

@Data
public class User {

    private String username;
    private String password;
    private List<String> arr;

}

这里就不演示了,因为 使用方式 以及 注意事项 和对象传递参数一样.

1.2、feign 客户端响应处理

1.2.1、天坑!

这里我们只需要知道一点就可以,Feign 客户端不能处理 Object 这种类型的返回格式!无论是对象中包含 Object 类型还是 Map 中存在 Object 类型....... 只要有他,就会出现各种格式问题.

例如,服务提供方传入的是一个 Long 类型,但是远程调用方接收到参数之后就变成了 Integer 类型(这里的处理,和 RabbitMQ 消息发送后的格式转化一个尿性),强转就会报以下错误:

ChatGPT 给出了以下解释:

这是因为 OpenFeign 在默认情况下会自动将对象和 Map 对象转换成 JSON 格式。它使用了 Jackson 作为默认的序列化/反序列化库。当你在使用 OpenFeign 进行远程调用时,返回的对象会被自动转换成 JSON 格式。

然而,需要注意的是,OpenFeign 只能处理简单的 Java 对象和 Map 对象,对于复杂的 Java 对象或包含特殊类型的对象,可能无法自动进行正确的序列化和反序列化。在这种情况下,你可能需要自定义序列化/反序列化方式,或者使用其他序列化库来替代默认的 Jackson。

1.2.2、解决办法

只要服务提供方的返回值类型涉及到 Object 、对象、Map 这些复杂类型,都可以在 Feign 客户端使用 String 类型作为接口返回值类型(因为 openfeign 会自动转换为 json 格式),远程调用方接收到响应之后,就可以使用 ObjectMapper.readValue() 反序列化成我们所需要的对象即可.

案例一

a)远程调用方

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private ProductClient productClient;

    @Autowired
    private ObjectMapper objectMapper;

    @SneakyThrows
    @GetMapping("/test6")
    public String test6() {
        String data = productClient.getData();
        Long finalData = objectMapper.readValue(data, Long.class);
        return "user ok!" + finalData;
    }

}

b)服务提供方

@RestController
@RequestMapping("/product")
public class ProductController {

    @GetMapping("/get_data")
    public Object getData() {
        return 100L;
    }

}

c)feign 客户端

@FeignClient(value = "product", configuration = LoadBalancerClientConfiguration.class)
public interface ProductClient {

    @GetMapping("/product/get_data")
    String getData();

}

测试结果:

案例二(复杂数据类型)

a)Feign 客户端接口响应类型

@Data
public class User {

    private String username;
    private String password;
    private List<String> arr;
}

b)远程调用方

@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private ProductClient productClient;

    @Autowired
    private ObjectMapper objectMapper;

    @GetMapping("/test5")
    public String test5() throws JsonProcessingException {
        User user = new User();
        user.setUsername("cyk");
        user.setPassword("1111");
        List<String> arrayList = new ArrayList<>();
        arrayList.add("aaa");
        arrayList.add("bbb");
        user.setArr(arrayList);
        String userList = productClient.getUserList(user);
        User user2 = objectMapper.readValue(userList, User.class);
        System.out.println(user2);
        return "user ok! \n" + userList;
    }

}

c)服务提供方

@RestController
@RequestMapping("/product")
public class ProductController {

    @PostMapping("/get_user_list")
    public User getUserList(@RequestBody User user) {
        return user;
    }

}

d)feign 客户端

@FeignClient(value = "product", configuration = LoadBalancerClientConfiguration.class)
public interface ProductClient {

    @PostMapping("/product/get_user_list")
    String getUserList(@RequestBody User user);

}

测试结果:

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1190800.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

PHP+MySQL人才招聘小程序系统源码 带完整前端+后端搭建教程

在当今竞争激烈的人才市场中&#xff0c;招聘平台的需求日益增长。传统的招聘平台往往需要投入大量的人力物力进行维护和管理&#xff0c;这对于许多中小企业来说是一个沉重的负担。因此&#xff0c;开发一个简单易用、高效便捷的招聘平台显得尤为重要。 PHP是一种流行的服务器…

通过docker-compose部署elk日志系统,并使用springboot整合

ELK是一种强大的分布式日志管理解决方案&#xff0c;它由三个核心组件组成&#xff1a; Elasticsearch&#xff1a;作为分布式搜索和分析引擎&#xff0c;Elasticsearch能够快速地存储、搜索和分析大量的日志数据&#xff0c;帮助用户轻松地找到所需的信息。 Logstash&#xf…

逐次变分模态分解(Sequential Variational Mode Decomposition,SVMD)(附代码)

代码原理 逐次变分模态分解&#xff08;Sequential Variational Mode Decomposition&#xff0c;SVMD&#xff09;是一种用于信号处理和数据分析的方法。它可以将复杂的信号分解为一系列模态函数&#xff0c;每个模态函数代表了信号中的一个特定频率成分。SVMD的主要目标是提取…

【每日一题】咒语和药水的成功对数

文章目录 Tag题目来源解题思路方法一&#xff1a;排序二分 写在最后 Tag 【排序二分】【数组】【2023-11-10】 题目来源 2300. 咒语和药水的成功对数 解题思路 方法一&#xff1a;排序二分 我们首先对 points 进行升序排序&#xff0c;然后枚举 spells 中的 x&#xff0c;需…

持续集成交付CICD:安装Gitlab Runner(从节点)

目录 一、实验 1.选择Gitlab Runner版本 2.安装Gitlab Runner&#xff08;第一种方式&#xff1a;交互式安装&#xff09; 3.安装Gitlab Runner&#xff08;第二种方式&#xff1a;非交互式安装&#xff09; 二、问题 1.如何查看Gitlab版本 一、实验 1.选择Gitlab Runne…

如何用Excel软件制作最小二乘法①

一、用自带的选项&#xff08;不推荐&#xff09;&#xff0c;因为感觉只是近似&#xff0c;虽然结果一样 1.在Excel中输入或打开要进行在excel中输入或打开要进行最小二乘法拟合的数据&#xff0c;如图所示。 2.按住“shift”键的同时&#xff0c;用鼠标左键单击以选择数据&a…

android手机平板拓展电脑音频

&#xff08;1&#xff09;首先确保电脑上有声卡&#xff0c;就是电脑右下角小喇叭能调音量&#xff0c;不管电脑会不会响&#xff0c;如果小喇叭标记了个错误&#xff0c;说明没有声卡&#xff0c;安装图上的虚拟声卡软件。 &#xff08;2&#xff09;图上第一个PC免安装及局…

Code Review最佳实践

Code Review最佳实践 Code Review 我一直认为Code Review&#xff08;代码审查&#xff09;是软件开发中的最佳实践之一&#xff0c;可以有效提高整体代码质量&#xff0c;及时发现代码中可能存在的问题。包括像Google、微软这些公司&#xff0c;Code Review都是基本要求&…

07、SpringBoot+微信支付 -->处理超时订单(定时查询、核实微信支付平台的订单、调用微信支付平台查单接口、更新本地订单状态、记录支付日志)

目录 Native 支付处理超时订单定时的讲解需求分析代码定时任务&#xff1a;WxPayTask定时查询的方法&#xff1a;核实订单状态等操作 &#xff1a;WxPayServiceImpl查单接口方法&#xff1a;queryOrder更新本地订单状态&#xff1a;updateStatusByOrderNo记录支付日志&#xff…

tqdm学习

from tqdm import tqdmepochs 10 epoch_bar tqdm(range(epochs)) count 0 for _ in epoch_bar:count count1print("count {}".format(count))print(_)每次就是一个epoch

CSDN每日一题学习训练——Java版(克隆图、最接近的三数之和、求公式的值)

版本说明 当前版本号[20231109]。 版本修改说明20231109初版 目录 文章目录 版本说明目录克隆图题目解题思路代码思路参考代码 最接近的三数之和题目解题思路代码思路参考代码 求公式的值题目解题思路代码思路参考代码 克隆图 题目 给你无向 连通(https://baike.baidu.com…

电商项目之Java8函数式接口落地实践

文章目录 1 问题背景2 前言3 多处重复的重试机制代码4 优化后的代码5 进一步优化 1 问题背景 在电商场景中&#xff0c;会调用很多第三方的云服务&#xff0c;比如发送邮件、发起支付、发送验证码等等。由于网络存在抖动&#xff0c;有时候发起调用后会拿到500的状态码&#xf…

Visual Studio2022安装教程【图文详解】(大一小白)编译软件

工欲善其事&#xff0c;必先利其器。想要学好编程&#xff0c;首先要把手中的工具利用好&#xff0c;今天小编教一下大家如何下载安装并使用史上最强大的编译器--Visual Studio&#x1f357; 一.Visual Studio下载及安装 https://visualstudio.microsoft.com/ 打开文件 点击.ex…

Halcon的相机内参外参的标定

halcon标定相机内参只能使用方向标定板和圆点标定板。并且方向标定板可也可用性极高。 1.打开halcon的标定助手&#xff0c;选择标定板的描述文件&#xff0c;填写标定板的厚度&#xff0c;根据相机选择像元的尺寸和镜头的焦距。如果已有相机内参&#xff0c;只标定外参&#…

使用ESP8266构建家庭自动化系统

随着物联网技术的不断发展&#xff0c;家庭自动化系统变得越来越受欢迎。ESP8266是一款非常适合于构建家庭自动化系统的WiFi模块。它小巧、低成本&#xff0c;能够实现与各种传感器和执行器的连接&#xff0c;为家庭带来智能化、便利化的体验。在本篇文章中&#xff0c;我们将向…

kubernetes集群编排(9)

目录 helm 部署helm 封装chart包 上传chart到OCI仓库 部署wordpress博客系统 helm部署storageclass helm部署ingress-nginx helm部署metrics-server kubeapps 更新 helm 部署helm 官网&#xff1a; Helm | 快速入门指南 https://github.com/helm/helm/releases [rootk8s2 ~]# t…

2022年06月 Python(四级)真题解析#中国电子学会#全国青少年软件编程等级考试

Python等级考试(1~6级)全部真题・点这里 一、单选题(共25题,每题2分,共50分) 第1题 有如下Python程序,包含lambda函数,运行该程序后,输出的结果是?( ) g = lambda x,y:x*y print(g(2,3)

理解RNN以及模型搭建代码

RNN结构 这是一张不直观易懂的RNN结构示意图。但也是大家见得最多结构示意图。 RNN模型解释 RNN一文就讲解清楚的博客&#xff0c;看这里&#xff1a;https://zhuanlan.zhihu.com/p/408998328 RNN为什么梯度消失和梯度爆炸&#xff0c;看这里&#xff1a;https://zhuanlan.z…

隧道技术的三种应用场景(IPv6,多播,VPN)

目录 1.IPv6的隧道技术 2.多播路由选择 (1)洪泛 (2)隧道技术 (3)基于核心的发现技术 3.隧道技术实现&#xff08;VPN&#xff09;虚拟专用网 1.IPv6的隧道技术 IPv6与IPv4的过渡技术中包含了IPv6的隧道技术&#xff1a; http://t.csdnimg.cn/wuvXY 2.多播路由选择 转发…

Redis数据类型之List类型

文章目录 简介常用命令赋值语法LPUSHRPUSHLPUSHXRPUSHX 取值语法LLENLINDEXLRANGE 删除语法LPOPRPOPBLPOPBRPOPLTRIMLREM 修改语法LSETLINSERT 高级命令RPOPLPUSH 应用场景 简介 List类型是一个链表结构的集合&#xff0c;其主要功能有push&#xff0c;pop&#xff0c;获取元素…