在Jersey服务中使用JSON对象

Question

我一直在谷歌搜索我的屁股试图找出如何做到这一点：我有一个泽西岛REST服务。调用REST服务的请求包含一个JSON对象。我的问题是，从Jersey POST方法实现中，我如何访问HTTP请求正文中的JSON？

任何提示，技巧，示例代码指针将不胜感激。

谢谢...

--Steve

Answer 1

我不知道你将如何获得在JSON字符串本身，但是你可以在它包含如下的数据肯定会获得：

定义一个JAXB注释的Java类（C），它具有与在请求上传递的JSON对象相同的结构。

例如一个JSON消息：

​​

使用类似：

@XmlAccessorType(XmlAccessType.FIELD) 
public class C 
{ 
    public String A; 
    public String B; 
} 

然后，你可以在你的资源类定义与C型的参数的方法，当新泽西调用你的方法，JAXB的对象将根据POST的JSON对象创建。

@Path("/resource") 
public class MyResource 
{ 
    @POST 
    public put(C c) 
    { 
    doSomething(c.A); 
    doSomethingElse(c.B); 
    } 
} 

Answer 2

使用JSON作为值提交/ POST表单/ HTTP.POST。

@QueryParam jsonString

公共desolveJson（jsonString）

Answer 3

这使您可以访问原始帖子。

@POST 
@Path("/") 
@Consumes("text/plain") 
@Produces(MediaType.APPLICATION_JSON) 
public String processRequset(String pData) { 
    // do some stuff, 
    return someJson; 
} 

Answer 4

正如已经建议，改变@Consumes的Content-Type到text/plain将工作，但它似乎从一个角度REST API点不正确。

想象一下，您的客户必须将JSON发布到您的API，但需要将Content-Type标头指定为text/plain。我认为这并不干净。简而言之，如果您的API接受JSON，那么请求标头应指定Content-Type: application/json。

为了接受JSON，但将其序列化为String对象而不是POJO，您可以实施自定义MessageBodyReader。这样做非常简单，您不必在API规范中妥协。

这是值得阅读文档MessageBodyReader所以你知道它是如何工作的。这是我如何做到了：

步骤1.实现自定义MessageBodyReader

@Provider 
@Consumes("application/json") 
public class CustomJsonReader<T> implements MessageBodyReader<T> { 
    @Override 
    public boolean isReadable(Class<?> type, Type genericType, 
     Annotation[] annotations,MediaType mediaType) { 
    return true; 
    } 

    @Override 
    public T readFrom(Class<T> type, Type genericType, Annotation[] annotations, 
     MediaType mediaType, MultivaluedMap<String, String> httpHeaders, 
     InputStream entityStream) throws IOException, WebApplicationException { 

    /* Copy the input stream to String. Do this however you like. 
    * Here I use Commons IOUtils. 
    */ 
    StringWriter writer = new StringWriter(); 
    IOUtils.copy(entityStream, writer, "UTF-8"); 
    String json = writer.toString(); 

    /* if the input stream is expected to be deserialized into a String, 
    * then just cast it 
    */ 
    if (String.class == genericType) 
     return type.cast(json); 

    /* Otherwise, deserialize the JSON into a POJO type. 
    * You can use whatever JSON library you want, here's 
    * a simply example using GSON. 
    */ 
    return new Gson().fromJson(json, genericType); 
    } 
}

以上的基本概念是，以检查是否输入流有望被转换为String（由Type genericType指定）。如果是，那么可简单地把JSON到指定type（这将是一个String）。如果预期的类型是某种POJO，则使用JSON库（例如Jackson或GSON）将其反序列化为POJO。

步骤2.绑定您的MessageBodyReader

这取决于你所使用的架构。我发现吉斯和泽西一起工作得很好。以下是我在吉斯绑定我MessageBodyReader：

在我JerseyServletModule我绑定读者像这样 -

bind(CustomJsonReader.class).in(Scopes.SINGLETON);

以上CustomJsonReader将反序列化JSON的有效载荷送入的POJO还有，如果你只是想生JSON，String对象。

做这种方式的好处是，它会接受Content-Type: application/json。换句话说，你的请求处理程序可以被设置为使用JSON，这似乎是正确的：

@POST 
@Path("/stuff") 
@Consumes("application/json") 
public void doStuff(String json) { 
    /* do stuff with the json string */ 
    return; 
}

Answer 5

新泽西支持使用抛弃型的JSONObject和JSONArray所解析的JSONObject低级别的访问。

<dependency> 
    <groupId>org.codehaus.jettison</groupId> 
    <artifactId>jettison</artifactId> 
    <version>1.3.8</version> 
</dependency> 

例如：

{ 
    "A": "a value", 
    "B": "another value" 
} 


@POST 
@Path("/") 
@Consumes(MediaType.APPLICATION_JSON) 
public void doStuff(JSONObject json) { 
    /* extract data values using DOM-like API */ 
    String a = json.optString("A"); 
    Strong b = json.optString("B"); 
    return; 
} 

更多的例子参见Jersey documentation。