簡單介紹
REST，即Representational State Transfer的縮寫。直接翻譯的意思是"表現層狀態轉化"。
它是一種互聯網應用程序的API設計理念：URL定位資源，用HTTP動詞（GET,POST,DELETE,DETC）描述操作。
產生背景
近年來移動互聯網的發展，前端設備層出不窮（手機、平板、桌面電腦、其他專用設備......），因此，必須有一種統一的機制，方便不同的前端設備與後端進行通信,於是RESTful誕生了，它可以通過一套統一的接口爲 Web，iOS和Android提供服務。
圖片.png
URI
即統一資源標識符，服務器上每一種資源，比如文檔、圖像、視頻片段、程序 都由一個通用資源標識符（Uniform Resource Identifier, 簡稱"URI"）進行定位。
HTTP動詞
常用的HTTP動詞有下面五個
- GET（SELECT）：從服務器取出資源（一項或多項）。
- POST（CREATE）：在服務器新建一個資源。
- PUT（UPDATE）：在服務器更新資源（客戶端提供改變後的完整資源）。
- PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。
- DELETE（DELETE）：從服務器刪除資源。
RESTful架構
服務器上每一種資源，比如一個文件，一張圖片，一部電影，都有對應的url地址，如果我們的客戶端需要對服務器上的這個資源進行操作，就需要通過http協議執行相應的動作來操作它，比如進行獲取，更新，刪除。
精華
簡單來說就是url地址中只包含名詞表示資源，使用http動詞表示動作進行操作資源
舉個例子：左邊是錯誤的設計，而右邊是正確的
GET /blog/getArticles --> GET /blog/Articles 獲取所有文章
GET /blog/addArticles --> POST /blog/Articles 添加一篇文章
GET /blog/editArticles --> PUT /blog/Articles 修改一篇文章
GET /rest/api/deleteArticles?id=1 --> DELETE /blog/Articles/1 刪除一篇文章
案例
註解介紹
@Controller：修飾class，用來創建處理http請求的對象@RestController：Spring4之後加入的註解，原來在@Controller中返回json需要@ResponseBody來配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，默認返回json格式。@RequestMapping：配置url映射
下面我們嘗試使用Spring MVC來實現一組對User對象操作的RESTful API，配合註釋詳細說明在Spring MVC中如何映射HTTP請求、如何傳參、如何編寫單元測試。
RESTful API具體設計如下：
User實體定義：
public class User {
private Long id;
private String name;
private Integer age;
// 省略setter和getter
}
|
實現對User對象的操作接口
@RestController
@RequestMapping(value="/users") // 通過這裏配置使下面的映射都在/users下
public class UserController {
// 創建線程安全的Map
static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());
@RequestMapping(value="/", method=RequestMethod.GET)
public List<User> getUserList() {
// 處理"/users/"的GET請求，用來獲取用戶列表
// 還可以通過@RequestParam從頁面中傳遞參數來進行查詢條件或者翻頁信息的傳遞
List<User> r = new ArrayList<User>(users.values());
return r;
}
@RequestMapping(value="/", method=RequestMethod.POST)
public String postUser(@ModelAttribute User user) {
// 處理"/users/"的POST請求，用來創建User
// 除了@ModelAttribute綁定參數之外，還可以通過@RequestParam從頁面中傳遞參數
users.put(user.getId(), user);
return "success";
}
@RequestMapping(value="/{id}", method=RequestMethod.GET)
public User getUser(@PathVariable Long id) {
// 處理"/users/{id}"的GET請求，用來獲取url中id值的User信息
// url中的id可通過@PathVariable綁定到函數的參數中
return users.get(id);
}
@RequestMapping(value="/{id}", method=RequestMethod.PUT)
public String putUser(@PathVariable Long id, @ModelAttribute User user) {
// 處理"/users/{id}"的PUT請求，用來更新User信息
User u = users.get(id);
u.setName(user.getName());
u.setAge(user.getAge());
users.put(id, u);
return "success";
}
@RequestMapping(value="/{id}", method=RequestMethod.DELETE)
public String deleteUser(@PathVariable Long id) {
// 處理"/users/{id}"的DELETE請求，用來刪除User
users.remove(id);
return "success";
}
}
|
下面針對該Controller編寫測試用例驗證正確性，具體如下。當然也可以通過瀏覽器插件等進行請求提交驗證。
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = MockServletContext.class)
@WebAppConfiguration
public class ApplicationTests {
private MockMvc mvc;
@Before
public void setUp() throws Exception {
mvc = MockMvcBuilders.standaloneSetup(new UserController()).build();
}
@Test
public void testUserController() throws Exception {
// 測試UserController
RequestBuilder request = null;
// 1、get查一下user列表，應該爲空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
// 2、post提交一個user
request = post("/users/")
.param("id", "1")
.param("name", "測試大師")
.param("age", "20");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 3、get獲取user列表，應該有剛纔插入的數據
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"測試大師\",\"age\":20}]")));
// 4、put修改id爲1的user
request = put("/users/1")
.param("name", "測試終極大師")
.param("age", "30");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 5、get一個id爲1的user
request = get("/users/1");
mvc.perform(request)
.andExpect(content().string(equalTo("{\"id\":1,\"name\":\"測試終極大師\",\"age\":30}")));
// 6、del刪除id爲1的user
request = delete("/users/1");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 7、get查一下user列表，應該爲空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
}
}
|
至此，我們通過引入web模塊（沒有做其他的任何配置），就可以輕鬆利用Spring MVC的功能，以非常簡潔的代碼完成了對User對象的RESTful API的創建以及單元測試的編寫。其中同時介紹了Spring MVC中最爲常用的幾個核心註解：@Controller,@RestController,RequestMapping以及一些參數綁定的註解：@PathVariable,@ModelAttribute,@RequestParam等。