前言
不知你在使用Spring Boot
时是否对这样一个现象"诧异"过:同一个
接口(同一个URL)在接口报错情况下,若你用rest访问,它返回给你的是一个json
串;但若你用浏览器访问,它返回给你的是一段html
。恰如下面例子(Spring Boot
环境~):
@RestController @RequestMapping public class HelloController { @GetMapping("/test/error") public Object testError() { System.out.println(1 / 0); // 强制抛出异常 return "hello world"; } }
使用浏览器访问:http://localhost:8080/test/error
使用Postman访问:
同根不同命有木有。RESTful服务中很重要的一个特性是:同一资源可以有多种表述,这就是我们今天文章的主题:内容协商(ContentNegotiation)。
HTTP内容协商
虽然本文主要是想说Spring MVC中的内容协商机制,但是在此之前是很有必要先了解HTTP的内容协商是怎么回事(Spring MVC实现了它并且扩展了它更为强大~)。
定义
一个URL资源服务端可以以多种形式进行响应:即MIME(MediaType)媒体类型。但对于某一个客户端(浏览器、APP、Excel导出…)来说它只需要一种。so这样客户端和服务端就得有一种机制来保证这个事情,这种机制就是内容协商机制。
方式
http的内容协商方式大致有两种:
- 服务端将可用列表(自己能提供的MIME类型们)发给客户端,客户端选择后再告诉服务端。这样服务端再按照客户端告诉的MIME返给它。(缺点:多一次网络交互,而且使用对使用者要求高,所以此方式一般不用)
- (常用)客户端发请求时就指明需要的MIME们(比如Http头部的:Accept),服务端根据客户端指定的要求返回合适的形式,并且在响应头中做出说明(如:Content-Type)1. 若客户端要求的MIME类型服务端提供不了,那就406错误吧~
常用请求头、响应头
请求头
Accept:告诉服务端需要的MIME(一般是多个,比如text/plain,application/json等。*/*表示可以是任何MIME资源)
Accept-Language:告诉服务端需要的语言(在中国默认是中文嘛,但浏览器一般都可以选择N多种语言,但是是否支持要看服务器是否可以协商)
Accept-Charset:告诉服务端需要的字符集
Accept-Encoding:告诉服务端需要的压缩方式(gzip,deflate,br)
响应头
Content-Type:告诉客户端响应的媒体类型(如application/json、text/html等)
Content-Language:告诉客户端响应的语言
Content-Charset:告诉客户端响应的字符集
Content-Encoding:告诉客户端响应的压缩方式(gzip)
报头Accept与Content-Type的区别
有很多文章粗暴的解释:Accept属于请求头,Content-Type属于响应头,其实这是不准确的。
在前后端分离开发成为主流的今天,你应该不乏见到前端的request请求上大都有Content-Type:application/json;charset=utf-8这个请求头,因此可见Content-Type并不仅仅是响应头。
HTTP协议规范的格式如下四部分:
- <request-line>(请求消息行)
- <headers>(请求消息头)
- <blank line>(请求空白行)
- <request-body>(请求消息体)
Content-Type指请求消息体的数据格式,因为请求和响应中都可以有消息体,所以它即可用在请求头,亦可用在响应头。
关于更多Http中的Content-Type的内容,我推荐参见此文章:Http请求中的Content-Type
Spring MVC内容协商
Spring MVC实现了HTTP内容协商的同时,又进行了扩展。它支持4种协商方式:
- HTTP头Accept
- 扩展名
- 请求参数
- 固定类型(producers)
说明:以下示例基于Spring进行演示,而非Spring Boot
方式一:HTTP头Accept
@RestController @RequestMapping public class HelloController { @ResponseBody @GetMapping("/test/{id}") public Person test(@PathVariable(required = false) String id) { System.out.println("id的值为:" + id); Person person = new Person(); person.setName("fsx"); person.setAge(18); return person; } }
如果默认就这样,不管浏览器访问还是Postman访问,得到的都是json串。
但若你仅仅只需在pom
加入如下两个包:
<!-- 此处需要导入databind包即可, jackson-annotations、jackson-core都不需要显示自己的导入了--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.9.8</version> </dependency> <!-- jackson默认只会支持的json。若要xml的支持,需要额外导入如下包 --> <dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-xml</artifactId> <version>2.9.8</version> </dependency>
再用浏览器/Postman访问,得到结果就是xml了,形如这样:
有的文章说:浏览器是xml,postman是json。本人亲试:都是xml。
但若我们postman手动指定这个头:Accept:application/json,返回就和浏览器有差异了(若不手动指定,Accept默认值是*/*):
并且我们可以看到response的头信息对比如下:
手动指定了Accept:application/json:
‘
木有指定Accept(默认*/*):