目錄

前言

1、什麼是 REST 風格

1.1  資源(Resources)

1.2  表現層(Representation)

1.3  狀態轉化(State Transfer)

1.4  綜述

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

2.1   非REST 風格的程式碼

2.2   REST風格的程式碼

3、原始碼分析

3.1 Springboot 的處理思路

3.2 HiddenHttpMethodFilter 處理 PUT 和DELETE


前言

工作中面試中,總能提到REST風格 ?

但你真的會使用到它嗎?知道怎麼去修改底層配置嗎?

是不是在繁雜業務程式碼中早就迷失了 ? ...

1、什麼是 REST 風格

很多解釋概念的部落格,個人感覺阮一峰講的最透徹,

原文連結 https://blog.csdn.net/zhangliangzi/article/details/51428171

此連結不是原創,為防止他刪文章,我把精華摘抄點過來,

首先 RESTful架構,就是目前最流行的一種網際網路軟體架構。它結構清晰、符合標準、易於理解、擴充套件方便,所以正得到越來越多網站的採用。

REST這個詞,是 Roy Thomas Fielding 在他2000年的博士論文中提出的。

REST,即 Representational State Transfer 的縮寫,如果一個架構符合REST原則,就稱它為RESTful架構。

要理解RESTful架構,最好的方法就是去理解Representational State Transfer這個片語到底是什麼意思,它的每一個詞代表了什麼涵義。如果你把這個名稱搞懂了,也就不難體會REST是一種什麼樣的設計。

1.1  資源(Resources)

REST的名稱"表現層狀態轉化"中,省略了主語。"表現層"其實指的是"資源"(Resources)的"表現層"。

所謂"資源",就是網路上的一個實體,或者說是網路上的一個具體資訊。它可以是一段文字、一張圖片、一首歌曲、一種服務,總之就是一個具體的實在。你可以用一個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);
}