feign post參數(shù)對(duì)象不加@RequestBody

最近在做小程序調(diào)支付服務(wù)接口的一個(gè)功能，這個(gè)feign接口傳參真的太費(fèi)事。

代碼我就改造了下，不直接上真實(shí)代碼。

比如小程序調(diào)支付服務(wù)的訂單查詢接口，支付服務(wù)那邊的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;
    }

這個(gè)post接口，有點(diǎn)奇怪，多了很多沒(méi)見(jiàn)過(guò)的注解，而一般情況，post接口里參數(shù)對(duì)象應(yīng)該是這么寫的：

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

也就是傳參的body前面一般會(huì)加上@RequestBody參數(shù)，但是支付服務(wù)的接口用到了@ApiImplicitParam和@ApiIgnore 注解，屬于Swagger2的注解，有必要先學(xué)習(xí)下這兩個(gè)注解的基本使用：

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

但是呢，一開始沒(méi)想太多，調(diào)支付服務(wù)的feign接口的方法就按著平常寫的post接口來(lái)：

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

然后在調(diào)式的時(shí)候，發(fā)現(xiàn)小程序調(diào)支付服務(wù)這個(gè)訂單查詢接口的時(shí)候，支付服務(wù)那邊接受的參數(shù)對(duì)象Order字段里面的值都是null，原因是feign這邊傳的Order對(duì)象是RequestBody類型，而支付服務(wù)那邊的接口接受參數(shù)時(shí)沒(méi)有加@RequestBody，所以應(yīng)該是反序列化的時(shí)候，由于格式不同，就沒(méi)有成功，才出現(xiàn)了支付服務(wù)這邊接受的參數(shù)對(duì)象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);
}

這里對(duì)比一下feign和原接口的參數(shù)

原接口：

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

可以看出來(lái)差別很大，首先傳參，原接口是post請(qǐng)求，傳的是一個(gè)對(duì)象，但是對(duì)象前加了@ApiIgnore 注解，相信前面給的鏈接學(xué)習(xí)后知道這個(gè)注解表示的是忽略的意思，也就是傳參的時(shí)候，忽略掉這個(gè)對(duì)象，所以feign傳的參壓根就沒(méi)有對(duì)象。

其次原接口對(duì)兩個(gè)參數(shù)加了@ApiImplicitParam，需要提前說(shuō)明的是，加了@ApiImplicitParam的兩個(gè)參數(shù)queryNum、queryDate都屬于Order 類里的屬性。

重點(diǎn)看@ApiImplicitParam的paramType = “form”, required = true這兩個(gè)地方，paramType="form"就表示傳參以form表單的形式，所以feign接口方法上面加了

@Headers(MediaType.APPLICATION_FORM_URLENCODED_VALUE)

其次require=true就表示這兩個(gè)參數(shù)是必傳的。

以上就確定了feign的接口方法應(yīng)該如何寫，最后參數(shù)到原接口過(guò)來(lái)時(shí)，會(huì)自動(dòng)將queryNum、queryDate兩個(gè)參數(shù)set到Order對(duì)象里去，至于為何，我也不太清楚，暫時(shí)知道是可以這么用的。

使用@RequestParam、@RequestBody 的正確姿勢(shì)

背景

最近在使用 @RequestParam、@RequestBody 注解定義 feign 接口的時(shí)候出現(xiàn)一些使用上的問(wèn)題，造成調(diào)用方啟動(dòng)的時(shí)候會(huì)報(bào)錯(cuò)。

詳細(xì)情況

第一種情況，如下：

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

接口有且只有一個(gè) key/value 參數(shù)，此時(shí)可以不必在 name1 參數(shù)上使用 @RequestParam 注解。通過(guò) Feign 調(diào)用該接口的調(diào)用方可以正常啟動(dòng)。

第二種情況，如下：

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

接口有且只有一個(gè) key/value 參數(shù)，此時(shí)如果對(duì) name1 參數(shù)上使用 @RequestParam 注解，此時(shí)通過(guò) Feign 調(diào)用該接口的調(diào)用方可啟動(dòng)的時(shí)候回拋出如下錯(cuò)誤：

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

意思是 @RequestParam 的 value 值不允許為空，正確的姿勢(shì)如下：

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

第三種情況，如下：

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

接口存在多個(gè) key/value 參數(shù)，此時(shí)通過(guò) Feign 調(diào)用該接口的調(diào)用方啟動(dòng)的時(shí)候會(huì)拋出如下錯(cuò)誤：

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

像這種多參數(shù)（key/value）的情況必須為每個(gè)參數(shù)增加 @RequestParam 注解，正確的姿勢(shì)如下：

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

小結(jié)一下

在使用 @RequestParam 注解的時(shí)候，value 值必須設(shè)置，如下：

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

如果接口有且只有一個(gè)參數(shù)，并且該參數(shù)是 key/value 類型，則無(wú)需為該參數(shù)設(shè)置 @RequestParam 注解，如下：

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

接口存在多個(gè)參數(shù)（key/value、Json 對(duì)象）的時(shí)候，每個(gè) key/value 類型的參數(shù)必須顯示的指定 @RequestParam 注解，且必須設(shè)置對(duì)應(yīng)的 value

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

接口無(wú)論有多個(gè)參數(shù)還是一個(gè)參數(shù)，都不需要為 Json 對(duì)象參數(shù)顯示的指定 @RequestBody 注解

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

每個(gè)接口里只允許有一個(gè) JSON 對(duì)象類型的參數(shù)，否則通過(guò) Feign 調(diào)用該接口的調(diào)用方啟動(dòng)的時(shí)候會(huì)拋出如下錯(cuò)誤：

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

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論