feign post参数对象不加@RequestBody的使用说明

目录
  • feign post参数对象不加@RequestBody
  • 使用@RequestParam、@RequestBody 的正确姿势
    • 背景
    • 详细情况
    • 小结一下

feign post参数对象不加@RequestBody

最近在做小程序调支付服务接口的一个功能,这个feign接口传参真的太费事。

代码我就改造了下,不直接上真实代码。

比如小程序调支付服务的订单查询接口,支付服务那边的controller的订单查询方法是:

 @ResponseBody
    @RequestMapping(value = "/order/select", method = RequestMethod.POST)
    @ApiOperation(value = "订单查询", notes = "订单查询")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "queryNum", value = "查询流水", paramType = "form", required = true),
            @ApiImplicitParam(name = "queryDate", value = "流水日期", paramType = "form", required = false)
    })
    public Order qryBarcodePay(@ApiIgnore Order hero) throws Exception {
        xxxxx;
    }

这个post接口,有点奇怪,多了很多没见过的注解,而一般情况,post接口里参数对象应该是这么写的:

....
public Order qryBarcodePay(@RequestBody Order hero) throws Exception {
....
}

也就是传参的body前面一般会加上@RequestBody参数,但是支付服务的接口用到了@ApiImplicitParam和@ApiIgnore 注解,属于Swagger2的注解,有必要先学习下这两个注解的基本使用:

  • @ApiImplicitParam的使用
  • @ApiIgnore注解的使用

但是呢,一开始没想太多,调支付服务的feign接口的方法就按着平常写的post接口来:

@FeignClient(name="pay", path="pay")
public interface payFeignClient {
    @ResponseBody
    @RequestMapping(value = "/payment/order/select", method = RequestMethod.POST)
    @ApiOperation(value = "订单查询", notes = "订单查询")
    public Order qryBarcodePay(@RequestBody Order order);
}

然后在调式的时候,发现小程序调支付服务这个订单查询接口的时候,支付服务那边接受的参数对象Order字段里面的值都是null,原因是feign这边传的Order对象是RequestBody类型,而支付服务那边的接口接受参数时没有加@RequestBody,所以应该是反序列化的时候,由于格式不同,就没有成功,才出现了支付服务这边接受的参数对象Order字段里面的值都为null。

解决办法:

feign接口改成这样子就正常了:

@FeignClient(name="pay", path="pay")
public interface payFeignClient {
    @RequestMapping(value = "/payment/qry/barcode/pay", method = RequestMethod.POST)
    @ApiOperation(value = "订单查询", notes = "订单查询")
    @Headers(MediaType.APPLICATION_FORM_URLENCODED_VALUE)
    public ResultInfo<QryBarcodePayModel> qryBarcodePay(
            @RequestParam(required = true, name = "qryNo") String qryNo,
            @RequestParam(required = true, name = "hotelCode") String hotelCode);
}

这里对比一下feign和原接口的参数:

原接口:

@ApiImplicitParams({
            @ApiImplicitParam(name = "queryNum", value = "查询流水", paramType = "form", required = true),
            @ApiImplicitParam(name = "queryDate", value = "流水日期", paramType = "form", required = false)
    })
    public Order qryBarcodePay(@ApiIgnore Order hero)

feign接口:

@Headers(MediaType.APPLICATION_FORM_URLENCODED_VALUE)
    public ResultInfo<QryBarcodePayModel> qryBarcodePay(
            @RequestParam(required = true, name = "qryNo") String qryNo,
            @RequestParam(required = true, name = "hotelCode") String hotelCode);

可以看出来差别很大,首先传参,原接口是post请求,传的是一个对象,但是对象前加了@ApiIgnore 注解,相信前面给的链接学习后知道这个注解表示的是忽略的意思,也就是传参的时候,忽略掉这个对象,所以feign传的参压根就没有对象。

其次原接口对两个参数加了@ApiImplicitParam,需要提前说明的是,加了@ApiImplicitParam的两个参数queryNum、queryDate都属于Order 类里的属性。

重点看@ApiImplicitParam的paramType = “form”, required = true这两个地方,paramType="form"就表示传参以form表单的形式,所以feign接口方法上面加了

@Headers(MediaType.APPLICATION_FORM_URLENCODED_VALUE)

其次require=true就表示这两个参数是必传的。

以上就确定了feign的接口方法应该如何写,最后参数到原接口过来时,会自动将queryNum、queryDate两个参数set到Order对象里去,至于为何,我也不太清楚,暂时知道是可以这么用的。

使用@RequestParam、@RequestBody 的正确姿势

背景

最近在使用 @RequestParam、@RequestBody 注解定义 feign 接口的时候出现一些使用上的问题,造成调用方启动的时候会报错。

详细情况

第一种情况,如下:

@PostMapping(value = "/hello2")
BetaDto hello2(String name1);

接口有且只有一个 key/value 参数,此时可以不必在 name1 参数上使用 @RequestParam 注解。通过 Feign 调用该接口的调用方可以正常启动。

第二种情况,如下:

 @PostMapping(value = "/hello2")
BetaDto hello2(@RequestParam String name1);

接口有且只有一个 key/value 参数,此时如果对 name1 参数上使用 @RequestParam 注解,此时通过 Feign 调用该接口的调用方可启动的时候回抛出如下错误:

Caused by: java.lang.IllegalStateException: RequestParam.value() was empty on parameter 0

意思是 @RequestParam 的 value 值不允许为空,正确的姿势如下:

 @PostMapping(value = "/hello2")
BetaDto hello2(@RequestParam("name1") String name1);

第三种情况,如下:

@PostMapping(value = "/hello2")
BetaDto hello2(String name1, String name2);

接口存在多个 key/value 参数,此时通过 Feign 调用该接口的调用方启动的时候会抛出如下错误:

Caused by: java.lang.IllegalStateException: Method has too many Body parameters

像这种多参数(key/value)的情况必须为每个参数增加 @RequestParam 注解,正确的姿势如下:

@PostMapping(value = "/hello2")
BetaDto hello2(@RequestParam(“name1”)  String name1, @RequestParam(“name2”)  String name2);

小结一下

在使用 @RequestParam 注解的时候,value 值必须设置,如下:

@PostMapping(value = "/hello2")
BetaDto hello2(@RequestParam(“name1”)  String name1);

如果接口有且只有一个参数,并且该参数是 key/value 类型,则无需为该参数设置 @RequestParam 注解,如下:

@PostMapping(value = "/hello2")
BetaDto hello2(String name1);

接口存在多个参数(key/value、Json 对象)的时候,每个 key/value 类型的参数必须显示的指定 @RequestParam 注解,且必须设置对应的 value

@PostMapping(value = "/hello2")
BetaDto hello2(@RequestParam(“name1”) String name1, RequestParam(“name2”) String name2, BetaDto betaDto);

接口无论有多个参数还是一个参数,都不需要为 Json 对象参数显示的指定 @RequestBody 注解

@PostMapping(value = "/hello1")
BetaDto hello1(BetaDto betaDto);
@PostMapping(value = "/hello2")
BetaDto hello2(@RequestParam(“name1”) String name1, RequestParam(“name2”) String name2, BetaDto betaDto);

每个接口里只允许有一个 JSON 对象类型的参数,否则通过 Feign 调用该接口的调用方启动的时候会抛出如下错误:

Caused by: java.lang.IllegalStateException: Method has too many Body parameters

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

(0)

相关推荐

  • @RequestBody的使用详解

    提示:建议一定要看后面的@RequestBody的核心逻辑源码以及六个重要结论!本文前半部分的内容都是一些基 本知识常识,可选择性跳过. 声明:本文是基于SpringBoot,进行的演示说明. 基础知识介绍: @RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的):GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交.在后端的同一个接收方法里,@RequestBody与@Request

  • 解决SpringCloud Feign传对象参数调用失败的问题

    SpringCloud Feign传对象参数调用失败 不支持GET请求方式 使用Apache HttpClient替换Feign原生httpclient @RequestBody接收json参数 bootstrap-local.yml feign: httpclient: enabled: true pom.xml <!-- 使用Apache HttpClient替换Feign原生httpclient --> <dependency> <groupId>com.netf

  • 使用@RequestBody传对象参数时碰到的坑

    目录 @RequestBody传对象参数时碰到的坑 我的真实代码是这样的: 也就是下面的区别: @RequestBody 的正确使用 @RequestBody接收的是一个Json对象 @RequestBody的使用 @RequestBody传对象参数时碰到的坑 工作中需要使用到http接口传一个对象数组,网上找到某博客:springmvc参数为对象,数组 但是测试还是不对,报错: 2019-02-21 23:44:37.168 WARN 34133 --- [nio-7001-exec-6] .

  • spring cloud feign不支持@RequestBody+ RequestMethod.GET报错的解决方法

    1.问题梳理: 异常:org.springframework.web.HttpRequestMethodNotSupportedException: Request method 'POST' not supported 很明显是最终feign执行http请求时把这个方法认定为POST,但feign client中又定义了RequestMethod.GET 或 @GetMapping,冲突导致报错 那么为什么feign会认为这个方法是post呢? 源码追踪: 1.我们从feignClient注解

  • feign post参数对象不加@RequestBody的使用说明

    目录 feign post参数对象不加@RequestBody 使用@RequestParam.@RequestBody 的正确姿势 背景 详细情况 小结一下 feign post参数对象不加@RequestBody 最近在做小程序调支付服务接口的一个功能,这个feign接口传参真的太费事. 代码我就改造了下,不直接上真实代码. 比如小程序调支付服务的订单查询接口,支付服务那边的controller的订单查询方法是: @ResponseBody @RequestMapping(value = "

  • 关于Springboot | @RequestBody 接收到的参数对象属性为空的问题

    背景 今天在调试项目的时候遇到一个坑,用Postman发送一个post请求,在Springboot项目使用@RequestBody接收时参数总是报不存在,但是多次检查postman上的请求格式以及项目代码都没有问题 Postman: 请求参数: { "firstName":"fdsaf", "lastName":"dfasdf" } Controller: Entity 通过debug模式可以发现传进到实体的参数都为null

  • 关于feign调用的参数传递问题(@RequestBody和@RequestParam)

    目录 feign调用的参数传递问题 错误写法 正确写法 body的正确形式 feign传参总结 返回实体对象服务提供者 restful传参服务提供者 传实体对象服务提供者 feign调用的参数传递问题 SpringCloud Feign报错: java.lang.IllegalStateException: Method has too many Body parameters 上边的报错提示为body太多了,feign调用的方法里只能有一个body但是requestparam可以多个 错误写法

  • 使用feign传递参数类型为MultipartFile的问题

    目录 feign传递参数类型为MultipartFile 引入maven依赖 加入配置类 在feign客户端进行配置 feign传参MultipartFile问题解决 首先引入依赖 新建feign的配置 在feign接口中配置 feign传递参数类型为MultipartFile feign默认是不支持多媒体文件类型的文件传输的,但是可以通过引入第三方jar包解决这个问题,步骤可以分为三步. 引入maven依赖         <dependency>             <group

  • Js 获取当前函数参数对象的实现代码

    有时候在封装控件的时候在很多 Js 函数中需要获取传入的直接参数或者对象参数,那么我们就需要每次都去判断第一个对象,所以为了方便在此封装一个函数,来获取当前函数中的参数值: /*------------------------------------------ * 清除字符串两端空格,包含换行符.制表符 *------------------------------------------*/ String.prototype.Trim = function () { return this.

  • MyBatis拦截器:给参数对象属性赋值的实例

    该拦截器的作用:在进行增加.修改等操作时,给数据模型的一些通用操作属性(如:创建人.创建时间.修改人.修改时间等)自动赋值. 该实现是在DAO层拦截,即存入DB前最后一层.后经分析,不是很合理,改为在service层拦截,用spring AOP来实现了,该代码遂弃用.不过已经测试可用,记录备忘. package com.development; import java.lang.reflect.InvocationTargetException; import java.util.Date; i

  • 解析c++中参数对象与局部对象的析构顺序的详解

    下面是c++的源码: 复制代码 代码如下: class X  {public:   int i;   int j;   ~X() {} };void f(X x) {  X x1;  x.i = 1;  x.j = 2; }int main() {    f(X());} 下面是main函数的汇编码: 复制代码 代码如下: _main    PROC ; 15   : int main() { push    ebp    mov    ebp, esp    sub    esp, 8;为临时

  • JavaScript处理变量命名的参数对象

    问题描述:在开发过程中,遇到一个给对象赋值的问题,参数是通过循环变量的方式进行处理. js 重要函数 window,eval 1.window 定义全局变量. 2.eval() 函数计算 JavaScript 字符串,并把它作为脚本代码来执行. 如果参数是一个表达式,eval() 函数将执行表达式.如果参数是Javascript语句,eval()将执行 Javascript 语句. 另外,window使用注意点如下图: 事例: // 用数组中的变量定义参数 let need_arr = ['a1

  • Spring Cloud Feign 使用对象参数的操作

    目录 概述 @RequestBody @SpringQueryMap QueryMapEncoder 解决方案 概述 Spring Cloud Feign 用于微服务的封装,通过接口代理的实现方式让微服务调用变得简单,让微服务的使用上如同本地服务.但是它在传参方面不是很完美.在使用 Feign 代理 GET 请求时,对于简单参数(基本类型.包装器.字符串)的使用上没有困难,但是在使用对象传参时却无法自动的将对象包含的字段解析出来. 如果你没耐心看完,直接跳到最后一个标题跟着操作就行了. @Req

  • javascript,php获取函数参数对象的代码

    例如: 复制代码 代码如下: function say () { alert (arguments[0]+'说:'+arguments[1]); } say ('fanglor','fanglor is a boy !'); 结果:弹出 fanglor 说:fanglor is a boy ! -------------------------------------------------------------------------------- 这个有点类似于php 中的 func_ge

随机推荐