如何在RESTful POST方法中访问参数

问题

我的POST方法如下所示:

@POST
@Consumes({"application/json"})
@Path("create/")
public void create(String param1, String param2){
    System.out.println("param1 = " + param1);
    System.out.println("param2 = " + param2);
}

当我在Netbeans中创建Jersey客户端时,调用post方法的方法如下所示:

public void create(Object requestEntity){
    webResource.path("create").type(MediaType.APPLICATION_JSON).post(requestEntity);
}

运行此测试时:

@Test
public void hello(){
    String json = "{param1=\"hello\",param2=\"hello2\"}";
    this.client.create(json);
}

它在服务器中提供以下输出:

INFO: param1 = {param1="hello",param2="hello2"}
INFO: param2 =

我需要更改什么才能使参数给出正确的值?


#1 热门回答(324 赞)

Your@POST方法应该接受JSON对象而不是字符串。 Jersey使用JAXB来支持编组和解组JSON对象(参见the jersey docs for details)。创建一个类,如:

@XmlRootElement
public class MyJaxBean {
    @XmlElement public String param1;
    @XmlElement public String param2;
}

那么你的@POST方法将如下所示:

@POST @Consumes("application/json")
@Path("/create")
public void create(final MyJaxBean input) {
    System.out.println("param1 = " + input.param1);
    System.out.println("param2 = " + input.param2);
}

此方法希望接收JSON对象作为HTTP POST的主体。在这种情况下,JAX-RS将HTTP消息的内容主体作为未注释的参数传递--input。实际的消息看起来像:

POST /create HTTP/1.1
Content-Type: application/json
Content-Length: 35
Host: www.example.com

{"param1":"hello","param2":"world"}

出于显而易见的原因,以这种方式使用JSON是很常见的。但是,如果你使用JavaScript之外的其他内容生成或使用它,那么你必须小心正确地转义数据。在JAX-RS中,你将使用aMessageBodyReaderMessageBodyWriter来实现此功能。我相信Jersey已经有了所需类型的实现(例如,Java原语和JAXB包装类)以及JSON。 JAX-RS支持许多其他传递数据的方法。这些不需要创建新类,因为数据是使用简单的参数传递传递的。
HTML<FORM>
参数将使用@FormParam注释:

@POST
@Path("/create")
public void create(@FormParam("param1") String param1,
                   @FormParam("param2") String param2) {
    ...
}

浏览器将使用"application/x-www-form-urlencoded"对表单进行编码。 JAX-RS运行时将负责解码主体并将其传递给方法。这是你应该在电线上看到的内容:

POST /create HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Content-Length: 25

param1=hello&param2=world

在这种情况下,内容是URL编码。

如果你不知道FormParam的名称,你可以执行以下操作:

@POST @Consumes("application/x-www-form-urlencoded")
@Path("/create")
public void create(final MultivaluedMap<String, String> formParams) {
    ...
}

HTTP标头
如果要通过HTTP标头传递参数,可以使用@HeaderParam注释:

@POST
@Path("/create")
public void create(@HeaderParam("param1") String param1,
                   @HeaderParam("param2") String param2) {
    ...
}

这是HTTP消息的样子。请注意,此POST没有正文。

POST /create HTTP/1.1
Content-Length: 0
Host: www.example.com
param1: hello
param2: world

我不会将此方法用于广义参数传递。如果你需要访问特定HTTP标头的值,这非常方便。
HTTP查询参数
此方法主要用于HTTP GET,但它同样适用于POST。它使用了@QueryParam注释。

@POST
@Path("/create")
public void create(@QueryParam("param1") String param1,
                   @QueryParam("param2") String param2) {
    ...
}

与前面的技术一样,通过查询字符串传递参数不需要消息体。这是HTTP消息:

POST /create?param1=hello&param2=world HTTP/1.1
Content-Length: 0
Host: www.example.com

你必须特别小心,在客户端正确encode query parameters。由于某些代理强制执行的URL长度限制以及与编码它们相关的问题,使用查询参数可能会有问题。
HTTP路径参数
路径参数与查询参数类似,只是它们嵌入在HTTP资源路径中。这种方法今天似乎有利于此。由于路径是真正定义HTTP资源的,因此对HTTP缓存有影响。代码看起来与其他代码略有不同,因为修改了@Pathannotation并使用了@PathParam

@POST
@Path("/create/{param1}/{param2}")
public void create(@PathParam("param1") String param1,
                   @PathParam("param2") String param2) {
    ...
}

该消息类似于查询参数版本,除了参数的名称不包含在消息中的任何位置。

POST /create/hello/world HTTP/1.1
Content-Length: 0
Host: www.example.com

这个方法共享相同的编码问题,查询参数版本.Path segments are encoded differently你也必须小心。

如你所见,每种方法都有利弊。选择通常由你的客户决定。如果你要提供基于FORM的HTML页面,请使用@FormParam。如果你的客户端是基于JavaScript HTML5的,那么你可能希望使用基于JAXB的序列化和JSON对象。 MessageBodyReader/Writer实现应该为你做必要的逃避,这样可以减少一件事。如果你的客户端是基于Java的,但没有良好的XML处理器(例如,Android),那么我可能会使用编码,因为内容正文比URL更容易生成和编码。希望这个迷你wiki条目能够揭示JAX-RS支持的各种方法。

**注:**为了充分披露的利益,我还没有实际使用泽西的这个功能。我们正在修补它,因为我们已经部署了许多JAXB JAX-RS应用程序并且正在进入移动客户端空间。 JSON比HTML5或基于jQuery的解决方案更适合XML。