Spring--视图内容协商(三)

本文是学习了小马哥在慕课网的课程的《Spring Boot 2.0深度实践之核心技术篇》的内容结合自己的需要和理解做的笔记。

上两篇文章，简单介绍了一下Spring的视图内容协商。接下来我们针对 REST 内容协商做一下介绍。

没想到截图效果怎么不好，实在是失落。

大纲

理解REST请求媒体类型
REST内容协商流程
REST内容协商源码分析

理解REST请求媒体类型

理解解析请求的媒体类型

在我们使用Spring开发的时候，相信 @RequestMapping 这个注解再也熟悉不过了，相信使用Restful API 接口形式开发的小伙伴们都避免不了设置API的媒体类型比如 Accept和 Content-Type ，在前一篇我们也说过 Spring 通过 ContentNegotiationManager 的 ContentNegotiationStrategy 解析请求中的媒体类型。

以 HeaderContentNegotiationStrategy 为例

如果解析成功，则返回合法的MediaType集合。
否则，返回MediaType.ALL默认的媒体类型，也就是 */*

在这里我们可以看一下HeaderContentNegotiationStrategy 源码，具体解释已经在注释中给出

@Override
public List<MediaType> resolveMediaTypes(NativeWebRequest request)
      throws HttpMediaTypeNotAcceptableException {
   //获取 Accept的 媒体类型的字符串数组
   String[] headerValueArray = request.getHeaderValues(HttpHeaders.ACCEPT);
   //如果为空 则返回 全部类型 也就是 */*
   if (headerValueArray == null) {
      return MEDIA_TYPE_ALL_LIST;
   }

   List<String> headerValues = Arrays.asList(headerValueArray);
   try {
      //转换为Spring 内置媒体类型集合 
      List<MediaType> mediaTypes = MediaType.parseMediaTypes(headerValues);
       //最佳媒体类型排序
      MediaType.sortBySpecificityAndQuality(mediaTypes);
      return !CollectionUtils.isEmpty(mediaTypes) ? mediaTypes : MEDIA_TYPE_ALL_LIST;
   }
   catch (InvalidMediaTypeException ex) {
      throw new HttpMediaTypeNotAcceptableException(
            "Could not parse 'Accept' header " + headerValues + ": " + ex.getMessage());
   }
}

当然在 ContentNegotiationManager 中也会有判断

@Override
public List<MediaType> resolveMediaTypes(NativeWebRequest request) throws HttpMediaTypeNotAcceptableException {
    //循环遍历协商处理策略
   for (ContentNegotiationStrategy strategy : this.strategies) {
      //获取媒体类型 比如 HeaderContentNegotiationStrategy 
      List<MediaType> mediaTypes = strategy.resolveMediaTypes(request);
       //如果媒体类型是 默认的所有 即 */* 则跳过 
      if (mediaTypes.equals(MEDIA_TYPE_ALL_LIST)) {
         continue;
      }
      return mediaTypes;
   }
   //如果都不满足 则最后返回 默认所有 即*/*
   return MEDIA_TYPE_ALL_LIST;
}

对比上面的源码我们可以看到 Spring 做了很多层校验来判断媒体类型是否为空。

理解可生成的媒体类型

使用@RequestMapping.produces() 属性来指定MediaType 类型集合影响浏览器响应头 Content-Type 媒体类型映射。

如果 @RequestMapping.produces() 存在，返回指定 MediaType 列表。
否则，返回已注册的 HttpMessageConverter 列表中支持的 MediaType 列表。
如果该列表与请求的媒体类型兼容，执行第一个兼容 HttpMessageConverter 的实现，默认
@RequestMapping#produces 内容到响应头 Content-Type
否则，抛出 HttpMediaTypeNotAcceptableException , HTTP Status Code : 415

这段源码会在稍后的源码分析中做详解。

理解可消费的媒体类型

使用@RequestMapping#consumes 属性，来设置兼容的MediaType 类型集合过滤请求头 Content-Type 媒体类型映射。

如果请求头 Content-Type 媒体类型兼容 @RequestMapping.consumes() 属性，执行该 HandlerMethod
否则 HandlerMethod 不会被调用。

这段源码会在稍后的源码分析中做详解。

REST内容协商流程

在讲述REST协商流程之前，我们先来了解一下对于REST内容协商非常关键的两个解析器

处理方法参数解析器（HandlerMethodArgumentResolver）
- 用于 HTTP 请求中解析 HandlerMethod 参数内容
处理方法返回值解析器(HandlerMethodReturnValueHandler)
- 用于 HandlerMethod 返回值解析为 HTTP 响应内容

流程图

对于协商流程，在这里贴一张图，流程大体就可以理解了，在结合下面的源码分析，相信很快就可以明白Spring的视图协商流程。

总体流程图.PNG

针对上述第10步转化HTTP消息的详细流程图

详细流程图.PNG

调试前的代码准备

在这里需要增加一个简单的User对象以及对应请求的Controller

User.java

/**
 * 用户对象
 */
public class User {

    private Long id;

    private String name;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

UserRestController.java

@RestController
public class UserRestController {


    //最终相应回浏览器的Content-Type 是 produces 的内容
    @PostMapping(value = "/user",
            consumes = "application/json;charset=UTF-8",
            produces = "application/json;charset=GBK")
    public User user(@RequestBody User user) {
        return user;
    }
}

添加完这两个类之后，让我们启动一下Spring-boot项目。

我们可以对比上面的总体流程图来对源码进行解读。我们使用PostMan来发送一个简单的请求。