首先,回顾并详细说明一下在快速入门中使用的@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;
}
|
实现对User对象的操作接口
(value="/users") public class UserController {
static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());
(value="/", method=RequestMethod.GET) public List<User> getUserList() {
List<User> r = new ArrayList<User>(users.values()); return r; }
(value="/", method=RequestMethod.POST) public String postUser(@ModelAttribute User user) {
users.put(user.getId(), user); return "success"; }
(value="/{id}", method=RequestMethod.GET) public User getUser(@PathVariable Long id) {
return users.get(id); }
(value="/{id}", method=RequestMethod.PUT) public String putUser(@PathVariable Long id, @ModelAttribute User user) {
User u = users.get(id); u.setName(user.getName()); u.setAge(user.getAge()); users.put(id, u); return "success"; }
(value="/{id}", method=RequestMethod.DELETE) public String deleteUser(@PathVariable Long id) {
users.remove(id); return "success"; }
}
|
下面针对该Controller编写测试用例验证正确性,具体如下。当然也可以通过浏览器插件等进行请求提交验证。
(SpringJUnit4ClassRunner.class) (classes = MockServletContext.class)
public class ApplicationTests {
private MockMvc mvc;
public void setUp() throws Exception { mvc = MockMvcBuilders.standaloneSetup(new UserController()).build(); }
public void testUserController() throws Exception {
RequestBuilder request = null;
request = get("/users/"); mvc.perform(request) .andExpect(status().isOk()) .andExpect(content().string(equalTo("[]")));
request = post("/users/") .param("id", "1") .param("name", "测试大师") .param("age", "20"); mvc.perform(request) .andExpect(content().string(equalTo("success")));
request = get("/users/"); mvc.perform(request) .andExpect(status().isOk()) .andExpect(content().string(equalTo("[{\"id\":1,\"name\":\"测试大师\",\"age\":20}]")));
request = put("/users/1") .param("name", "测试终极大师") .param("age", "30"); mvc.perform(request) .andExpect(content().string(equalTo("success")));
request = get("/users/1"); mvc.perform(request) .andExpect(content().string(equalTo("{\"id\":1,\"name\":\"测试终极大师\",\"age\":30}")));
request = delete("/users/1"); mvc.perform(request) .andExpect(content().string(equalTo("success")));
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教程完整案例
.center {
text-align: center;
}
@media (min-width: 768px) {
.copyright-left {
float: left;
width: 80%;
}
.copyright-right {
float: left;
width: 20%;
}
}