【问题标题】:Return JSONArray instead of JSONObject, Jersey JAX-RS返回 JSONArray 而不是 JSONObject,Jersey JAX-RS
【发布时间】:2012-06-01 11:36:37
【问题描述】:

我正在使用 Jersey 使我的一些服务成为 RESTful。

我的 REST 服务调用返回给我

{"param1":"value1", "param2":"value2",...."paramN":"valueN"}

但是,我希望它返回

["param1":"value1", "param2":"value2",...."paramN":"valueN"]

我需要对下面的代码进行哪些更改?

@GET
@Produces(MediaType.APPLICATION_JSON)
public List<com.abc.def.rest.model.SimplePojo> getSomeList() {
    /* 
            Do something
    */
    return listOfPojos;
}

我的 web.xml 文件的一部分看起来像这样

    <servlet>
        <servlet-name>Abc Jersey REST Service</servlet-name>
        <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
        <init-param>
            <param-name>com.sun.jersey.config.property.packages</param-name>
            <param-value>com.abc.def.rest</param-value>
        </init-param>
        <load-on-startup>0</load-on-startup>
    </servlet>

谢谢!

【问题讨论】:

  • 您要返回的不是有效的 JSON。你的意思是:["value1", "value2", ..."valueN"]
  • 是的,类似于[{"description1":"value1","name1":"name_"},{"description2":"value2","name2":"name_"},....],但我最终总是得到{"nameOfTheEntity":[{"description1":"value1","name1":"name_"},{"description2":"value2","name2":"name_"},....]}
  • SimplePojo 是 JAXB 注释的 pojo 吗?您是否在某处的 @Provider 中设置了 JSONJAXBContext?
  • @jhericks - 你能告诉我如何让我的 SimplePojo JAXB 被注释吗?

标签: jersey jax-rs arrays


【解决方案1】:

您可以使用 Person POJO 如下定义您的服务方法:

@GET
@Produces("application/json")
@Path("/list")
public String getList(){
    List<Person> persons = new ArrayList<>();
    persons.add(new Person("1", "2"));
    persons.add(new Person("3", "4"));
    persons.add(new Person("5", "6"));
    // takes advantage to toString() implementation to format as [a, b, c]
    return persons.toString();
}

POJO 类:

@XmlRootElement
public class Person {
    @XmlElement(name="fn")
    String fn;

    @XmlElement(name="ln")
    String ln;

    public Person(){        
    }

    public Person(String fn, String ln) {
        this.fn = fn;
        this.ln = ln;
    }    

    @Override
    public String toString(){
        try {
            // takes advantage of toString() implementation to format {"a":"b"}
            return new JSONObject().put("fn", fn).put("ln", ln).toString();
        } catch (JSONException e) {
            return null;
        }
    }
}

结果将如下所示:

[{"fn":"1","ln":"2"}, {"fn":"3","ln":"4"}, {"fn":"5","ln":"6"}]

【讨论】:

  • 改进答案。使用上面的解决方案,我们必须覆盖每个模型类中的 toString 方法,因此我发现的另一个解决方案是here, click me。我们正在将 JAXB JSON 序列化程序替换为表现更好的 JSON 序列化程序,例如 Jackson。使用此解决方案,我们不必修改所有作为 REST 服务公开的模型类。只需很少的配置更改和自定义 MessageBodyWriter 类的 Jersey 就可以了。
【解决方案2】:

要以数组类型样式返回条目,您应该从数组构建实体。 请尝试以下操作:

@GET
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_JSON})
public Response getSomeList() {
    List<com.abc.def.rest.model.SimplePojo> yourListInstance = 
          new List<com.abc.def.rest.model.SimplePojo>();
    /* 
          Do something
    */
    return Response.ok(yourListInstance.toArray()).build();
}

如果您根据toArray() 方法的返回类型遇到一些麻烦 - 您可以显式转换您的数组:

Response
   .ok((com.abc.def.rest.model.SimplePojo[])yourListInstance.toArray())
   .build(); 

UPD:尝试将您的列表转换为 JSONArray:

JSONArray arr = new JSONArray();
for (SimplePojo p : yourListInstance) {
  arr.add(p);
}

然后:

Response.ok(arr).build(); 

【讨论】:

  • 对于更改 return Response.ok(listOfPojos.toArray()).build(); 我收到错误 SEVERE: A message body writer for Java class [Ljava.lang.Object;, and Java type class [Ljava.lang.Object;, and MIME media type application/json was not found
  • 您需要将jersey-json 添加到您的类路径
  • 对于更改Response.ok((com.abc.def.rest.model.SimplePojo[])yourListInstance.toArray()) .build(); 我得到com.sun.jersey.spi.container.ContainerResponse mapMappableContainerException java.lang.ClassCastException: [Ljava.lang.Object; cannot be cast to [Lcom.abc.def.rest.model.SimplePojo;
  • 对于上面指定的更改,我收到此错误SEVERE: A message body writer for Java class org.json.JSONArray, and Java type class org.json.JSONArray, and MIME media type application/json was not found
  • 再一次:您需要将jersey-json lib 添加到您的类路径中。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2017-09-25
  • 1970-01-01
  • 2014-01-24
  • 2016-12-02
相关资源
最近更新 更多