如何利用Spring MVC實現RESTful風格

2022-02-22 13:00:16

SpringMVC實現RESTful風格

RESTful

中文釋義為”表現層狀態轉換“，它不是一種標準，而是一種設計風格。

它的主要作用是充分並正確利用HTTP協定的特性，規範資源獲取的URI路徑。

通俗的講，RESTful風格的設計允許將引數通過URL拼接傳到伺服器端，目的是讓URL看起來更簡潔實用。

並且對於不同的操作，要指定不同的HTTP方法(POST/GET/PUT/DELETE)。可以這麼說，只要是具有上述相關條件和原則的應用程式或設計就可以被稱為RESTful風格的應用。

一個滿足RESTful的程式或設計應滿足以下條件和約束：

第一：對請求的URL進行規範，在URL中不會出現動詞，而是使用HTTP協定的動詞

第二：充分利用HTTP方法，HTTP方法名包括：GET、POST、PUT、PATCH、DELETE

使用Spring MVC實現RESTful風格

Spring mvc可以使用@RequestMapping的路徑設定，結合@PathVariable的引數指定，來實現RESTful風格的請求。

樣例要實現，通過拼接水果商品的id來實現一個RESTful風格的請求，並向後臺傳送該請求，以此來獲取JSON格式的水果資料

@RequestMapping(value="/queryFruit/{id}",method={RequestMethod.GET})
public @ResponseBody Fruits getFruitById(Model model,@PathVariable("id") Integer fruitId) throws Exception{
    Fruits fruit = fruitsServices.queryFruitById(fruitId);
    return fruit; 
}

在該方法中，在@RequestMapping註解的請求路徑中新增了一個動態資料"{id}"，它的作用是解析前臺的請求路徑，將動態資料所在的位置解析為名為id的請求引數。

@PathVariable註解，在其中指定請求引數的key名稱，並對映在後面定義的形參上，這裡定義fruitId形參來接收名為id的請求引數，最後使用@ResponseBody註解加上之前設定的型別轉換器，返回使用者端JSON型別的水果詳細資訊，總的來說，利用SprngMVC實現RESTful風格主要就是在於請求路徑和請求引數的對映，以及RequestMapping的指定，更改web.xml中組態檔的內容，將*.do改成"/"，這樣編寫的RESTful風格的請求才能被前端控制器攔截到並解析。

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

然後重啟工程，輸入網址：http://localhost:8080/工程名/queryFruit/1

上面的程式碼為查詢型別的請求程式碼，而新增、修改以及刪除的請求與此類似，區別就是需要指定不同的RequestMethod(POST/PUT/DELETE),樣例程式碼如下：

        //新增水果邏輯
	@RequestMapping(value="/addFruit",method= {RequestMethod.POST})
	public String addFruit(Model model,Fruits fruit)throws Exception{
		//implements
		return "...";
	}
	//通過id刪除水果商品
		@RequestMapping(value="/deleteFruit/{id}",method= {RequestMethod.DELETE})
		public String deleteFruitById(Model model,@PathVariable Integer fruitId)throws Exception{
			//implements
			return "...";
		}
	//修改水果商品資訊
	@RequestMapping(value="/editFruit",method= {RequestMethod.PUT})
	public String editFruitById(Model model,Fruits fruit)throws Exception{
		//implements
		return "...";
	}

前端在存取RESTful風格的增、刪、該請求時，需要設定HTTP請求的方法(method引數)。如果是在JSP頁面上使用form表單的提交方式來請求RESTful風格的服務，需要根據請求的型別，在form表單標籤中指定HTTP請求的相關method引數。

靜態資源存取問題

前面在web.xml中設定了符合RESTful風格的DispatcherServlet前端控制器過濾器。但是這種過濾方式會造成靜態資源無法存取的問題，例如：在webContent下的image資料夾下放置一張圖片logo.jpg。

由於圖片放置在WEB-INF檔案外（由於JavaWEB的保護機制，WEB-INF資料夾下的檔案不可直接存取），所以原則上是可以通過直接存取靜態資源的方式獲取該圖片的，但是輸入http://localhost:8080/工程名/image/logo.jpg的請求後，不能獲取到圖片資源。

原因：

在web.xml中設定了前端控制器的請求過濾機制，為了接收RESTful風格的請求，將過濾的字尾去除了，變成過濾所有字尾的請求路徑，此時靜態資源會被當做一個業務請求被前端控制器處理，前端控制器沒有發現能夠處理該請求的Controller控制器方法，所以對外丟擲了404錯誤。

解決方式一：

在類載入組態檔springmvc中使用"mvc:resources"設定靜態資源的解析路徑，將需要載入的靜態資源的URI路徑設定在標籤中，然後設定該URI對映的真是資源路徑。

<mvc:resources location="/js/" mapping="/js/**"/>
<mvc:resources location="/img/" mapping="/img/**"/>
<mvc:resources location="/css/" mapping="/css/**"/>

當在springmvc.xml中設定了靜態資原始檔的解析路徑後，前端控制器就會根據請求URL中的具體子路徑來對映出靜態資源的真是路徑，然後為前端反饋真實的靜態資源資訊。

解決方式二：

在springmvc.xml中使用"<mvc:default-servlet-handler/>"設定預設的Servlet處理器，該設定將在SpringMVC上下文中定義一個DefaultServletHttpRequestHandler，他會對進入DispatcherServlet的請求進行篩選，若發現沒有經過對映的請求，就將該請求交由Web應用伺服器預設的Servlet處理，如果不是靜態資源的請求，才由DispatcherServlet前端控制器繼續處理，此時就可以將請求中的靜態資源和其他業務請求分開處理，從而正常地返回靜態資源資訊。

Spring MVC的RESTful學習

什麼RESTful

RESTful也稱為REST（Representational State Transfer），可以將它理解為一種軟體架構風格或設計風格

RESTful風格就是把請求引數程式設計請求路徑的一種風格。

例如，傳統的URL請求如下：

http://.../requestparam?id=1

而採用RESTful風格後，URL請求變為：

http://.../param/1

RESTful風格在HTTP請求中使用put，delete，post和get方式分別對應新增，刪除，修改和查詢的操作。不過國內開發目前只使用post和get方式實現增刪改查操作。

使用簡單的加法計算

@Controller
public class RestFulController {
    //原來的：localhost:8080/add?a=1&b=1
    //RestFul:   localhost:8080/add/a/b
    @RequestMapping(value = "/add/{a}/{b}",method = RequestMethod.GET)
    public String test(@PathVariable int a,@PathVariable int b, Model model) {
        int res = a + b;
        model.addAttribute("msg","結果為："+res);
        return "test";
    }
}

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
${msg}
</body>
</html>

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。