SpringMVC 之内容协商策略（二）

老猫喜欢今日爬山

已于 2024-01-11 17:20:22 修改

阅读量486

点赞数 16

分类专栏： SpringMVC 系列文章标签：内容协商策略

于 2024-01-11 16:32:34 首次发布

本文链接：https://blog.csdn.net/baidu_35410857/article/details/135533201

版权

SpringMVC 系列专栏收录该内容

17 篇文章 0 订阅

订阅专栏

一、内容协商概念

根据客户端接收能力的不同，服务端返回不同的媒体类型的数据。这是由HTTP协议定的。

Accept 首部字段可通知服务器，用户代理能够处理的媒体类型及媒体类型的相对优先级。可使用 type/subtype 这种形式，一次指定多种媒体类型。

如文本文件 text/html，支持text和html两种内容格式

若想要给显示的媒体类型增加优先级，则使用 q= 来额外表示权重值1，用分号（;）进行分隔。权重值 q 的范围是 0~1（可精确到小数点后 3 位），且 1 为最大值。不指定权重 q 值时，默认权重为 q=1.0。

当服务器提供多种内容时，将会首先返回权重值最高的媒体类型。

所以不同的客户端向服务器发送不同的请求头信息，那么返回的内容也不一样。

在Http协议中最常用Accept首部字段的请求值不同来决定客户端返回的媒体内容类型

二、SpringMVC中的内容协商原理

判断客户端支持的内容媒体类型
- 关键组件ContentNegotiationManager 内容协商管理器，根据支持的协议方法来获得客户端支持的媒体类型
- 默认采用的HeaderContentNegotiationStrategy 基于请求头的策略，获取客户端中的Accept请求头中的信息
获得服务器端支持的媒体类型
- 遍历当前系统的所有消息转换器HttpMessageConverter，找到支持处理返回结果Class类型的消息处理器，将这些消息转换器支持的媒体类型加总
进行内容协商的最佳媒体类型的匹配（客户端支持的媒体类型和服务端支持的媒体内容进行匹配）
再次遍历所有的消息转换器，根据响应的最合适的媒体类型MediaType获得合适的消息转换器
消息转换器向Response中输出数据

三、内容协商策略

策略名称	策略原理	实现类	示例
请求头策略	获得客户端发送请求中的Accept请求字段信息（默认使用的）	HeaderContentNegotiationStrategy	Accept:application/xml
固定参数策略	读取固定参数format中的内容（默认是关闭的，可以配置spring.mvc.contentnegotiation.parameter-name=true）	ParameterContentNegotiationStrategy	localhost:8080/getUser?format=json
扩展名策略	开启拓展名的内容协商策略spring.mvc.contentnegotiation.favor-path-extension=true，根据扩展名部分判断请求的`MediaType`	ServletPathExtensionContentNegotiationStrategy	localhost:8080/getUser.json localhost:8080/getUser.xml
固定媒体类型策略	返回指定的媒体类型，通常可在映射路径的注解定义produces属性信息	FixedContentNegotiationStrategy	@GetMapping(value = “/getUser1”,produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

1: 内容协商策略是由优先级的 后缀 > 请求参数 > HTTP首部Accept。

2: 使用produces属性时，需要说明的是，这里指定的类型不能和后缀、请求参数、Accept冲突。比如这里指定了json格式，那么后缀如果不是json，或者format不是json，或者Accept不是application/json、/，将无法完成内容协商，http status code为406。

四、内容协商测试

设置服务器可以支持json 和xml 格式

4.1 引入依赖

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
  </dependencies>
<!--web starter中默认含有将对象转为json的jar jackson-databind.jar-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

<!--对象转换成xml形式-->
        <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
            <version>2.11.3</version>
        </dependency>
    </dependencies>

4.2 application.properties配置

# 开启支持固定参数的内容协商策略
spring.mvc.contentnegotiation.favor-parameter=true
# 开启支持servlet.path 后缀的内容协商策略
spring.mvc.contentnegotiation.favor-path-extension=true
# 支持使用后缀映射 /a 等价于 mapping 到 /a.*
spring.mvc.pathmatch.useSuffixPattern=true

经查，在不同的版本中后缀的内容协商是默认开启的，当前使用的spring-boot2.1.4.RELEASE是不支持的，所以需要手动开启，设置spring.mvc.contentnegotiation.favor-path-extension=true。同时在不支持后缀映射的前提下，需要开启spring.mvc.pathmatch.useSuffixPattern=true，否则会找不到处理请求的handler，页面404报错。
若支持后缀的内容协商策略，可不设置后两项

4.3 4种类型测试

@RestController
public class NegotiationController {

    @GetMapping("/getUser")
    public User getUser(){
        return new User("lyf",18,"it-api@mail.xxxx.com");
    }

}

4.3.1Accept测试

通过请求设置Accept 字段的不同，客户端返回不同的媒体数据类型

4.3.2固定参数测试

4.3.3拓展名测试

4.3.4固定媒体类型测试

测试controller

   @GetMapping(value = "/getUser1",produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
    public User getUser1(String format, HttpServletRequest request){
        return new User("lyf",18,"it-api@mail.xxxx.com");
    }

正常访问