SpringMVC系列（三）:REST風格

一、什么叫REST

REST：即 Representational State Transfer。（資源）表現層狀態轉化。是目前最流行的一種互聯網軟件架構。它結構清晰、符合標准、易於理解、擴展方便，所以正得到越來越多網站的采用

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

• 表現層（Representation）：把資源具體呈現出來的形式，叫做它的表現層（Representation）。比如，文本可以用 txt 格式表現，也可以用 HTML 格式、XML 格式、JSON 格式表現，甚至可以采用二進制格式。

• 狀態轉化（State Transfer）：每發出一個請求，就代表了客戶端和服務器的一次交互過程。HTTP協議，是一個無狀態協議，即所有的狀態都保存在服務器端。因此，如果客戶端想要操作服務器，必須通過某種手段，讓服務器端發生“狀態轉化”（State Transfer）。而這種轉化是建立在表現層之上的，所以就是 “表現層狀態轉化”。具體說，就是 HTTP 協議里面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。它們分別對應四種基本操作：GET 用來獲取資源，POST 用來新建資源，PUT 用來更新資源，DELETE 用來刪除資源。

二、看完上面對REST的解釋是不是一臉懵比呢，沒關系我們通過代碼實例來解讀

 實際上REST就是一種新型的CRUD操作方式，那么SpringMVC是怎么實現的呢

1. 需要在web.xml配置 HiddenHttpMethodFilter

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">

   <!-- 
    配置 org.springframework.web.filter.HiddenHttpMethodFilter: 可以把 POST 請求轉為 DELETE 或 put 請求 
    -->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    <!-- 配置 DispatcherServlet -->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 配置 DispatcherServlet 的一個初始化參數: 配置 SpringMVC 配置文件的位置和名稱 -->
        <!-- 
            實際上也可以不通過 contextConfigLocation 來配置 SpringMVC 的配置文件, 而使用默認的.
            默認的配置文件為: /WEB-INF/<servlet-name>-servlet.xml
        -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc.xml</param-value>
        </init-param>
        <!-- 加載時創建 -->
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- dispatcherServlet可以應答所有請求 -->
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

HiddenHttpMethodFilter源碼:

@Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
            throws ServletException, IOException {

        HttpServletRequest requestToUse = request;

        if ("POST".equals(request.getMethod()) && request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE) == null) {
            String paramValue = request.getParameter(this.methodParam);
            if (StringUtils.hasLength(paramValue)) {
                requestToUse = new HttpMethodRequestWrapper(request, paramValue);
            }
        }

        filterChain.doFilter(requestToUse, response);
    }

通過源碼可以知道SpringMVC可以把post請求轉換為delete和put，我們只需要在發送 POST 請求時攜帶一個 name="_method" 的隱藏域, 值為 DELETE 或 PUT即可

2.在index.jsp編寫REST風格的CRUD請求

<!--Rest風格 begin  --> 
<br/>
<a href="restTest/testRest/1">Test Rest Get</a>

<br/>
<form action="restTest/testRest" method="post">
        <input type="submit" value="TestRest POST"/>
</form>

<br/>
<form action="restTest/testRest/1" method="post">
    <input type="hidden" name="_method" value="DELETE"/>
    <input type="submit" value="TestRest DELETE"/>
</form>

<br/>
<form action="restTest/testRest/1" method="post">
        <input type="hidden" name="_method" value="PUT"/>
        <input type="submit" value="TestRest PUT"/>
</form>
<!--Rest風格 end  --> 

3.編寫handler

package com.study.springmvc.handlers;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

@RequestMapping("/restTest")
@Controller
public class RestTest {

    public static final String SUCCESS="success";
    
    /**
     * Rest 風格的 URL. 
     * 以 CRUD 為例: 
     * 新增: /order POST 
     * 修改: /order/1 PUT update?id=1 
     * 獲取: /order/1 GET get?id=1 
     * 刪除: /order/1 DELETE delete?id=1
     * 
     * 如何發送 PUT 請求和 DELETE 請求呢 ? 
     * 1. 需要在web.xml配置 HiddenHttpMethodFilter 
     * 2. 需要發送 POST 請求
     * 3. 需要在發送 POST 請求時攜帶一個 name="_method" 的隱藏域, 值為 DELETE 或 PUT
     * 
     * 在 SpringMVC 的目標方法中如何得到 id 呢? 使用 @PathVariable 注解
     * 
     */
    
    /**
     * Rest風格：get請求
     * @param id
     * @return
     */
    @RequestMapping(value = "/testRest/{id}", method = RequestMethod.GET)
    public String testRest(@PathVariable Integer id) {
        System.out.println("testRest GET: " + id);
        return SUCCESS;
    }
    
    /**
     * Rest風格：post請求
     * @param id
     * @return
     */
    @RequestMapping(value = "/testRest", method = RequestMethod.POST)
    public String testRest() {
        System.out.println("testRest POST");
        return SUCCESS;
    }
    
    /**
     * Rest風格：delete請求
     * @param id
     * @return
     */
    @RequestMapping(value = "/testRest/{id}", method = RequestMethod.DELETE)
    public String testRestDelete(@PathVariable Integer id) {
        System.out.println("testRest Delete: " + id);
        return SUCCESS;
    }
    
    /**
     * Rest風格：put請求(更新)
     * @param id
     * @return
     */
    @RequestMapping(value = "/testRest/{id}", method = RequestMethod.PUT)
    public String testRestPut(@PathVariable Integer id) {
        System.out.println("testRest Put: " + id);
        return SUCCESS;
    }

}