SpringMVC實現RESTful風格:@PathVariable註解的使用方式

Posted on by

1、RESTful簡介

RESTful為Representational State Transfer的縮寫，中文釋義為“表現層狀態轉換”。RESTful不是一種標準，而是一種設計風格。

RESTful本質上是一種分佈式系統的應用層解決方案，它的主要作用是充分並正確利用HTTP協議的特性，規范資源獲取的URL路徑。

通俗地講，RESTful風格的設計允許將參數通過URL拼接傳到服務端，目的是讓URL看起來更簡潔實用。並且對於不同操作，要指定不同的HTTP方法（POST/GET/PUT/DETELE）。

可以這麼說，隻要是具有上述相關約束條件和原則的應用程序或設計就可以被稱為RESTful風格的應用。

2、SpringMVC實現RESTful風格

SpringMVC支持實現RESTful風格的請求。SpringMVC可以使用@RequestMapping註解的路徑設置，結合@PathVariable註解的參數指定，來實現RESTful風格的請求。

【示例】實現一個在服務端出來RESTful風格請求的Controller方法。

/**
 * 獲取用戶
 *
 * @author pan_junbiao
 */
@RequestMapping(value = "/getUser/{id}", method = RequestMethod.GET)
@ResponseBody
public UserInfo getUserById(@PathVariable("id") int userId)
{
    UserInfo userInfo = new UserInfo();
    //獲取用戶信息
    if (userId == 1)
    {
        userInfo.setUserId(1);
        userInfo.setUserName("pan_junbiao的博客");
        userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
        userInfo.setRemark("您好，歡迎訪問 pan_junbiao的博客");
    }
    //返回結果
    return userInfo;
}

2.1 @PathVariable註解

在上述方法中，在@RequestMapping註解的請求路徑中添加瞭一個動態數據“{id}”，它的作用是解析前臺的請求路徑，將動態數據所在的位置解析為名為 id 的請求參數。

而在Controller的參數中，使用@PathVariable註解，在其中指定請求參數的key名稱，並映射在後面定義的形參上，這裡定義userId形參來接收名為id的請求參數。

方法體中其餘的操作就是正常的業務邏輯，最後使用@ResponseBody註解加上之前配置的類型轉換器，返回客戶端JSON類型的用戶信息。

總的來說，利用SpringMVC實現RESTful風格主要就是在於請求路徑和請求參數的映射，以及RequestMethod的指定。

2.2 修改SpringMVC的前端控制器配置

之前在項目工程的web.xml配置文件中，配置瞭SpringMVC的前端控制器，用於集中處理請求，配置如下：

<!-- SpringMVC前端控制器 -->
<servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/spring-mvc.xml</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>*.action</url-pattern>
</servlet-mapping>

可以看到，前端控制器過濾的是後綴為“*.action”的請求路徑，所以編寫的RESTful風格的請求是不能被前端控制器過濾並解析的，所以要修改該配置，使得RESTful風格的請求可以被SpringMVC的前端控制器處理：

<servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

造成問題：這裡修改成瞭過濾所有請求類型的請求至前端控制器。這可能會帶來靜態資源訪問的問題，將在下面處理該問題。

執行結果：

從執行結果中可以看到，成功查詢瞭id為1的用戶信息，這說明RESTful風格的請求服務編寫成功。

3、靜態資源訪問問題

前面在web.xml中配置瞭符合RESTful風格的DispatcherServlet前端控制器過濾器，實現瞭正確處理RESTful風格請求的機制。但是這種過濾方式會造成靜態資源無法訪問的問題，例如在JavaWeb項目中創建名為img的目錄，並且在該目錄中放置一張名為myImage.jpg的圖片。

由於圖片放置在WEB-INF文件夾外（由於JavaWeb的保護機制，WEB-INF文件夾下的文件不可以直接訪問），所以原則上是可以通過直接訪問靜態資源的方式獲取到該圖片的，但是發現並沒有成獲取到圖片資源，如下圖：

這是為什麼呢？原因在於在web.xml中配置的前端控制器的請求過濾機制，為瞭接收RESTful風格的請求，將過濾的後綴去除瞭，變成過濾所有後綴的請求路徑，此時靜態資源會被當作一個業務請求被DispatcherServlet前端控制器處理，前端控制器沒有發現能夠處理該請求的Controller控制器方法，所以對外拋出404（請求資源不可用）錯誤。

如果想正常處理靜態資源，但又要保證RESTful請求的正常響應，可以通過下面兩種方法來解決。

3.1 解決方法一

方法一，在SpringMVC的核心配置文件中使用<mvc:resource>標簽配置靜態資源的解析路徑，將需要加載的靜態資源的URI路徑配置在標簽中，然後配置該URI映射的真實資源路徑。配置如下：

<!-- 靜態資源的解析，包括：js/css/img... -->
<mvc:resources location="/js/" mapping="/js/**"/>
<mvc:resources location="/css/" mapping="/css/**"/>
<mvc:resources location="/img/" mapping="/img/**"/>

當在SpringMVC的核心配置文件中配置瞭靜態資源文件的解析路徑後，前端控制器就會根據請求URL中的具體子路徑來映射出靜態資源的真實路徑，然後為前端反饋真實的靜態資源信息。

3.2 解決方法二

方法二，在SpringMVC的核心配置文件中使用<mvc:default-servlet-handler/>配置默認的Servlet處理器，該配置將在SpringMVC上下文中定義一個DefaultServletHttpRequestHandler，它會對進入DispatcherServlet前端控制器的請求進行篩查，如果發現是沒有經過映射的請求，就將該請求交由Web應用服務器默認的Servlet處理，如果不是靜態資源的請求，才由DispatcherServlet前端控制器繼續處理。

此時就可以將請求中的靜態資源與其他業務請求分開處理，從而正常地返回靜態資源信息。

<!-- 2.靜態資源默認servlet配置
        (1)加入對靜態資源的處理：js/css/img...
        (2)允許使用"/"做整體映射
     -->
<mvc:default-servlet-handler/>

執行結果：

這說明靜態資源請求被單獨進行瞭處理，從而保證瞭RESTful請求能夠被Controller控制器正常處理並響應，也保證瞭靜態資源的正常獲取。

4、綜合實例

上面的代碼為查詢類型的請求代碼，而新增、修改以及刪除的請求與此類似，區別就是需要指定不同的RequestMethod屬性（POST/PUT/DELETE）。實例代碼如下：

（1）創建用戶信息實體類（UserInfo.java）

package com.pjb.ssm.entity; 
/**
 * 用戶信息實體類
 *
 * @author pan_junbiao
 **/
public class UserInfo
{
    private int userId; //用戶ID
    private String userName; //用戶姓名
    private String blogUrl; //博客地址
    private String remark; //備註
 
    //省略getter與setter方法...
}

（2）創建用戶信息控制器（UserController.java），實現RESTful風格的請求

package com.pjb.ssm.controller; 
import com.pjb.ssm.entity.UserInfo;
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;
import org.springframework.web.bind.annotation.ResponseBody;
 
/**
 * 用戶信息控制器
 *
 * @author pan_junbiao
 **/
@Controller
@RequestMapping("user")
public class UserController
{
    /**
     * 獲取用戶
     *
     * @author pan_junbiao
     */
    @RequestMapping(value = "/getUser/{id}", method = RequestMethod.GET)
    @ResponseBody
    public UserInfo getUserById(@PathVariable("id") int userId)
    {
        UserInfo userInfo = new UserInfo();
        //獲取用戶信息
        if (userId == 1)
        {
            userInfo.setUserId(1);
            userInfo.setUserName("pan_junbiao的博客");
            userInfo.setBlogUrl("https://blog.csdn.net/pan_junbiao");
            userInfo.setRemark("您好，歡迎訪問 pan_junbiao的博客");
        }
        //返回結果
        return userInfo;
    }
 
    /**
     * 新增用戶
     */
    @RequestMapping(value = "/addUser", method = RequestMethod.POST, produces = {"text/html;charset=UTF-8;", "application/json;"})
    @ResponseBody
    public String addUser(UserInfo userInfo)
    {
        return "執行新增用戶,用戶名稱：" + userInfo.getUserName();
    }
 
    /**
     * 刪除用戶
     */
    @RequestMapping(value = "/deleteUser/{id}", method = RequestMethod.DELETE, produces = {"text/html;charset=UTF-8;", "application/json;"})
    @ResponseBody
    public String deleteUser(@PathVariable("id") int userId)
    {
        return "執行刪除用戶，用戶ID：" + userId;
    }
 
    /**
     * 修改用戶
     */
    @RequestMapping(value = "/updateUser", method = RequestMethod.POST, produces = {"text/html;charset=UTF-8;", "application/json;"})
    @ResponseBody
    public String updateUser(UserInfo userInfo)
    {
        return "執行修改用戶,用戶名稱：" + userInfo.getUserName();
    }
}

（3）創建執行頁面（index.jsp）,在該頁面中使用瞭JQuery框架

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>首頁</title>
    <meta name="author" content="pan_junbiao的博客">
</head>
<body>
<h1>首頁</h1>
<input type="button" id="btnGetUser" value="獲取用戶"/>
<input type="button" id="btnAddUser" value="新增用戶"/>
<input type="button" id="btnDeleteUser" value="刪除用戶"/>
<input type="button" id="btnUpdateUser" value="修改用戶"/><br>
<p id="msg" style="color: red; font-size: 18px"></p>
</body>
<script src="${pageContext.request.contextPath}/JS/jquery-3.4.1.min.js"></script>
<script>
    //獲取用戶按鈕事件
    $("#btnGetUser").click(function () {
        var url = "${pageContext.request.contextPath}/user/getUser/1";
        window.location.href = url;
    });
 
    //新增用戶按鈕事件
    $("#btnAddUser").click(function () {
        //執行Ajax請求
        $.ajax({
            type: "POST",
            url: "${pageContext.request.contextPath}/user/addUser",
            data: {
                userId: 1,
                userName: "pan_junbiao的博客"
            },
            success: function (result) {
                $("#msg").append(result + "<br>");
            }
        });
    });
 
    //刪除用戶按鈕事件
    $("#btnDeleteUser").click(function () {
        //執行Ajax請求
        $.ajax({
            type: "DELETE",
            url: "${pageContext.request.contextPath}/user/deleteUser/1",
            success: function (result) {
                $("#msg").append(result + "<br>");
            }
        });
    });
 
    //修改用戶按鈕事件
    $("#btnUpdateUser").click(function () {
        //執行Ajax請求
        $.ajax({
            type: "POST",
            url: "${pageContext.request.contextPath}/user/updateUser",
            data: {
                userId: 1,
                userName: "pan_junbiao的博客"
            },
            success: function (result) {
                $("#msg").append(result + "<br>");
            }
        });
    });
</script>
</html>

執行結果：

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：