55

我正在使用 Jersey 为服务器组件创建 REST Web 服务。

我想在列表中序列化的 JAXB 注释对象如下所示:

@XmlRootElement(name = "distribution")
@XmlType(name = "tDistribution", propOrder = {
    "id", "name"
})
public class XMLDistribution {
    private String id;
    private String name;
    // no-args constructor, getters, setters, etc
}

我有一个 REST 资源来检索一个如下所示的分布:

@Path("/distribution/{id: [1-9][0-9]*}")
public class RESTDistribution {
    @GET
    @Produces("application/json")
    public XMLDistribution retrieve(@PathParam("id") String id) {
        return retrieveDistribution(Long.parseLong(id));
    }
    // business logic (retrieveDistribution(long))
}

我还有一个 REST 资源来检索所有发行版的列表,如下所示:

@Path("/distributions")
public class RESTDistributions {
    @GET
    @Produces("application/json")
    public List<XMLDistribution> retrieveAll() {
        return retrieveDistributions();
    }
    // business logic (retrieveDistributions())
}

我使用 ContextResolver 来自定义 JAXB 序列化,目前配置如下:

@Provider
@Produces("application/json")
public class JAXBJSONContextResolver implements ContextResolver<JAXBContext> {
    private JAXBContext context;
    public JAXBJSONContextResolver() throws Exception {
        JSONConfiguration.MappedBuilder b = JSONConfiguration.mapped();
        b.nonStrings("id");
        b.rootUnwrapping(true);
        b.arrays("distribution");
        context = new JSONJAXBContext(b.build(), XMLDistribution.class);
    }
    @Override
    public JAXBContext getContext(Class<?> objectType) {
        return context;
    }
}

REST 资源和上下文解析器都可以工作。这是第一个输出的示例:

// path: /distribution/1
{
  "id": 1,
  "name": "Example Distribution"
}

这正是我想要的。这是列表的输出示例:

// path: /distributions
{
  "distribution": [{
    "id": 1,
    "name": "Sample Distribution 1"
  }, {
    "id": 2,
    "name": "Sample Distribution 2"
  }]
}

这不是我想要的。

我不明白为什么那里有一个封闭distribution标签。我想.rootUnwrapping(true)在上下文解析器中删除它,但显​​然这只删除了另一个封闭标签。这是输出.rootUnwrapping(false)

// path: /distribution/1
{
  "distribution": {
    "id": 1,
    "name": "Example Distribution"
  }
} // not ok
// path: /distributions
{
  "xMLDistributions": {
    "distribution": [{
      "id": 1,
      "name": "Sample Distribution 1"
    }, {
      "id": 2,
      "name": "Sample Distribution 2"
    }]
  }
}

我还必须配置.arrays("distribution")为始终获取 JSON 数组,即使只有一个元素。

理想情况下,我希望将其作为输出:

// path: /distribution/1
{
  "id": 1,
  "name": "Example Distribution"
} // currently works
// path: /distributions
[{
  "id": 1,
  "name": "Sample Distribution 1"
}, {
  "id": 2,
  "name": "Sample Distribution 2"
}]

我试图返回 a List<XMLDistribution>, a XMLDistributionList(列表的包装器), a XMLDistribution[],但我找不到以我所需格式获取简单 JSON 分布数组的方法。

我还尝试了由JSONConfiguration.natural(),JSONConfiguration.mappedJettison()等返回的其他符号,但没有得到任何类似于我需要的东西。

有谁知道是否可以配置 JAXB 来执行此操作?

4

2 回答 2

104

我找到了一个解决方案:将 JAXB JSON 序列化器替换为像 Jackson 这样表现更好的 JSON 序列化器。简单的方法是使用 jackson-jaxrs,它已经为您完成了。该类是 JacksonJsonProvider。您所要做的就是编辑项目的 web.xml,以便 Jersey(或其他 JAX-RS 实现)扫描它。这是您需要添加的内容:

<init-param>
  <param-name>com.sun.jersey.config.property.packages</param-name>
  <param-value>your.project.packages;org.codehaus.jackson.jaxrs</param-value>
</init-param>

这就是它的全部。Jackson 将用于 JSON 序列化,它的工作方式与您期望的列表和数组一样。

更长的方法是编写自己的自定义 MessageBodyWriter 注册以生成“application/json”。这是一个例子:

@Provider
@Produces("应用程序/json")
公共类 JsonMessageBodyWriter 实现 MessageBodyWriter {
    @覆盖
    public long getSize(Object obj, Class type, Type genericType,
            Annotation[] 注释,MediaType mediaType) {
        返回-1;
    }

    @覆盖
    公共布尔isWriteable(类类型,类型genericType,
            注释 annotations[], MediaType mediaType) {
        返回真;
    }

    @覆盖
    public void writeTo(Object target, Class type, Type genericType,
            Annotation[] 注释,MediaType mediaType,
            MultivaluedMap httpHeaders, OutputStream outputStream)
            抛出 IOException {        
        新的 ObjectMapper().writeValue(outputStream, target);
    }
}

您需要确保您的 web.xml 包含该包,就像上面的现成解决方案一样。

无论哪种方式:瞧!您将看到格式正确的 JSON。

您可以从这里下载 Jackson:http: //jackson.codehaus.org/

于 2010-06-29T17:32:08.707 回答
13

Jonhatan 的回答很棒,对我来说非常有用。

只是升级:

如果您使用 Jackson 的 2.x 版(例如 2.1 版),则该类为 com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider,因此 web.xml 为:

<init-param>
  <param-name>com.sun.jersey.config.property.packages</param-name>
  <param-value>your.project.packages;com.fasterxml.jackson.jaxrs.json</param-value>
</init-param>
于 2013-04-15T20:43:57.387 回答