Spring
首先榄棵，回顧并詳細(xì)說明一下在快速入門中使用的@Controller肴楷、@RestController辕棚、@RequestMapping注解逆粹。如果您對Spring MVC不熟悉并且還沒有嘗試過快速入門案例，建議先看一下快速入門的內(nèi)容芍锚。
-
@Controller：修飾class昔园，用來創(chuàng)建處理http請求的對象 -
@RestController：Spring4之后加入的注解，原來在@Controller中返回json需要@ResponseBody來配合闹炉，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody蒿赢，默認(rèn)返回json格式。 -
@RequestMapping：配置url映射
下面我們嘗試使用Spring MVC來實現(xiàn)一組對User對象操作的RESTful API渣触，配合注釋詳細(xì)說明在Spring MVC中如何映射HTTP請求羡棵、如何傳參、如何編寫單元測試嗅钻。
** RESTful API具體設(shè)計如下：**
| 請求類型 | URL | 功能說明 |
|---|---|---|
| GET | /users | 查詢用戶列表 |
| POST | /users | 創(chuàng)建一個用戶 |
| GET | /users/id | 根據(jù)id查詢一個用戶 |
| PUT | /users/id | 根據(jù)id更新一個用戶 |
| DELETE | /users/id | 根據(jù)id刪除一個用戶 |
User實體定義：
public class User {
private Long id;
private String name;
private Integer age;
// 省略setter和getter
}
實現(xiàn)對User對象的操作接口
@RestController
@RequestMapping(value="/users") // 通過這里配置使下面的映射都在/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請求皂冰，用來獲取用戶列表
// 還可以通過@RequestParam從頁面中傳遞參數(shù)來進(jìn)行查詢條件或者翻頁信息的傳遞
List<User> r = new ArrayList<User>(users.values());
return r;
}
@RequestMapping(value="/", method=RequestMethod.POST)
public String postUser(@ModelAttribute User user) {
// 處理"/users/"的POST請求，用來創(chuàng)建User
// 除了@ModelAttribute綁定參數(shù)之外养篓，還可以通過@RequestParam從頁面中傳遞參數(shù)
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綁定到函數(shù)的參數(shù)中
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編寫測試用例驗證正確性舶胀，具體如下。當(dāng)然也可以通過瀏覽器插件等進(jì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 {
// 測試UserController
RequestBuilder request = null;
// 1嚣伐、get查一下user列表，應(yīng)該為空
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列表遗座，應(yīng)該有剛才插入的數(shù)據(jù)
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列表，應(yīng)該為空
request = get("/users/");
mvc.perform(request)
.andExpect(status().isOk())
.andExpect(content().string(equalTo("[]")));
}
}
至此，我們通過引入web模塊（沒有做其他的任何配置）弥臼，就可以輕松利用Spring MVC的功能，以非常簡潔的代碼完成了對User對象的RESTful API的創(chuàng)建以及單元測試的編寫舱呻。其中同時介紹了Spring MVC中最為常用的幾個核心注解：@Controller,@RestController,RequestMapping以及一些參數(shù)綁定的注解：@PathVariable,@ModelAttribute,@RequestParam等醋火。
