spring内容协商管理_Spring框架中的内容协商

spring内容协商管理

1.简介

使用BeanNameViewResolver完成的工作就是，我们刚刚在Spring上下文中创建了多个bean视图以生成预期的输出。 Spring很快引入了内容协商策略 ，该策略可以使用传统的RESTful @ResponseBody方法和HTTP消息转换器，以JSON或XML返回所需的输出，以及该配置提供的一些灵活性和动态性。

通常，我们需要为控制器返回的相同数据提供多种表示形式（或视图）。通过Spring的内容协商非常优雅地实现了这一目标。

2.实施

为了快速开始实施，首先创建一个新的maven项目。单击此处获得有关在Eclipse中创建新的Maven项目的帮助

现在，将所需的依赖项添加到pom.xml文件中。

pom.xml

<!-- Spring dependencies -->
<dependency><groupId>org.springframework</groupId><artifactId>spring-core</artifactId><version>4.2.1.RELEASE</version>
</dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-web</artifactId><version>4.2.1.RELEASE</version>
</dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>4.2.1.RELEASE</version>
</dependency><dependency><groupId>javax.xml.bind</groupId><artifactId>jaxb-api</artifactId><version>2.2.6</version>
</dependency>
<dependency><groupId>javax.xml</groupId><artifactId>jaxb-impl</artifactId><version>2.1</version>
</dependency><!-- Jackson JSON Processor -->
<dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-databind</artifactId><version>2.4.1</version>
</dependency>

打开web.xml并确保已完成正确的配置。

web.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns="http://java.sun.com/xml/ns/javaee"xsi:schemaLocation="http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"id="WebApp_ID" version="2.5"><display-name>SpringMVCWithContentNegotiation</display-name><servlet><servlet-name>mvc-dispatcher</servlet-name><servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>mvc-dispatcher</servlet-name><url-pattern>/*</url-pattern></servlet-mapping></web-app>

创建一个新的上下文文件，名称为<servlet name> -servlet.xml ，该文件必须是mvc-dispatcher-servlet.xml，并包含以下内容。

mvc-dispatcher-servlet.xml

<beans xmlns="http://www.springframework.org/schema/beans"xmlns:context="http://www.springframework.org/schema/context"xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsdhttp://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"><mvc:annotation-drivencontent-negotiation-manager="contentNegotiationManager"><mvc:path-matching registered-suffixes-only="true" /></mvc:annotation-driven><context:component-scan base-package="com.jcombat.controller" /><!-- To disable path extension check in the path variable of URI --><bean id="contentNegotiationManager"class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean"><property name="favorPathExtension" value="true" /><property name="ignoreAcceptHeader" value="true" /><property name="useJaf" value="false"/><property name="defaultContentType" value="application/json" /><property name="mediaTypes"><map><entry key="json" value="application/json" /><entry key="xml" value="application/xml" /></map></property></bean><!-- For Other media types --><bean id="jspViewResolver"class="org.springframework.web.servlet.view.InternalResourceViewResolver"><property name="prefix" value="/WEB-INF/jsp/" /><property name="suffix" value=".jsp" /></bean></beans>

请注意，组件扫描仅应用于com.jcombat.controller软件包，因此Spring可以自动检测应用程序控制器。

发出HTTP请求时，我们可以通过设置Accept标头属性来指定想要的响应类型。但是由于浏览器使用Accept标头的工作方式不正确，我们通常更喜欢在基于Spring的Web应用程序中忽略Accept标头，该Web应用程序以HTML以外的格式返回输出。

使用Java Activation Framework （JAF），我们不需要显式指定媒体类型映射，而是可以由JAF隐式完成。要使用JAF，我们可能需要添加额外的activation.jar依赖项。可能我们只想支持两种输出格式，即JSON和XML，因此我们选择不使用它，而是明确指定媒体类型映射。

现在是时候编写控制器了，应该像下面指定的那样。

EmployeeController.java

package com.jcombat.controller;import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;import com.jcombat.bean.Employee;@Controller
public class EmployeeController {@RequestMapping(value = "/employeeData", method = RequestMethod.GET, produces={"application/xml", "application/json"})public @ResponseBody Employee getEmployee() {Employee employee = new Employee();employee.setEmailId("abc@gmail.com");employee.setEmpId("123");employee.setName("Ajit");return employee;}
}