企業分佈式微服務雲SpringCloud SpringBoot mybatis （三）Spring Boot構建RESTful API與單元測試

首先，回顧並詳細說明一下在快速入門中使用的@Controller、@RestController、@RequestMapping註解。若是您對Spring MVC不熟悉而且尚未嘗試過快速入門案例，建議先看一下快速入門的內容。

@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; 

	// 一、get查一下user列表，應該爲空 
	request = get("/users/"); 
	mvc.perform(request) 
			.andExpect(status().isOk()) 
			.andExpect(content().string(equalTo("[]"))); 

	// 二、post提交一個user 
	request = post("/users/") 
			.param("id", "1") 
			.param("name", "測試大師") 
			.param("age", "20"); 
	mvc.perform(request) 
	        .andExpect(content().string(equalTo("success"))); 

	// 三、get獲取user列表，應該有剛纔插入的數據 
	request = get("/users/"); 
	mvc.perform(request) 
			.andExpect(status().isOk()) 
			.andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"測試大師\",\"age\":20}]"))); 

	// 四、put修改id爲1的user 
	request = put("/users/1") 
			.param("name", "測試終極大師") 
			.param("age", "30"); 
	mvc.perform(request) 
			.andExpect(content().string(equalTo("success"))); 

	// 五、get一個id爲1的user 
	request = get("/users/1"); 
	mvc.perform(request) 
			.andExpect(content().string(equalTo("{\"id\":1,\"name\":\"測試終極大師\",\"age\":30}"))); 

	// 六、del刪除id爲1的user 
	request = delete("/users/1"); 
	mvc.perform(request) 
			.andExpect(content().string(equalTo("success"))); 

	// 七、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等。

源碼來源：http://minglisoft.cn/honghu/technology.html