如何利用Spring MVC實現RESTful風格

Posted on by

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>

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

推薦閱讀：