Spring--視圖內(nèi)容協(xié)商(三)

本文是學(xué)習(xí)了小馬哥在慕課網(wǎng)的課程的《Spring Boot 2.0深度實踐之核心技術(shù)篇》的內(nèi)容結(jié)合自己的需要和理解做的筆記。

上兩篇文章，簡單介紹了一下Spring的視圖內(nèi)容協(xié)商。接下來我們針對 REST 內(nèi)容協(xié)商做一下介紹。

沒想到截圖效果怎么不好，實在是失落。

大綱

理解REST請求媒體類型
REST內(nèi)容協(xié)商流程
REST內(nèi)容協(xié)商源碼分析

理解REST請求媒體類型

理解解析請求的媒體類型

在我們使用Spring開發(fā)的時候，相信 @RequestMapping 這個注解再也熟悉不過了，相信使用Restful API 接口形式開發(fā)的小伙伴們都避免不了設(shè)置API的媒體類型比如 Accept和 Content-Type ，在前一篇我們也說過 Spring 通過 ContentNegotiationManager 的 ContentNegotiationStrategy 解析請求中的媒體類型。

以 HeaderContentNegotiationStrategy 為例

如果解析成功，則返回合法的MediaType集合。
否則，返回MediaType.ALL默認(rèn)的媒體類型，也就是 */*

在這里我們可以看一下HeaderContentNegotiationStrategy 源碼，具體解釋已經(jīng)在注釋中給出

@Override
public List<MediaType> resolveMediaTypes(NativeWebRequest request)
      throws HttpMediaTypeNotAcceptableException {
   //獲取 Accept的 媒體類型的字符串?dāng)?shù)組
   String[] headerValueArray = request.getHeaderValues(HttpHeaders.ACCEPT);
   //如果為空 則返回 全部類型 也就是 */*
   if (headerValueArray == null) {
      return MEDIA_TYPE_ALL_LIST;
   }

   List<String> headerValues = Arrays.asList(headerValueArray);
   try {
      //轉(zhuǎn)換為Spring 內(nèi)置媒體類型集合 
      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());
   }
}

當(dāng)然在 ContentNegotiationManager 中也會有判斷

@Override
public List<MediaType> resolveMediaTypes(NativeWebRequest request) throws HttpMediaTypeNotAcceptableException {
    //循環(huán)遍歷協(xié)商處理策略
   for (ContentNegotiationStrategy strategy : this.strategies) {
      //獲取媒體類型 比如 HeaderContentNegotiationStrategy 
      List<MediaType> mediaTypes = strategy.resolveMediaTypes(request);
       //如果媒體類型是 默認(rèn)的所有 即 */* 則跳過 
      if (mediaTypes.equals(MEDIA_TYPE_ALL_LIST)) {
         continue;
      }
      return mediaTypes;
   }
   //如果都不滿足 則最后返回 默認(rèn)所有 即*/*
   return MEDIA_TYPE_ALL_LIST;
}

對比上面的源碼我們可以看到 Spring 做了很多層校驗來判斷媒體類型是否為空。

理解可生成的媒體類型

使用@RequestMapping.produces() 屬性來指定MediaType 類型集合影響瀏覽器響應(yīng)頭 Content-Type 媒體類型映射。

如果 @RequestMapping.produces() 存在，返回指定 MediaType 列表。
否則，返回已注冊的 HttpMessageConverter 列表中支持的 MediaType 列表。
如果該列表與請求的媒體類型兼容，執(zhí)行第一個兼容 HttpMessageConverter 的實現(xiàn)，默認(rèn)
@RequestMapping#produces 內(nèi)容到響應(yīng)頭 Content-Type
否則，拋出 HttpMediaTypeNotAcceptableException , HTTP Status Code : 415

這段源碼會在稍后的源碼分析中做詳解。

理解可消費的媒體類型

使用@RequestMapping#consumes 屬性，來設(shè)置兼容的MediaType 類型集合過濾請求頭 Content-Type 媒體類型映射。

如果請求頭 Content-Type 媒體類型兼容 @RequestMapping.consumes() 屬性，執(zhí)行該 HandlerMethod
否則 HandlerMethod 不會被調(diào)用。

這段源碼會在稍后的源碼分析中做詳解。

REST內(nèi)容協(xié)商流程

在講述REST協(xié)商流程之前，我們先來了解一下對于REST內(nèi)容協(xié)商非常關(guān)鍵的兩個解析器

處理方法參數(shù)解析器（HandlerMethodArgumentResolver）
- 用于 HTTP 請求中解析 HandlerMethod 參數(shù)內(nèi)容
處理方法返回值解析器(HandlerMethodReturnValueHandler)
- 用于 HandlerMethod 返回值解析為 HTTP 響應(yīng)內(nèi)容

流程圖

對于協(xié)商流程，在這里貼一張圖，流程大體就可以理解了，在結(jié)合下面的源碼分析，相信很快就可以明白Spring的視圖協(xié)商流程。

總體流程圖.PNG

針對上述第10步轉(zhuǎn)化HTTP消息的詳細(xì)流程圖

詳細(xì)流程圖.PNG

調(diào)試前的代碼準(zhǔn)備

在這里需要增加一個簡單的User對象以及對應(yīng)請求的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 {


    //最終相應(yīng)回瀏覽器的Content-Type 是 produces 的內(nèi)容
    @PostMapping(value = "/user",
            consumes = "application/json;charset=UTF-8",
            produces = "application/json;charset=GBK")
    public User user(@RequestBody User user) {
        return user;
    }
}

添加完這兩個類之后，讓我們啟動一下Spring-boot項目。

我們可以對比上面的總體流程圖來對源碼進(jìn)行解讀。我們使用PostMan來發(fā)送一個簡單的請求。