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

背景

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

详细情况

1. 第一种情况，如下：

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

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

2. 第二种情况，如下：

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

3. 第三种情况，如下：

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

总结

1. 在使用 @RequestParam 注解的时候，value 值必须设置，如下：

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

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

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

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

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

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

@PostMapping(value = "/hello1")
BetaDto hello1(BetaDto betaDto);

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

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

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