Spring REST 3 для поддержки XML и JSON - PullRequest
Новая
       34

Spring REST 3 для поддержки XML и JSON

5 голосов
/ 16 января 2011

Если мы разрабатываем REST с использованием Spring MVC, он будет поддерживать данные XML и JSON.Я написал ContentNegotiationViewResorver в моем весеннем конфиге bean app-servlet.xml

<bean
        class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver"
        p:order="1">
        <property name="mediaTypes">
            <map>
                <entry key="xml" value="application/xml" />
                <entry key="json" value="application/json" />
            </map>
        </property>
        <property name="defaultViews">
            <list>
                <bean class="org.springframework.web.servlet.view.xml.MarshallingView">
                    <property name="marshaller">
                        <bean class="org.springframework.oxm.xstream.XStreamMarshaller"
                            p:autodetectAnnotations="true" />
                    </property>
                </bean>
                <bean
                    class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
            </list>
        </property>
    </bean>

И мой REST-контроллер весны: 

@Controller
@RequestMapping("/rest/customers")
class CustomerRestController {

protected Log log = LogFactory.getLog(CustomerRestController.class);

@RequestMapping(method = POST)
@ResponseStatus(CREATED)
public void createCustomer(@RequestBody Customer customer,
        HttpServletResponse response) {

    log.info(">>>" + customer.getName());
    response.setHeader("Location", String.format("/rest/customers/%s",
            customer.getNumber()));
}


@RequestMapping(value = "/{id}", method = GET)
@ResponseBody
public Customer showCustomer(@PathVariable String id) {
    Customer c = new Customer("0001", "teddy", "bean");
    return c;
}


@RequestMapping(value = "/{id}", method = PUT)
@ResponseStatus(OK)
public void updateCustomer(@RequestBody Customer customer) {
    log.info("customer: " + customer.getName());
}

Я установил аннотацию @XStreamAlias("customer") в своем классе домена клиента.Но когда я пытаюсь получить доступ к http://localhost:8080/rest/customers/teddy.xml, он всегда отвечает данными JSON.

Я установил аннотацию @XmlRootElement(name="customer") в своем классе домена клиента.Но когда я пытаюсь получить доступ к http://localhost:8080/rest/customers/teddy.json, он всегда отвечает на данные XML.

Что-то не так?

Ответы [ 6 ]

2 голосов
/ 17 января 2011

Какие заголовки Accept отправляются на ваш сервер? Убедитесь, что тип контента, который вы хотите запросить, находится в этом списке.

2 голосов
/ 16 января 2011

Я думаю, что тип содержимого "xml" должен быть сопоставлен с "text / xml", а не с "application / xml".Кроме того, чтобы принудительно разрешить преобразователи типов контента на основе расширения, вы можете попытаться установить для свойства «favPathExtension» ContentNegotiatingViewResolver значение true (хотя оно должно было быть истинным по умолчанию!)

РЕДАКТИРОВАТЬ: я сейчас добавилрабочий образец в этом месте GIT - git://github.com/bijukunjummen/mvc-samples.git, если вы вызываете конечную точку, используя mvn tomcat: run, json обслуживается в http://localhost:8080/mvc-samples/rest/customers/teddy.json и xml в http://localhost:8080/mvc-samples/rest/customers/teddy.xml.Здесь используется JAXB2, а не XStream, так как я знаком с JAXB.Одна вещь, которую я заметил, заключалась в том, что, когда мои аннотации JAXB были неправильными в классе Customer, Spring предоставлял JSON, а не XML, как вы его видели (вы можете воспроизвести его, удалив аннотацию XMLRootElement из класса Customer), как только я исправил свойаннотации, я вернул XML, как и ожидалось. Возможно, что-то не так с вашей конфигурацией XStream.

РЕДАКТИРОВАТЬ 2: Вы правы !!Я не заметил, как только я вернулся xml, я предположил, что JSON работает сейчас.Я вижу проблему, в AnnotationMethodHandlerAdapter, обработка для @ResponseBody немного странная, она полностью игнорирует ViewResolvers и использует вместо этого зарегистрированные MessageConverters, полностью обходя ContentNegotiatingViewResolver, пока один обходной путь должен использовать @ModelAttributeаннотация для ответа, вместо @ResponseBody, таким образом вызывается представление Resolvers.Попробуйте сейчас использовать проект на git@github.com:bijukunjummen/mvc-samples.git и посмотрите, работает ли он для вас.Это может быть баг Spring, вы можете попытаться сообщить об этом на форуме Spring и посмотреть, что они рекомендуют.

1 голос
/ 23 февраля 2012

Spring 3.1 решает проблему, о которой вы упомянули, используя новый элемент produces в аннотации @RequestMapping.Это позволяет вам контролировать HttpMessageConverter, который Spring применяет к вашему объекту.

Я написал сообщение в блоге об этом:

http://springinpractice.com/2012/02/22/supporting-xml-and-json-web-service-endpoints-in-spring-3-1-using-responsebody/

1 голос
/ 09 февраля 2012

Ну, у меня есть решение, но я не знаю, правильно ли это в вашем методе показать клиенту: 

@RequestMapping(value = "/{id}", method = GET)
@ResponseBody
public Customer showCustomer(@PathVariable String id) {
    Customer c = new Customer("0001", "teddy", "bean");
    return c;
}

В этой части мы используем MVC пружины, и в контроллере мы должны вернуть представление, поэтому я удалил аннотацию @ResponseBody и возвращаю String с именем представления, потому что в нашем XML мы добавили ContentNegotiatingViewResolver и когда у нас есть ResponseBody, contentnegociationviewresolver игнорируется, потому что ожидает представления, но мы вернули объект, поэтому метод должен быть таким: 

@RequestMapping(value = "/{id}", method = GET)

public String showCustomer(@PathVariable String id, ModelMap model) {
     Customer c = new Customer("0001", "teddy", "bean");
     model.addAttribute("customer",c);
    return "myView";
}

хорошо, это работает для меня, если у вас есть проблемы, вы можете добавить к своему app-servlet.xml

этот боб, но я не думаю, что вы должны добавить это. 

<bean
    class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="prefix">
        <value>/WEB-INF/views/</value>
    </property>
    <property name="suffix">
        <value>.jsp</value>
    </property>
</bean>

Я получил ответы от mkyong.com

1 голос
/ 16 января 2011

У меня была такая же проблема. Я предполагаю, что вы используете Spring 3, и вы использовали <mvc:annotation-driven/>. Я не совсем уверен, но я думаю, что это создает некоторый конфликт на основе конвертеров сообщений, которые настраивает пространство имен mvc.

Использование пространства имен oxm сработало для меня: 

@XmlRootElement(name="person")
class Person {
   private String firstName;
   private String lastName;
}

@Controller 
@RequestMapping("person")
class PersonController {
   @RequestMapping("list")
   public @ResponseBody Person getPerson() {
      Person p = new Person();
      p.setFirstName("hello");
      p.setLastName("world");
      return p;
   }
}

Конфигурация контента (MVC и распознаватель внутреннего представления находятся в другом контексте): 

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:context="http://www.springframework.org/schema/context" xmlns:oxm="http://www.springframework.org/schema/oxm"
    xmlns:p="http://www.springframework.org/schema/p" xmlns:util="http://www.springframework.org/schema/util"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.springframework.org/schema/oxm http://www.springframework.org/schema/oxm/spring-oxm-3.0.xsd   http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd   http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.0.xsd   http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd">

        <oxm:jaxb2-marshaller id="jaxbMarshaller">
        <oxm:class-to-be-bound name="package.Person" />
    </oxm:jaxb2-marshaller>

    <bean
        class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
        <property name="defaultContentType" value="text/html" />
        <property name="ignoreAcceptHeader" value="true" />
        <property name="favorPathExtension" value="true" />
        <property name="mediaTypes">
            <map>
                <entry key="json" value="application/json" />
                <entry key="xml" value="application/xml" />
            </map>
        </property>
        <property name="defaultViews">
            <list>
                <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
                <bean class="org.springframework.web.servlet.view.xml.MarshallingView">
                    <property name="marshaller" ref="jaxbMarshaller" />
                </bean>
            </list>
        </property>
    </bean>
</beans>

В этом примере используется JAXB, поэтому вам понадобятся jaxb-api и jaxb-impl на пути к классам.

Кроме того, просто совет, вам не нужен app-servlet.xml. В вашем файле web.xml установите для конфигурации значение null и позвольте слушателю контекста загрузить их для вас: 

<listener>
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <context-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/spring/mvc-context.xml, /WEB-INF/spring/content-negotiation-context.xml</param-value>
    </context-param>
    <servlet>
        <servlet-name>app</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value/>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>app</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
0 голосов
/ 23 февраля 2011

При обращении к контроллеру через браузер отправляется типичный заголовок браузера Accept.Он не будет совпадать ни с одним распознавателем представлений и по умолчанию будет иметь первое разрешение (application / xml) или совпадет, поскольку application / xml находится в списке Accept.

Я могу рекомендовать использовать RestClient http://code.google.com/p/rest-client/, чтобы получить полный контроль над тем, какой заголовок Accept (если он вообще есть) вы хотите отправить.

Я не рекомендую использовать text / xml, поскольку набор символов по умолчанию - US-ASCII, а не UTF-8.Это может создать проблемы в будущем.Вы всегда можете указать кодировку, но appliation / xml имеет кодировку по умолчанию UTF-8.

...