结论:
restful风格的接口不支持多个参数
注:本文指的是通过json序列化参数的情况
1. 前置
一个定义用来测试的MyParam类
public class MyParam {
private String str;
private Integer integer;
// 省略 getter和setter……
}
我在做测试的是用了Chrome的插件Advanced REST client
,可以模拟浏览器发送各种请求,并自定义header和body。
测试的时候需要使用post方式,并在http请求header中加入
accept: application/json
content-type: application/json
然后在htpp请求的Body中,输入json格式的参数,如{"str":"bb","integer":3}
。
以下是几种多参数接口的形式,以及输入参数,以及解析结果。
2. 第一种:两个String参数
@POST
@Path("demo")
public Result function(String param1, String param2);
传入的参数:
{"param1":"bb","param2":"cc"}
解析出来的参数:
param1: "{"param1":"bb","param2":"cc"}"
param2: ""
这样的风格,传输过来的参数,读取的时候会读取request body中的inputStream,然后两个参数循环解析,解析完第一个参数的时候,会关闭inputStream,第二个参数再去读取inputStream的时候,读取到的就是空。
这样的话,传入的参数全部会赋值给第一个String对象,而第二个String解析出来后就是空字符串。
3. 第二种:一个对象参数,一个String参数
对于 第一个参数是封装对象的情况,能解析出来第一个对象,而第二个参数也是拿不到。
这种情况下不会报错,只是解析第一个对象的时候没有问题,解析第二个String拿到的就是空字符串。
@POST
@Path("demo")
@Consumes({MediaType.JSON})
public Result function(MyParam myParam, String param);
传入的参数:
{"str":"helo","integer":2},"string":"test"
解析出来的参数:
param1: 能正确解析对象myParam,其两个属性能正确赋值。
param2: ""
4. 第三种:一个String参数,一个对象参数
如果把两个参数的位置交换,则会把传入的参数全部解析给第一个String,而解析第二个对象的时候,由于拿到的数据是空,所以会报错。如下:
@POST
@Path("demo")
public Result function(String param, MyParam myParam);
传入的参数:
{"str":"helo","integer":2},"string":"test"
解析出来的参数:
param1: "{"str":"helo","integer":2},"string":"test""
param2: 会报错
5.解决方法
要解决传入多个参数的问题,有几个思路:
1. 封装对象,把要传的多个参数封装成一个对象传入
2. 在访问路径中嵌入变量,使用@PathVariable注解,在请求路径中写 “/demo/{1}/{2}”,然后在请求路径中相应的位置替换为要穿的参数即可,这种也只适用于包装类,如String。
3. 改变请求的content type,使用content-type: application/x-www-form-urlencoded
,这种使用form表单提交的形式,可以传入两个参数,要结合使用@FormParam注解
6.关于使用form形式传入参数
接口的定义形式要修改
@POST
@Path("demo")
@Consumes({MediaType.APPLICATION_FORM_URLENCODED})
public Result function(@FormParam(value="string1")String string1, @FormParam(value="string2")String string2);
请求时,header参数要修改
accept: application/json
content-type: application/x-www-form-urlencoded
请求Body中使用form形式
string1=wo&string2=kan
然后就可以正确解析到两个参数的值
解析出来的参数:
string1: wo
string2: kan