如何使用 Jersey 获取完整的 REST 请求正文？

Question

如何使用 Jersey 获取 POST 请求的完整 HTTP REST 请求正文？

在我们的例子中，数据将是 XML。大小从 1K 到 1MB 不等。

docs 似乎表明您应该使用 MessageBodyReader< /code> 但我看不到任何例子。

Answer 1

看来您必须在这里使用 MessageBodyReader 。下面是一个使用 jdom 的示例：

import org.jdom.Document;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.Provider;
import javax.ws.rs.ext.MediaType;
import javax.ws.rs.ext.MultivaluedMap;
import java.lang.reflect.Type;
import java.lang.annotation.Annotation;
import java.io.InputStream;

@Provider // this annotation is necessary!
@ConsumeMime("application/xml") // this is a hint to the system to only consume xml mime types
public class XMLMessageBodyReader implements MessageBodyReader<Document> {
  private SAXBuilder builder = new SAXBuilder();

  public boolean isReadable(Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
    // check if we're requesting a jdom Document
    return Document.class.isAssignableFrom(type);
  }

  public Document readFrom(Class type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, String> httpHeaders, InputStream entityStream) {
    try {
      return builder.build(entityStream);
    }
    catch (Exception e) {
      // handle error somehow
    }
  } 
}

将此类添加到 jersey 部署将处理的资源列表中（我认为通常通过 web.xml 配置）。然后，您可以在常规资源类之一中使用此阅读器，如下所示：

@Path("/somepath") @POST
public void handleXMLData(Document doc) {
  // do something with the document
}

我尚未验证它是否完全按照键入的方式工作，但这就是它的要点。更多阅读内容：

• http://weblogs.java.net/ blog/mhadley/archive/2008/02/integrating_jer_2.html
• http://blogs .oracle.com/sandoz/entry/jersey_and_abdera_with_a

Answer 2

事实证明您根本不需要做太多事情。

请参阅下文 - 参数 x 将包含完整的 HTTP 正文（在我们的例子中为 XML）。

@POST
public Response go(String x) throws IOException {
    ...
}

Answer 3

您可以使用 @Consumes 注释来获取完整的正文：

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.w3c.dom.Document;

@Path("doc")
public class BodyResource
{
  @POST
  @Consumes(MediaType.APPLICATION_XML)
  public void post(Document doc) throws TransformerConfigurationException, TransformerException
  {
    Transformer tf = TransformerFactory.newInstance().newTransformer();
    tf.transform(new DOMSource(doc), new StreamResult(System.out));
  }
}

注意：不要忘记请求的“Content-Type：application/xml”标头。

Answer 4

使用以下代码尝试此操作：

import javax.ws.rs.POST;
import javax.ws.rs.Path;

@Path("/serviceX")
public class MyClassRESTService {

    @POST
    @Path("/doSomething")   
    public void someMethod(String x) {

        System.out.println(x);
                // String x contains the body, you can process
                // it, parse it using JAXB and so on ...

    }
}

尝试休息服务的 url 结束..../serviceX/doSomething

Answer 5

由于您正在以 xml 格式传输数据，因此您还可以直接从/到 pojo 进行编组。

jersey 用户指南，我在这里复制：

带有 JAXB 注释的 POJO：

@XmlRootElement
public class Planet {
    public int id;
    public String name;
    public double radius;
}

资源：

@Path("planet")
public class Resource {

    @GET
    @Produces(MediaType.APPLICATION_XML)
    public Planet getPlanet() {
        Planet p = new Planet();
        p.id = 1;
        p.name = "Earth";
        p.radius = 1.0;

        return p;
    }

    @POST
    @Consumes(MediaType.APPLICATION_XML)
    public void setPlanet(Planet p) {
        System.out.println("setPlanet " + p.name);
    }

}      

生成/使用的 xml：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<planet>
    <id>1</id>
    <name>Earth</name>
    <radius>1.0</radius>
</planet>