【源碼分析】- 在SpringBoot中你會使用REST風格處理請求嗎？

所謂"資源"，就是網絡上的一個實體，或者說是網絡上的一個具體信息。它可以是一段文本、一張圖片、一首歌曲、一種服務，總之就是一個具體的實在。你可以用一個URI（統一資源定位符）指向它，每種資源對應一個特定的URI。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或獨一無二的識別符。

所謂"上網"，就是與互聯網上一系列的"資源"互動，調用它的URI。

1.2 表現層（Representation）

"資源"是一種信息實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式，叫做它的"表現層"（Representation）。

比如，文本可以用txt格式表現，也可以用HTML格式、XML格式、JSON格式表現，甚至可以采用二進制格式；圖片可以用JPG格式表現，也可以用PNG格式表現。

URI只代表資源的實體，不代表它的形式。嚴格地說，有些網址最后的".html"后綴名是不必要的，因為這個后綴名表示格式，屬於"表現層"范疇，而URI應該只代表"資源"的位置。它的具體表現形式，應該在HTTP請求的頭信息中用Accept和Content-Type字段指定，這兩個字段才是對"表現層"的描述。

1.3 狀態轉化（State Transfer）

訪問一個網站，就代表了客戶端和服務器的一個互動過程。在這個過程中，勢必涉及到數據和狀態的變化。

互聯網通信協議HTTP協議，是一個無狀態協議。這意味着，所有的狀態都保存在服務器端。因此，如果客戶端想要操作服務器，必須通過某種手段，讓服務器端發生"狀態轉化"（State Transfer）。而這種轉化是建立在表現層之上的，所以就是"表現層狀態轉化"。

客戶端用到的手段，只能是HTTP協議。具體來說，就是HTTP協議里面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。它們分別對應四種基本操作：GET用來獲取資源，POST用來新建資源（也可以用於更新資源），PUT用來更新資源，DELETE用來刪除資源。

1.4 綜述

綜合上面的解釋，我們總結一下什么是RESTful架構：

　　（1）每一個URI代表一種資源；

　　（2）客戶端和服務器之間，傳遞這種資源的某種表現層；

　　（3）客戶端通過四個HTTP動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。

摘抄結束：希望了解更多，去上面的原文鏈接（希望他還在）

思考 🤔：我個人理解一言以蔽之：它是一種前端獲取資源的原則，這個原則更多的在客戶端通過有目的的動詞表示本次請求的含義。

2、實操SpringBoot 實現REST風格的表單提交

2.1 非REST 風格的代碼

舉例說明：對用戶表的的操作，增刪改查平衡車那個都是這么寫：

    @RequestMapping(value = "/getUser",method = RequestMethod.POST)
    public String getUser(){
        return "GET-張三";
    }

    @RequestMapping(value = "/saveUser",method = RequestMethod.POST)
    public String saveUser(){
        return "POST-張三";
    }


    @RequestMapping(value = "/putUser",method = RequestMethod.POST)
    public String putUser(){
        return "PUT-張三";
    }

    @RequestMapping(value = "/deleteUser",method = RequestMethod.POST)
    public String deleteUser(){
        return "DELETE-張三";
    }

每種業務都有自己的路徑，增刪改查前端會看到四種不同的路徑，代碼整體看起來比較冗余

2.2 REST風格的代碼

@RequestMapping(value = "/user",method = RequestMethod.GET)
    public String getUser(){
        return "GET-張三";
    }

    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public String saveUser(){
        return "POST-張三";
    }


    @RequestMapping(value = "/user",method = RequestMethod.PUT)
    public String putUser(){
        return "PUT-張三";
    }

    @RequestMapping(value = "/user",method = RequestMethod.DELETE)
    public String deleteUser(){
        return "DELETE-張三";
    }

很明顯的區別，請求路徑統一，通過請求方式區分獲取、刪除、修改、保存等動作，清爽多了

既然這么簡潔，我們實操一下吧

第1步：application.propertities 文件配置 spring.mvc.hiddenmethod.filter.enable=true,開啟表單的REST風格支持（這個源碼分析部分會講到）

第2部：編寫一個前端頁面實測一下 REST 風格的提交:

注意下頁面的 hidden隱藏域參數細節（后面源碼部分會提到）

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>測試 REST 風格</h1>
<form action="/user" method="get">
  <input value="GET提交" type="submit">
</form>
<form action="/user" method="post">
  <input value="POST提交" type="submit">
</form>
<form action="/user" method="post">
    <input name="_method" type="hidden" value="PUT" />
  <input value="PUT提交" type="submit">
</form>
<form action="/user" method="post">
    <input name="_method" type="hidden" value="DELETE" />
    <input value="DELETE提交" type="submit">
</form>
</body>
</html>
點擊並拖拽以移動

點擊四個按鈕，發現跳轉正確！

他是怎么跳轉的，看源碼分析 🤔 ↓

3、源碼分析

3.1 Springboot 的處理思路

SpringBoot的處理思路是：既然瀏覽器天然只能發送 GET 和 POST 請求，那可以利用前后的參數配合，根據約定好的參數，把POST或者GET 定向地轉成 PUT 或 DELETE 請求

3.2 HiddenHttpMethodFilter 處理 PUT 和DELETE

實現對REST 請求風格的支持主要得益於HiddenMethodFilter 類，它同樣是在WebMvcAutoConfiguration 這個自動配置類中在項目啟動時自動注入的。

  // 類WebMvcAutoConfiguration下
    // spring.mvc.hiddenmethod.filter.enabled 為 true 才會加載過濾器，這里就解釋了前面的配置項
    
    @Bean
    @ConditionalOnMissingBean(HiddenHttpMethodFilter.class)
    @ConditionalOnProperty(prefix = "spring.mvc.hiddenmethod.filter", name = "enabled")
    public OrderedHiddenHttpMethodFilter hiddenHttpMethodFilter() {
        return new OrderedHiddenHttpMethodFilter();
    }

着重看一下 HiddenHttpMethodFilter ，顧名思義 隱藏HTTP方法過濾器，它的類注釋翻譯完粘貼過來：

由於瀏覽器目前僅支持 GET 和 POST，因此一種常用技術（例如 Prototype 庫使用的技術）是使用帶有附加隱藏表單字段 ( _method ) 的普通 POST 來傳遞“真正的”HTTP 方法。此過濾器讀取該參數並相應地更改HttpServletRequestWrapper.getMethod()返回值。只允許"PUT" 、 "DELETE"和"PATCH" HTTP 方法。
請求參數的名稱默認為_method ，但可以通過methodParam屬性進行調整。

看下 HiddenHttpMethodFilter 的核心方法 doFilterInternal() , 他是如何吧我們的隱藏表單解析的

 // 核心方法
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {

        HttpServletRequest requestToUse = request;
        // 首先必須滿足為POST提交，然后再根據表單隱藏域名叫”_method“ 的參數進行判斷
        if ("POST".equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) {
            // 獲取 名稱為 ”_method“ 的參數
            String paramValue = request.getParameter(this.methodParam);
             // 獲取到的參數不為空
            if (StringUtils.hasLength(paramValue)) {
                // 把類型名稱幫我們轉為大寫
                String method = paramValue.toUpperCase(Locale.ENGLISH);
                // 只允許 PUT DELETE  PATCH
                if (ALLOWED_METHODS.contains(method)) {
                    // 重新包裝下這個類型為POST的request 成為客戶端想讓它成為的樣子
                    requestToUse = new HttpMethodRequestWrapper(request, method);
                }
            }
        }

        filterChain.doFilter(requestToUse, response);
    }

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 REST 風格的請求方式 springBoot使用aop添加處理rest請求打印請求時間和請求參數 springMVC的rest風格的url請求 SpringBoot簡單的REST風格例子 SpringBoot 中DispatcherServlet請求分發流程源碼分析 apiserver源碼分析——處理請求 Rest風格中關於JPA使用懶加載的坑 SpringMVC的REST風格的四種請求方式【串線篇】REST風格的請求格式 SpringMVC REST 風格請求介紹及簡單實踐