休息。新泽西州。如何以编程方式选择要返回的类型:JSON还是XML?

时间:2012-07-08 09:42:31

标签: java xml json rest jersey

我有两个问题:

1。我可以创建一个类,使用JAXB注释对其进行注释(对于XML支持)并在web.xml中声明

<init-param>
    <param-name>com.sun.jersey.api.json.POJOMappingFeature</param-name>
    <param-value>true</param-value>
</init-param>

对于JSON(杰克逊图书馆)的支持?或者我需要为JSON和XML单独创建两个类?

或者可能存在一些更优雅的方式使REST服务同时返回JSON和XML?

2. 我如何以编程方式选择要返回的类型(JSON或XML)?

感谢。

3 个答案:

答案 0 :(得分:9)

注意:我是EclipseLink JAXB (MOXy)主管,是JAXB (JSR-222)专家组的成员。


  

我可以创建一个类,使用JAXB注释(对于XML支持)进行注释,并在web.xml中声明JSON(杰克逊库)支持吗?

您始终可以使用Application类为JSON绑定指定MessageBodyReader / MessageBodyWriter。我相信杰克逊在其jar中提供了一个实现。下面是一个Application类的示例,它将MOXy指定为JSON提供程序:

package org.example;

import java.util.*;
import javax.ws.rs.core.Application;
import org.eclipse.persistence.jaxb.rs.MOXyJsonProvider;

public class CustomerApplication  extends Application {

    @Override
    public Set<Class<?>> getClasses() {
        HashSet<Class<?>> set = new HashSet<Class<?>>(2);
        set.add(MOXyJsonProvider.class);
        set.add(CustomerService.class);
        return set;
    }

}
  

或者我需要为JSON和XML单独创建两个类?

EclipseLink JAXB(MOXy)提供本机XML绑定,旨在使您能够使用same object model for both JSON and XML。您可以使用MOXyJsonProvider类将其集成到JAX-RS应用程序中:


  

如何以编程方式选择要返回的类型(JSON或XML)?

服务器端

您可以使用@Produces注释指定您的服务同时提供XML和JSON消息。

@GET
@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
@Path("{id}")
public Customer read(@PathParam("id") long id) {
    return entityManager.find(Customer.class, id);
}

了解更多信息

客户端

您可以使用MediaType指示消息类型。以下是使用Jersey客户端API的示例。请注意URL是如何相同的,只是请求的媒体类型不同。

Client client = Client.create();
WebResource resource = client.resource("http://localhost:8080/CustomerService/rest/customers");

// Get XML response as a Customer
Customer customer = resource.path("1")
    .accept(MediaType.APPLICATION_XML)
        .get(Customer.class);
System.out.println(customer.getLastName() + ", "+ customer.getFirstName());

// Get JSON response as a Customer
Customer customer = resource.path("1")
    .accept(MediaType.APPLICATION_JSON)
        .get(Customer.class);
System.out.println(customer.getLastName() + ", "+ customer.getFirstName());

了解更多信息

答案 1 :(得分:7)

如果您的客户希望使用URL的一部分来配置响应类型,则可以使用Servlet过滤器。

实现覆盖表示(媒体类型)的简单方法可以使用URL查询参数:

/资源/待办事项?格式= JSON

Servlet过滤器解析URL查询参数,如果格式为= json,则替换或添加接受标头“application / json”。

答案 2 :(得分:4)

不需要单独的类,您需要的是单独的方法:

@GET
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
public Todo getXML() {
    Todo todo = new Todo();
    todo.setSummary("This is my first todo");
    todo.setDescription("This is my first todo");
    return todo;
}

然后在客户端,当您请求服务时,您可以指明您想要的格式:

// Get XML
System.out.println(service.path("rest").path("todo").accept(MediaType.TEXT_XML).get(String.class));
// Get XML for application
System.out.println(service.path("rest").path("todo").accept(MediaType.APPLICATION_XML).get(String.class));
// Get JSON for application
System.out.println(service.path("rest").path("todo").accept(MediaType.APPLICATION_JSON).get(String.class));