REST с Spring — ContentNegotiatingViewResolver против HttpMessageConverter + ResponseBody Annotation

Мой выбор

Это было немного сложно. Оба подхода несколько перекрывают друг друга, и я хотел бы, чтобы документация дала вам лучшее представление о том, какой подход использовать при каких обстоятельствах. Безусловно, опция ContentNegotiatingViewResolver представляется лучшим документированным решением. С другой стороны, вам не нужно настраивать явные представления при использовании HttpMessageConverters и аннотации ResponseBody, и, следовательно, эта настройка выглядит немного более упорядоченной.

Одна проблема, с которой я столкнулся, заключалась в том, что для моего приложения я могу возвращать как чистые представления данных (Json, XML), так и ответы Html / Jsp. Каким-то образом я не смог легко + аккуратно настроить свой контроллер, чтобы ответить на один и тот же URL-адрес несколькими методами контроллера (один из них использовал @ResponseBody, а другой возвращал представление JSP)

Во-вторых, я хотел также поддерживать расширения файлов, чтобы использовать правильный вид или конвертер. Однако оказывается, что HttpMessageConverters не поддерживают это — хотя где-то был пример использования параметров запроса. Но такой подход потребовал бы от меня создания дополнительных пользовательских классов …

В любом случае, я выбрал подход ContentNegotiatingViewResolver для реализации моих услуг Restful.

Дальнейшие проблемы

Как только я принял решение, казалось, все прошло гладко. Я быстро внедрил свои сервисы, и они отлично работали в Firefox. Вот пример предполагаемой структуры URL:

http://www.devnexus.com/s/speakers

http://www.devnexus.com/s/speakers.html

http://www.devnexus.com/s/speakers.xml

http://www.devnexus.com/s/speakers.json

После этого я решил охватить все основы: поддержка расширений файлов, а также разрешить клиентам подключаться к http://www.devnexus.com/s/speakers и извлекать все представления данных, используя соответствующий заголовок Http Accept.

Я развернул приложение в производство, но на следующий день на ежемесячном собрании группы пользователей в Атланте — люди сообщили мне, что сайт DevNexus не работает. Это было странно, так как я зашел на сайт за несколько минут до встречи.

Ну, как оказалось, Google Chrome, Safari и Internet Explorer передают дикую смесь заголовков Http Accept. Следовательно, когда пользователи обращались к http://www.devnexus.com/s/index, сервер пытался вернуть представление XML, поскольку Chrome и Safari запрашивали данные XML, а не данные HTML.

Для получения более подробной информации о заголовках Accept, пожалуйста, смотрите следующее увлекательное:

http://www.gethifi.com/blog/browser-rest-http-accept-headers

Что также меня оттолкнуло, так это то, что довольно много источников, в т.ч. Документация Spring подразумевает, что использование заголовка Http Accept может быть действительно эффективным способом определения правильного представления для возврата клиентам.

Чтобы проиллюстрировать хаос — Вот интересная публикация из списка рассылки webkit:

https://lists.webkit.org/pipermail/webkit-dev/2010-January/011188.html

В конечном счете, я настроил свой контекст сервлета так, как мне кажется, лучше всего подходит для меня. Url без расширения теперь всегда будет возвращать Html, а для других представлений данных расширение файла обязательно. Я также настроил ContentNegotiatingViewResolver на игнорирование заголовка Http Accept, установив:

<property name="ignoreAcceptHeader" value="true" />

Большое спасибо за эту публикацию в блоге Рика Херрика. Таким образом, теперь мой файл servlet-context.xml содержит:

    <bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
        <property name="order" value="1" />
        <property name="ignoreAcceptHeader" value="true" />
        <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" ref="jaxbMarshaller"/>
                </bean>
                <bean
                    class="org.springframework.web.servlet.view.json.MappingJacksonJsonView">
                    <property name="objectMapper" ref="jaxbJacksonObjectMapper"/>
                </bean>
            </list>
        </property>
    </bean>

    <bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
        <property name="order" value="2"/>
    </bean> 

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