今天我們通過(guò)使用Spring MVC來(lái)實(shí)現(xiàn)一組對(duì)User對(duì)象操作的RESTful API，配合注釋詳細(xì)說(shuō)明在Spring MVC中如何映射HTTP請(qǐng)求、如何傳參、如何編寫(xiě)單元測(cè)試。
** RESTful API具體設(shè)計(jì)如下：**
定義User實(shí)體
@Data
public class User {
private Long id;
private String name;
private Integer age;
}
注意：相比1.x版本open in new window中自定義set和get函數(shù)的方式，這里使用@Data注解可以實(shí)現(xiàn)在編譯器自動(dòng)添加set和get函數(shù)的效果。該注解是lombok提供的，只需要在pom中引入加入下面的依賴(lài)就可以支持：
org.projectlombok
lombok
實(shí)現(xiàn)對(duì)User對(duì)象的操作接口
@RestController
@RequestMapping(value = "/users") // 通過(guò)這里配置使下面的映射都在/users下
public class UserController {
// 創(chuàng)建線程安全的Map，模擬users信息的存儲(chǔ)
static Map users = Collections.synchronizedMap(new HashMap());
/**
* 處理"/users/"的GET請(qǐng)求，用來(lái)獲取用戶(hù)列表
*
* @return
*/
@GetMapping("/")
public List getUserList() {
// 還可以通過(guò)@RequestParam從頁(yè)面中傳遞參數(shù)來(lái)進(jìn)行查詢(xún)條件或者翻頁(yè)信息的傳遞
List r = new ArrayList(users.values());
return r;
}
/**
* 處理"/users/"的POST請(qǐng)求，用來(lái)創(chuàng)建User
*
* @param user
* @return
*/
@PostMapping("/")
public String postUser(@RequestBody User user) {
// @RequestBody注解用來(lái)綁定通過(guò)http請(qǐng)求中application/json類(lèi)型上傳的數(shù)據(jù)
users.put(user.getId(), user);
return "success";
}
/**
* 處理"/users/{id}"的GET請(qǐng)求，用來(lái)獲取url中id值的User信息
*
* @param id
* @return
*/
@GetMapping("/{id}")
public User getUser(@PathVariable Long id) {
// url中的id可通過(guò)@PathVariable綁定到函數(shù)的參數(shù)中
return users.get(id);
}
/**
* 處理"/users/{id}"的PUT請(qǐng)求，用來(lái)更新User信息
*
* @param id
* @param user
* @return
*/
@PutMapping("/{id}")
public String putUser(@PathVariable Long id, @RequestBody User user) {
User u = users.get(id);
u.setName(user.getName());
u.setAge(user.getAge());
users.put(id, u);
return "success";
}
/**
* 處理"/users/{id}"的DELETE請(qǐng)求，用來(lái)刪除User
*
* @param id
* @return
*/
@DeleteMapping("/{id}")
public String deleteUser(@PathVariable Long id) {
users.remove(id);
return "success";
}
}
這里相較1.x版本open in new window中，用更細(xì)化的@GetMapping、@PostMapping等系列注解替換了以前的@RequestMaping注解；另外，還使用@RequestBody替換了@ModelAttribute的參數(shù)綁定。
編寫(xiě)單元測(cè)試
下面針對(duì)該Controller編寫(xiě)測(cè)試用例驗(yàn)證正確性，具體如下。當(dāng)然也可以通過(guò)瀏覽器插件等進(jìn)行請(qǐng)求提交驗(yàn)證。
@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter21ApplicationTests {
private MockMvc mvc;
@Before
public void setUp() {
mvc = MockMvcBuilders.standaloneSetup(new UserController()).build();
}
@Test
public void testUserController() throws Exception {
// 測(cè)試UserController
RequestBuilder request;
// 1、get查一下user列表，應(yīng)該為空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
// 2、post提交一個(gè)user
request = post("/users/")
.contentType(MediaType.APPLICATION_JSON)
.content("{\"id\":1,\"name\":\"測(cè)試大師\",\"age\":20}");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 3、get獲取user列表，應(yīng)該有剛才插入的數(shù)據(jù)
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"測(cè)試大師\",\"age\":20}]")));
// 4、put修改id為1的user
request = put("/users/1")
.contentType(MediaType.APPLICATION_JSON)
.content("{\"name\":\"測(cè)試終極大師\",\"age\":30}");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 5、get一個(gè)id為1的user
request = get("/users/1");
mvc.perform(request)
.andExpect(content().string(equalTo("{\"id\":1,\"name\":\"測(cè)試終極大師\",\"age\":30}")));
// 6、del刪除id為1的user
request = delete("/users/1");
mvc.perform(request)
.andExpect(content().string(equalTo("success")));
// 7、get查一下user列表，應(yīng)該為空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
}
}
對(duì)MockMvc不熟悉的讀者，可能會(huì)碰到一些函數(shù)不存在而報(bào)錯(cuò)。必須引入下面這些靜態(tài)函數(shù)的引用：
import static org.hamcrest.Matchers.equalTo;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
這里相較1.x版本open in new window中，主要有兩個(gè)地方不同。測(cè)試類(lèi)采用@RunWith(SpringRunner.class)和@SpringBootTest修飾啟動(dòng)；另外，由于POST和PUT接口的參數(shù)采用@RequestBody注解，所以提交的會(huì)是一個(gè)json字符串，而不是之前的參數(shù)形式，這里在定義請(qǐng)求的時(shí)候使用contentType(MediaType.APPLICATION_JSON)指定提交內(nèi)容為json格式，使用content傳入要提交的json字符串。如果用@ModelAttribute的話就得用param方法添加參數(shù)，還是需要參考1.x版本的open in new window。
至此，我們通過(guò)引入web模塊（沒(méi)有做其他的任何配置），就可以輕松利用Spring MVC的功能，以非常簡(jiǎn)潔的代碼完成了對(duì)User對(duì)象的RESTful API的創(chuàng)建以及單元測(cè)試的編寫(xiě)。
注：本文轉(zhuǎn)載自“程序猿DD”，如有侵權(quán)，請(qǐng)聯(lián)系刪除！
