Jersey Restful接口如何获取参数的问题
作者:456又 发布时间:2023-10-29 14:44:16
缘起
工作时使用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
来源:https://www.jianshu.com/p/ac01105241bf
猜你喜欢
- Java 使用IO流实现大文件的分割与合并文件分割应该算一个比较实用的功能,举例子说明吧比如说:你有一个3G的文件要从一台电脑Copy到另一
- 协议做如下规定:规定数据协议:序列号 长度 状态字 数据长度 数据1 &n
- 前言:文件的上传和下载在日常开发中很是常见,那么这一功能是如何实现的呢,下面我给大家介绍一下实现条件:1、需要一个form标签,method
- 使用AS创建ADIL文件时AS会在main文件夹下给我们生成一个aidl文件夹和一个相同包名的包,通常我们会把所有和ADIL相关的类或文件放
- 本文是一个 Spring 扩展支持 SPEL 的简单模式,方便第三方通过 Spring 提供额外功能。简化版方式这种方式可以在任何能获取Ap
- 有人问我,怎么判断一个点是不是在多边形内,本来想着把这个多边形分成一个又一个三角形,如图, 然后判断这个点是不是在某个三角形中,如
- 一、 WillPopScope用法WillPopScope本质是一个widget用于拦截物理按键返回事件(Android的物理返回键和iOS
- 效果展示人脸支付效果视频密码框输入支付效果视频因为密码支付时会调起系统安全键盘,开启自动保护功能,防止泄露,会导致输入密码时录屏黑屏,故使用
- 本文实例讲述了Java编程实现非对称加密的方法。分享给大家供大家参考,具体如下:对称加密算法在加密和解密时使用的是同一个秘钥;而非对称加密算
- springboot嵌套子类使用在实际项目里,我们会使用到一个User用户含有子类Address、这种嵌套子类在开发中会遇到很多问题,现在主
- PermissionManage项目地址:https://github.com/why168/AndroidProjects/tree/ma
- EhCache 是一个纯Java的进程内缓存框架,具有快速、精干等特点,是Hibernate中默认的CacheProvider。ehcach
- 本文实例讲述了Android编程之手机壁纸WallPaper设置方法。分享给大家供大家参考,具体如下:/** * Andorid设置手机屏幕
- 微服务通过Feign调用进行密码安全认证在项目中,微服务之间的通信也是通过Feign代理的HTTP客户端通信,为了保护我们的业务微服务不被其
- 如果不知道,类的静态变量存储在那? 方法的局部变量存储在那? 赶快收藏Java内存区域主要可以分为共享内存,堆、方法区和线程私有内存,虚拟机
- 本文实例为大家分享了java实现简单斗地主的具体代码,供大家参考,具体内容如下第一种方法 /** * @param args */ /**
- 在使用Gateway 调用一个文件上传服务时 前端传来的File的base64字符串怎么都接受不到 但是用Body方式请求就能接收到后来经过
- 本文实例为大家分享了java使用字符画一个海绵宝宝的具体代码,供大家参考,具体内容如下用字符画一个海绵宝宝用" &ldqu
- 本文实例讲述了Android+SQLite数据库实现的生词记事本功能。分享给大家供大家参考,具体如下:主activity命名为Dict:代码
- 前言我们在学习Windows应用程序开发中,经常会用到消息对话框给用户或者管理员一些的消息提示,它们都是基于对MessageBox类的消息对