Spring MVC 4: "application/json" Тип контента настроен неправильно

У меня есть контроллер, сопоставленный со следующей аннотацией:

@RequestMapping(value = "/json", method = RequestMethod.GET, produces = "application/json")
@ResponseBody
public String bar() {
    return "{\"test\": \"jsonResponseExample\"}";
}

Я возвращаю действительную строку JSON, однако тип содержимого, когда я просматриваю ответ в Chrome Dev Tools в браузере, не application/json, а просто text/html. Почему тип содержимого не задан?

Мой web.xml:

<?xml version="1.0" encoding="UTF-8"?>
<web-app metadata-complete="true" version="3.0"
    xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">

    <display-name>Spring MVC Web Application</display-name>

    <servlet>
        <servlet-name>dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- static assets -->
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.js</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.css</url-pattern>
    </servlet-mapping>

    <servlet-mapping>
        <servlet-name>dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
</web-app>

Мой dispatcher-servlet.xml:

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


    <context:annotation-config />

    <context:component-scan base-package="com.mydomain.controllers" />

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

Использование WildFly 8.1 в качестве моего сервера приложений.

Ответы

Ответ 1

Прежде всего нужно понять, что элемент RequestMapping#produces() в

@RequestMapping(value = "/json", method = RequestMethod.GET, produces = "application/json")

служит только для ограничения отображения для ваших обработчиков запросов. Больше ничего не делает.

Затем, учитывая, что ваш метод имеет тип возврата String и аннотируется с помощью @ResponseBody, возвращаемое значение будет обрабатываться StringHttpMessageConverter, который устанавливает заголовок Content-type в text/plain. Если вы хотите вернуть строку JSON самостоятельно и установить заголовок на application/json, используйте возвращаемый тип ResponseEntity (избавиться от @ResponseBody) и добавьте в него соответствующие заголовки.

@RequestMapping(value = "/json", method = RequestMethod.GET, produces = "application/json")
public ResponseEntity<String> bar() {
    final HttpHeaders httpHeaders= new HttpHeaders();
    httpHeaders.setContentType(MediaType.APPLICATION_JSON);
    return new ResponseEntity<String>("{\"test\": \"jsonResponseExample\"}", httpHeaders, HttpStatus.OK);
}

Заметьте, что вы должны иметь

<mvc:annotation-driven />

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

Ответ 2

Используйте библиотеку jackson и аннотацию @ResponseBody для возвращаемого типа для контроллера.

Это работает, если вы хотите вернуть POJO, представленные как JSon. Если вы хотите вернуть String, а не POJO, как JSon, обратитесь к Sotirious answer.

Ответ 3

Как прокомментировали другие люди, поскольку возвращаемый тип вашего метода String Spring не будет нуждаться в том, чтобы что-либо сделать с результатом.

Если вы меняете свою подпись так, чтобы возвращаемый тип был чем-то требующим сортировки, это должно помочь:

@RequestMapping(value = "/json", method = RequestMethod.GET, produces = "application/json")
@ResponseBody
public Map<String, Object> bar() {
    HashMap<String, Object> map = new HashMap<String, Object>();
    map.put("test", "jsonRestExample");
    return map;
}

Ответ 4

Не совсем для этого OP, но для тех, кто столкнулся с 404, и не может установить ответ content-type на "application/json" (любой content-type). Одна из возможностей заключается в том, что сервер фактически отвечает 406, но проводник (например, хром) печатает его как 404.

Если вы не настроите конвертер сообщений, spring будет использовать AbstractMessageConverterMethodProcessor.java. Он будет работать:

List<MediaType> requestedMediaTypes = getAcceptableMediaTypes(request);
List<MediaType> producibleMediaTypes = getProducibleMediaTypes(request, valueType, declaredType);

и если они не имеют перекрытия (один и тот же элемент), он будет бросать HttpMediaTypeNotAcceptableException, и это, в конечном счете, вызывает 406. Независимо от того, является ли это ajax, или GET/POST, или действием формы, если запрос uri заканчивается символом .html или любым суффиксом, requestedMediaTypes будет "text/[that suffix]", и это конфликтует с producibleMediaTypes, которое обычно:

"application/json"  
"application/xml"   
"text/xml"          
"application/*+xml" 
"application/json"  
"application/*+json"
"application/json"  
"application/*+json"
"application/xml"   
"text/xml"          
"application/*+xml"
"application/xml"  
"text/xml"         
"application/*+xml"

Ответ 5

Когда я обновился до Spring 4, мне нужно было обновить зависимости Jackson следующим образом:

    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-core</artifactId>
        <version>2.5.1</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.5.1</version>
    </dependency>
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-annotations</artifactId>
        <version>2.5.1</version>
    </dependency>

Ответ 6

У меня были зависимости, как указано в сообщении @Greg. Я все еще столкнулся с проблемой и смогу ее решить, добавив следующую дополнительную зависимость Джексона:

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.7.4</version>
</dependency>