當前位置:
首頁 >
前端技术
> javascript
>内容正文
javascript
Spring Boot构建RESTful API与单元测试
生活随笔
收集整理的這篇文章主要介紹了
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具體設計如下:
| GET | /users | 查詢用戶列表 |
| POST | /users | 創建一個用戶 |
| GET | /users/id | 根據id查詢一個用戶 |
| PUT | /users/id | 根據id更新一個用戶 |
| DELETE | /users/id | 根據id刪除一個用戶 |
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等。
完整案例
總結
以上是生活随笔為你收集整理的Spring Boot构建RESTful API与单元测试的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Spring Cloud构建微服务架构(
- 下一篇: springboot+mybatis+S