缘起
工作时使用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) {
...}
当浏览器请求
时,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的请求是
时,此时函数获取的参数就是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了!