SpringMVC中内容协商【统一资源多种展现json xml html】

最新推荐文章于 2024-11-07 17:56:25 发布
最新推荐文章于 2024-11-07 17:56:25 发布
阅读量279 收藏
点赞数
分类专栏： SpringMVC - 基础篇 文章标签： json java 测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/iteye_21015/article/details/82539770
版权

      在我们实际的开发中，往往需要SpringMVC服务提供多种的格式的数据。如：JSON、XML、HTML

当然我们知道SpringMVC已经提供了很多种转换器，供我们使用将数据转换成我们想要的数据格式。但是服务者怎么知道使用者，想要使用哪种数据格式哪？这就使用到了SpringMVC中的内容协商。

既然是内容协商，那么使用者肯定会告诉服务者，你给我返回什么类型的数据。使用者可以通过如下方式通知服务者。

一、内容协商

    1、使用参数

    

/userController/getUser?format=json
/userController/getUser?format=xml

    2、使用扩展名

 

   

/userController/getUser.html
/userController/getUser.json
/userController/getUser.xml

    3、使用http的Request Headers中的Accpet

 

   

GET /userController/getUser HTTP/1.1
Accept: application/xml                 //将返回xml格式数据

GET /userController/getUser HTTP/1.1
Accept: application/json               //将返回json格式数据

 以上三种方式分析：

 

   1、使用参数

     现在很多open API是使用这种方式,但可能由于要编写的字符较多。

    淘宝的开放平台就是使用的此种方式



 

2、使用扩展名称

   丧失了同一url多种展现的方式,但现在这种在实际环境中是使用比较方便的。

3、使用Request Header中Accpet

   这种方式是最理想的,但如果你的资源要给用户直接通过浏览器访问(即html展现),那么由于浏览器的差异,发送上来的Accept Header头将是不一样的. 将导致服务器不知要返回什么格式的数据给你. 下面是浏览器的Accept Header：

Chrome：



 

Firefox：



 

IE9：



 我们使用第一种方式和第二种方式，在Spring中如何让配置

 

二、SpringMVC配置

   现spring完成内容协商(content negotiation)的工作是由ContentNegotiatingViewResolver来完成的。

它的工作模式支持我上面讲的三种,ContentNegotiatingViewResolver是根据客户提交的MimeType(如 text/html,application/xml)来跟服务端的一组viewResover的MimeType相比较,如果符合,即返回viewResover的数据。
而 /userController/getUser.xml, ContentNegotiatingViewResolver会首先将 .xml 根据mediaTypes属性将其转换成 application/xml,然后完成前面所说的比较。

 

1、我们看下ContentNegotiatingViewResolver的配置：

<!-- 根据客户端的不同的请求决定不同的view进行响应, 如 /user/getUser.json /user/getUser.xml -->
	<bean
		class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
		<!-- 设置为true以忽略对Accept Header的支持 -->
		<property name="ignoreAcceptHeader" value="true" />
		<!-- 在没有扩展名时即: "/user/getUser" 时的默认展现形式 -->
		<property name="defaultContentType" value="text/html" />

		<!-- 扩展名至mimeType的映射,即 /getUser.json => application/json -->
		<property name="mediaTypes">
			<map>
				<entry key="json" value="application/json" />
				<entry key="xml" value="application/xml" />
			</map>
		</property>
		<!-- 用于开启 /user/getUser?format=json 的支持 -->
		<property name="favorParameter" value="false" />
		<property name="viewResolvers">
			<list>
				<bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
				<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
					<property name="viewClass"
						value="org.springframework.web.servlet.view.JstlView" />
					<property name="prefix" value="/WEB-INF/page/" />
					<property name="suffix" value=".jsp"></property>
				</bean>
			</list>
		</property>
		<property name="defaultViews">
			<list>
				<!-- for application/json -->
				<bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
				<!-- for application/xml -->
				<bean class="org.springframework.web.servlet.view.xml.MarshallingView">
					<property name="marshaller">
						<!-- xstream.XStreamMarshaller -->
						<bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
							<property name="classesToBeBound" >
								<list>
									<value>com.wy.pojo.User</value>
								</list>
							</property>
						</bean> 
					</property>
				</bean>
			</list>
		</property>
	</bean>

 我们在创建User对象

 

@XmlRootElement(name = "User")
public class User implements Serializable {

	private static final long serialVersionUID = 1L;
	private String username;
	private String password;
	private int age;
	private String sex;
	private String birthday;

	@XmlElement
	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	@XmlElement
	public String getPassword() {
		return password;
	}

	public void setPassword(String password) {
		this.password = password;
	}

	@XmlElement
	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}

	@XmlElement
	public String getSex() {
		return sex;
	}

	public void setSex(String sex) {
		this.sex = sex;
	}

	@XmlElement
	public String getBirthday() {
		return birthday;
	}

	public void setBirthday(String birthday) {
		this.birthday = birthday;
	}

	@Override
	public String toString() {
		// TODO Auto-generated method stub
		return this.username + "#" + this.password + "#" + this.age + "#"
				+ this.sex + "#" + this.birthday;
	}

}

 我们的控制层很简单的

 

@Controller
@RequestMapping("/userController")
public class UserController {
	@RequestMapping(value="getUser")
	public User getUser(){
		User user = new User();
		user.setUsername("wy");
		user.setPassword("123");
		user.setAge(123);
		user.setSex("male");
		user.setBirthday("2013-09-10");
		
		return user;
	}
}

 好，我们看下效果会是怎样子：

 

当我们在浏览器中输入：http://localhost:8080/SpringMVC/userController/getUser.json

结果：

{"user":{"username":"wy","password":"123","age":123,"sex":"male","birthday":"2013-09-10"}}

当我们在浏览器中输入：http://localhost:8080/SpringMVC/userController/getUser.xml

结果：

 

<User><age>123</age><birthday>2013-09-10</birthday><password>123</password><sex>male</sex><username>wy</username></User>

 

将配置文件中的

<!-- 用于开启 /user/getUser?format=json 的支持 -->
		<property name="favorParameter" value="false" />

 中false修改为true

 

我们再次在浏览器中输入：http://localhost:8080/SpringMVC/userController/getUser?format=json

 结果是:

{"user":{"username":"wy","password":"123","age":123,"sex":"male","birthday":"2013-09-10"}}

 

我们再次在浏览器中输入：http://localhost:8080/SpringMVC/userController/getUser?format=xml

结果是：

<User><age>123</age><birthday>2013-09-10</birthday><password>123</password><sex>male</sex><username>wy</username></User>

 

发现两次的请求结果是等效的。

 

下面是ContentNegotiatingViewResolver的完全配置：

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xmlns:mvc="http://www.springframework.org/schema/mvc"
        xmlns:util="http://www.springframework.org/schema/util" 
        xsi:schemaLocation="http://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
          http://www.springframework.org/schema/util 
          http://www.springframework.org/schema/util/spring-util-3.0.xsd" >
          
    <!-- 默认的注解映射的支持 ,它会自动注册DefaultAnnotationHandlerMapping 与AnnotationMethodHandlerAdapter--> 
    <mvc:annotation-driven />
    
    <!-- 自动扫描注解的Controller -->
	<context:component-scan base-package="com.wy.controller" />
	
	<!-- 根据客户端的不同的请求决定不同的view进行响应, 如 /user/getUser.json /user/getUser.xml -->
	<bean
		class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
		<!-- 设置为true以忽略对Accept Header的支持 -->
		<property name="ignoreAcceptHeader" value="true" />
		<!-- 在没有扩展名时即: "/user/getUser" 时的默认展现形式 -->
		<property name="defaultContentType" value="text/html" />

		<!-- 扩展名至mimeType的映射,即 /getUser.json => application/json -->
		<property name="mediaTypes">
			<map>
				<entry key="json" value="application/json" />
				<entry key="xml" value="application/xml" />
			</map>
		</property>
		<!-- 用于开启 /user/getUser?format=json 的支持 -->
		<property name="favorParameter" value="true" />
		<property name="viewResolvers">
			<list>
				<bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
				<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
					<property name="viewClass"
						value="org.springframework.web.servlet.view.JstlView" />
					<property name="prefix" value="/WEB-INF/page/" />
					<property name="suffix" value=".jsp"></property>
				</bean>
			</list>
		</property>
		<property name="defaultViews">
			<list>
				<!-- for application/json -->
				<bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
				<!-- for application/xml -->
				<bean class="org.springframework.web.servlet.view.xml.MarshallingView">
					<property name="marshaller">
						<!-- xstream.XStreamMarshaller -->
						<bean class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
							<property name="classesToBeBound" >
								<list>
									<value>com.wy.pojo.User</value>
								</list>
							</property>
						</bean> 
					</property>
				</bean>
			</list>
		</property>
	</bean>

</beans>

 

2、重载MappingJacksonJsonView

  我们在返回JSON格式的数据时，发现并不是我们常见的json。 也就是我们期望的返回是{success:true,message:”return ok”};  但实际返回的却是 {"jsonResult":{"success":true,"msg":"return ok"}}
原因是MappingJacksonJsonView中对返回值的处理未考虑modelMap中只有一个值的情况， 直接是按照mapName:{mapResult}的格式来返回数据的。

public class CustomJsonView extends MappingJacksonJsonView {
	protected Object filterModel(Map<String, Object> model) {  
        Map<?, ?> result = (Map<?, ?>) super.filterModel(model);  
        if (result.size() == 1) {  
            return result.values().iterator().next();  
        } else {  
            return result;  
        }  
    }  
}

 3、我们将

<bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />

 替换为我们刚修改的

<bean class="com.wy.view.CustomJsonView"/>

 再次浏览器中输入：http://localhost:8080/SpringMVC/userController/getUser.json

看到的结果这是我们期望的：

{"username":"wy","password":"123","age":123,"sex":"male","birthday":"2013-09-10"}

 

 参考：http://badqiu.iteye.com/blog/552806

（个人笔记系列） XML与JSON
Kuma_W的博客
09-06 224
前言： 本系列是我自己的个人笔记总结，是根据我自己纸质版笔记的内容和学习课件归纳，可能做得不好，但希望能够帮到那些和我一样0基础刚入坑的小白们，同时也欢迎各位前辈予以指正和批评指导，谢谢。XML与JSON XML 简介 可扩展标记语言（eXtensible Markup Language）。 特性: xml具有平台无关性, 是一门独立的标记语言. xml具有自我描述性 为什么学习XML？ 网络数据传输. 数据存储 配置文件 XML文件 .XML文件是保存XML数据的一种方式 XML数据也可以以其他的
spring REST中的内容协商(同一资源,多种展现:xml,json,html)
zyzzsky的专栏
10-30 159
来自：http://www.blogjava.net/badqiu/archive/2009/12/21/306793.html 一.REST内容协商介绍  RESTful服务中很重要的一个特性即是同一资源,多种表述.也即如下面描述的三种方式: 1.使用http request header: Accept GET /user/123 HTTP/1.1Accept: applicat...
Spring Web MVC框架（九） XML和JSON视图与内容协商
weixin_33978016的博客
02-14 116
Spring MVC不仅支持各种网页视图，也支持JSON、XML这样的视图。而且还支持内容协商，也就是根据传入的扩展名、请求参数、Accept Header等信息决定具体采用哪种视图。我们先来看看Spring的JSON和XML视图。 手动实现JSON或XML视图 这是最笨的办法，不过描述起来很简单。我们只要按...
使用Spring MVC的内容协商
热门推荐
xiejx618的专栏
11-25 1万+
spring支持三种方式来达到请求所需的content-type:url后缀,url参数,请求接收头.检测顺序:url后缀->url参数->请求接收头.最后都不确实content-type,毫无疑问是设置中的default.
SpringMVC——响应处理（2）之内容协商
contact97的博客
02-28 376
根据**客户端**接收能力的不同，服务端返回不同的媒体类型的数据。这是由**HTTP协议**定的。Accept 首部字段可通知服务器，用户代理能够处理的媒体类型及媒体类型的相对优先级。可使用 type/subtype 这种形式，一次指定多种媒体类型。如文本文件 **text/html**，支持text和html两种内容格式。若想要给显示的媒体类型增加优先级，则使用 q= 来额外表示权重值1，用分号（;）进行分隔。权重值 q 的范围是 0~1 当服务器提供多种内容时，将会首先返回权重值最高的媒体类型。
SpringMVC内容协商返回jsonxml格式
weixin_33806914的博客
11-27 120
2019独角兽企业重金招聘Python工程师标准>>> ...
SpringMVC 之 内容协商策略（二）
老猫喜欢今日爬山的博客
01-11 501
SpringMVC 之 内容协商策略（二）
SpringMVC框架中传递JSON数据时前台报406错误解决办法
04-16
在Spring MVC框架中，开发人员经常需要处理JSON数据进行前后端交互。然而，在实际操作中，我们可能会遇到一个常见的问题，即HTTP状态码406（Not Acceptable）。这个错误通常意味着服务器生成了响应，但客户端无法...
SpringMVC环境下实现的Ajax异步请求JSON格式数据
10-22
在SpringMVC环境中实现Ajax异步请求JSON格式数据是一项常见的任务，这有助于创建更高效、交互性更强的Web应用程序。以下是一份详细的步骤指南和关键知识点解析： 首先，环境搭建是基础。确保你已经设置了标准的...
SpringMVC笔记-内容协商原理浅析
weixin_48084293的博客
02-17 502
5.2 内容协商 5.2.1 内容协商介绍 根据浏览器可接受的媒体类型，服务器返回不同媒体类型的数据。 服务器会根据优先级，优先匹配浏览器和服务器都支持并且优先级最高的媒体类型。 例如，使用POSTMAN来分别测试响应 Json 和 xml 类型的数据。 导入解析 xml 文件类型的依赖 <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>
SpringMvc 内容协商与内容协商原理 基于参数的内容协商功能
Janyi_的博客
03-24 404
文章目录内容协商1. 引入支持XML依赖2. 使用PostMan测试3. 内容协商原理基于请求参数的内容协商 内容协商 就是根据浏览器接收能力不同，返回不同的媒体类型的数据，如application/json;客户端能接收的内容类型一般会再响应头当中accept中 1. 引入支持XML依赖 <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId&gt
SpringBoot与SpringMVC数据响应与内容协商原理
qmxqing的博客
07-29 205
1.数据响应与内容协商 给前端自动返回json数据 返回值解析器 返回值处理器处理返回值 this.returnValueHandlers.handleReturnValue( returnValue, getReturnValueType(returnValue), mavContainer, webRequest); 寻找哪个处理器能处理返回值 HandlerMethodReturnValueHandler handler = selectHandler(returnValue, retu
Go的JSON转化
weixin_44719499的博客
11-06 316
在Go语言中，处理JSON（JavaScript Object Notation）数据非常常见，特别是在与Web服务交互时。Go提供了内置的包来支持JSON的序列化（将Go对象转换为JSON格式）和反序列化（将JSON格式的数据解析为Go对象）。
Axios 的 responseType 属性详解及 Blob 与 ArrayBuffer 解析
weimengen的博客
11-07 232
本文详细介绍了 Axios 的 responseType 属性，包括其五种可设置的值及对应示例代码。重点讲解了 Blob 与 ArrayBuffer 的解析方法，为前端开发者处理不同类型的服务器响应提供了实用指南。
【Python】Bottle：轻量Web框架
2303_80346267的博客
11-06 986
你也可以创建自己的插件。一个插件通常是一个可以安装的类，并且可以通过方法进行注册。# 安装插件在这个例子中，我们创建了一个名为MyPlugin的插件，它会在响应中添加一个自定义的 HTTP 头。
禁止uni小程序ios端上下拉伸（橡皮筋效果）
最新发布
chaosama的博客
11-07 149
需要到pages.json文件中把这行加上就可以了。可以看到这里是被拉伸的。
【GeoJSON在线编辑平台】（1）创建地图+要素绘制+折点编辑+拖拽移动
ReBeX
11-04 480
简单实现一下地图加载、要素绘制、折点编辑和拖拽移动。打算统一都写到一个类里面。为了快速实现，直接去参考了官方案例。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值