SpringMVC開發RESTful接口

概念:

什么是REST?

REST是Representational State Transfer的縮寫。翻譯為"表現層狀態轉化",restful是一種接口設計風格,它不是一個協議,通常是基於HTTP協議的;

為什么需要這么一個風格呢?

RESTful的重點之一就是統一的接口命名規則;

每個開發者可能會有不同的接口風格,最常見的就類似於於getUserInfo,deleteUserInfo等等.....,但是這個純粹是跟每個開發者的習慣有關,多人協同開發時就可能會產生問題,特別是前后台分離時,前台人員不得不填寫大量各不相同的url來請求數據;

RESTful風格:

rest將每一個URI都看作是一個資源,這是一個概念,實際可以是一個圖片,一條記錄,一組記錄都可以; 每一種請求方法都對應着對某個資源的操作,通常包含以下四種:

• GET 獲取資源
• PUT 更新資源
• POST 提交資源
• DELETE 刪除資源

假設我們將id為1的用戶數據看做是一個資源,那么我們要在前台操作這個資源時就要向服務器發送能夠定位這個資源的請求地址,如:http://localhost:8080/SSMDemo/user/1 ,通過URI找到資源后,我們還要告訴服務器我們要對這個資源進行什么樣的操作,就通過HTTP的請求方法;如GET

簡單的說:RESTful就是用URI來定位資源,在通過請求方法來定義要執行的操作;

目前而言完全按照RESTful來設計的網站並不多,亞馬遜算是最早采用這種風格的網站之一,它的URL是像這樣:https://www.amazon.cn/gp/product/B00MCW8R1S

RESTful的無狀態性:

無狀態約束使服務器的變化對客戶端是不可見的，兩次連續的請求中，客戶端不依賴於同一台服務器,這使得服務器具備更好的伸縮性;

RESTful為系統帶來的好處:

降低開發的復雜性，提高系統的可伸縮性,使得接口更加規范化;

URI與URL:

URL是統一資源標識 (只要能唯一標識一個資源就叫做URI)

URL是統一資源路徑

URL屬於URI的一種

SpringMVC中的RESTful

可以看出來,RESTful的變化在於,請求地址的處理,以及請求方法的定義;

我們有兩個事情要做:

• 需要從URL中獲取一些參數
• 使得同一個接口的不同請求方法可以完成對應的操作

案例:設計一個對課程資源進行操作的RESTful接口

編寫controller

package com.kkb.controller;

import com.kkb.pojo.Course;
import com.kkb.service.CourseService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RestController
public class RESTCourseController {

    @Autowired
    CourseService service;

  	//獲取全部課程
		@RequestMapping(value = "/course",method = RequestMethod.GET)
    public List<Course> getCourseList(){
        System.out.println("getCourseList");
        return service.selectCourses();
    }  
    //根據id獲取某個課程
    @RequestMapping(value = "/course/{id}",method = RequestMethod.GET)
    public Course getCourse(@PathVariable Integer id){
        System.out.println("getCourse");
        System.out.println("參數:"+id);
        return service.selectByID(id);
    }
	  //添加新的課程
    @RequestMapping(value = "/course",method = RequestMethod.POST)
    public String addCourse(@RequestBody Course course){
        System.out.println("addCourse");
        System.out.println("參數:"+course);
        service.insertCourse(course);
        return "{\"msg\":\"success\"}";
    }
		//根據id刪除課程
    @RequestMapping(value = "/course/{id}",method = RequestMethod.DELETE)
    public String deleteCourse(@PathVariable Integer id){
        System.out.println("deleteCourse");
        System.out.println("參數:"+id);
        service.deleteCourse(id);
        return "{\"msg\":\"success\"}";
    }
    //根據id更新課程
    @RequestMapping(value = "/course",method = RequestMethod.PUT)
    public String updateCourse(@RequestBody Course course){
        System.out.println("updateCourse");
        System.out.println("參數:"+course);
        service.updateCourse(course);
        return "{\"msg\":\"success\"}";
    }
}

@PathVariable是專門用於從url中獲取參數的,在RequestMapping中添加{參數名稱},作為占位符, 參數名稱需要與方法中的參數名稱相同,若不同可以為@PathVariable添加value(通常沒必要這么做),像下面這樣:

  @RequestMapping(value = "/course/{cid}",method = RequestMethod.GET)
    public Course getCourse(@PathVariable("cid") Integer id){
        System.out.println("getCourse");
        System.out.println("參數:"+id);
        return service.selectByID(id);
    }

接口測試推薦使用postman mac可使用paw,

另外在實際開發中我們需要前台傳遞用戶令牌,以驗證身份;可以通過攔截器來實現;

補充:

Tomcat 只會解析get和post中的參數,若SpringMVC中使用了PUT或是DELETE,並且使用的是表單提交,那么將無法獲取參數,應為Tomcat沒有經參數接續出來放到request中,SpringMVC提供了一個過濾器,專門幫助tomcat解析put/delete中的參數並放入request中,配置方法如下:

web.xml:

<!--配置SpringMVC，解析PUT/DELETE的表單數據放入request-->
    <filter>
        <filter-name>HttpPutFormContentFilter</filter-name>
        <filter-class>org.springframework.web.filter.FormContentFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HttpPutFormContentFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

上述的問題在使用json交互時不會出現,因為SpringMVC是直接從請求體中獲取json數據的,不通過request;

啰嗦:如果頁面上的表單使用了PUT/或DELETE請求方式,就需要在web.xml中加入上面的過濾器;