javascript
Spring Boot构建RESTful API与单元测试
首先,回顧并詳細(xì)說(shuō)明一下在快速入門中使用的@Controller、@RestController、@RequestMapping注解。如果您對(duì)Spring MVC不熟悉并且還沒(méi)有嘗試過(guò)快速入門案例,建議先看一下快速入門的內(nèi)容。
- @Controller:修飾class,用來(lái)創(chuàng)建處理http請(qǐng)求的對(duì)象
- @RestController:Spring4之后加入的注解,原來(lái)在@Controller中返回json需要@ResponseBody來(lái)配合,如果直接用@RestController替代@Controller就不需要再配置@ResponseBody,默認(rèn)返回json格式。
- @RequestMapping:配置url映射
下面我們嘗試使用Spring MVC來(lái)實(shí)現(xiàn)一組對(duì)User對(duì)象操作的RESTful API,配合注釋詳細(xì)說(shuō)明在Spring MVC中如何映射HTTP請(qǐng)求、如何傳參、如何編寫單元測(cè)試。
RESTful API具體設(shè)計(jì)如下:
| GET | /users | 查詢用戶列表 |
| POST | /users | 創(chuàng)建一個(gè)用戶 |
| GET | /users/id | 根據(jù)id查詢一個(gè)用戶 |
| PUT | /users/id | 根據(jù)id更新一個(gè)用戶 |
| DELETE | /users/id | 根據(jù)id刪除一個(gè)用戶 |
User實(shí)體定義:
public class User { private Long id; private String name; private Integer age; // 省略setter和getter }實(shí)現(xiàn)對(duì)User對(duì)象的操作接口
@RestController @RequestMapping(value="/users") // 通過(guò)這里配置使下面的映射都在/users下 public class UserController { // 創(chuàng)建線程安全的Map static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); @RequestMapping(value="/", method=RequestMethod.GET) public List<User> getUserList() { // 處理"/users/"的GET請(qǐng)求,用來(lái)獲取用戶列表 // 還可以通過(guò)@RequestParam從頁(yè)面中傳遞參數(shù)來(lái)進(jìn)行查詢條件或者翻頁(yè)信息的傳遞 List<User> r = new ArrayList<User>(users.values()); return r; } @RequestMapping(value="/", method=RequestMethod.POST) public String postUser(@ModelAttribute User user) { // 處理"/users/"的POST請(qǐng)求,用來(lái)創(chuàng)建User // 除了@ModelAttribute綁定參數(shù)之外,還可以通過(guò)@RequestParam從頁(yè)面中傳遞參數(shù) users.put(user.getId(), user); return "success"; } @RequestMapping(value="/{id}", method=RequestMethod.GET) public User getUser(@PathVariable Long id) { // 處理"/users/{id}"的GET請(qǐng)求,用來(lái)獲取url中id值的User信息 // url中的id可通過(guò)@PathVariable綁定到函數(shù)的參數(shù)中 return users.get(id); } @RequestMapping(value="/{id}", method=RequestMethod.PUT) public String putUser(@PathVariable Long id, @ModelAttribute User user) { // 處理"/users/{id}"的PUT請(qǐng)求,用來(lái)更新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請(qǐng)求,用來(lái)刪除User users.remove(id); return "success"; } }下面針對(duì)該Controller編寫測(cè)試用例驗(yàn)證正確性,具體如下。當(dāng)然也可以通過(guò)瀏覽器插件等進(jìn)行請(qǐng)求提交驗(yàn)證。
@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 { // 測(cè)試UserController RequestBuilder request = null; // 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/") .param("id", "1") .param("name", "測(cè)試大師") .param("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") .param("name", "測(cè)試終極大師") .param("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("[]"))); } }至此,我們通過(guò)引入web模塊(沒(méi)有做其他的任何配置),就可以輕松利用Spring MVC的功能,以非常簡(jiǎn)潔的代碼完成了對(duì)User對(duì)象的RESTful API的創(chuàng)建以及單元測(cè)試的編寫。其中同時(shí)介紹了Spring MVC中最為常用的幾個(gè)核心注解:@Controller,@RestController,RequestMapping以及一些參數(shù)綁定的注解:@PathVariable,@ModelAttribute,@RequestParam等。
完整案例
總結(jié)
以上是生活随笔為你收集整理的Spring Boot构建RESTful API与单元测试的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: Spring Cloud构建微服务架构(
- 下一篇: spring 涉及到注解说明