Jersey Restful接口如何获取参数的问题
缘起
工作时使用java开发服务器后台,用jersey写restful接口,发现有一个post方法始终获取不到参数,查了半天,发现时获取参数的注释不太对,将@formparam写成了@queryparam,发现了这个改过来就好了,顺便整理了一下不同参数的作用。
简述
获取uri的参数
获取get请求的参数
获取post类型的参数
添加参数默认值
获取map参数
1.@pathparam
使用该注释获取参数时可以获取uri中制定规则的参数
例如:
//该类的路径为/user @get @path("{username"}) @produces(mediatype.application_json) public user getuser(@pathparam("username") string username) { ...}
当浏览器请求
http://localhost:8080/user/jack
时,username的值就是jack。请注意,这里的username并不是说key的值就是username,value是jack,而是说/user/后面就跟着username,这里的username只是一个变量。
2.@queryparam
该参数用于获取get请求中的查询参数,他和上一个的区别是它是通过uri中的?符号来实现的。
比如:
@get @path("/user") @produces("text/plain") public user getuser(@queryparam("name") string name, @queryparam("age") int age) { ...}
当url的请求是
http://localhost:8080/user?name=cesar&age=21
时,此时函数获取的参数就是name=cesar而age=21;
3.@formpara
顾名思义,是从post请求的表单中获取数据。
@post @consumes("application/x-www-form-urlencoded") publicvoid post(@formparam("name") string name) { // store the message }
4.默认参数值defaultvalue
当你希望在函数获取参数时参数有一个默认值,那么就可以使用该注释,它的使用方法如下
@get @path("/user") @produces("text/plain") public user getuser(@queryparam("name") string name, @defaultvalue("26") @queryparam("age") int age) { ...}
那么当请求age参数时如果age没有赋值,就会默认为26.
5.使用map的参数@context
在一个大型的server中,由于参数的多变,参数结构的调整很容易遇到问题,这时候就可以考虑使用@context来进行注释了。例子如下:
@get public string get(@context uriinfo ui) { multivaluedmap<string, string> queryparams = ui.getqueryparameters(); multivaluedmap<string, string> pathparams = ui.getpathparameters(); }
从例子中我们可以看出,其实context就是其他几个参数的集合而已,只要熟练掌握了这几种参数以及他们代表的意义,你就可以熟练的操作jersey了!
restful接口传入多参数的问题及解决方案
结论:
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
以上为个人经验,希望能给大家一个参考,也希望大家多多支持。