这一节我们使用SpringMVC来实现一组对User对象操作的RESTful API,配合注释详细说明在Spring MVC中如何映射HTTP请求、如何传参、如何编写单元测试。
* RESTful API具体设计如下:*
请求类型 | URL | 功能说明 |
GET | /users | 查询用户列表 |
POST | /users | 创建一个用户 |
GET | /users/id | 根据id查询一个用户 |
PUT | /users/id | 根据id更新一个用户 |
DELETE | /users/id | 根据id删除一个用户 |
User实体定义:
publicclass User {
privatelongid;
private Stringname;
private Integerage;
// 省略setter和getter
}
实现对User对象的操作接口:
package com.kfit.controller;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
importorg.springframework.web.bind.annotation.PathVariable;
importorg.springframework.web.bind.annotation.RequestMapping;
importorg.springframework.web.bind.annotation.RequestMethod;
importorg.springframework.web.bind.annotation.RestController;
import com.kfit.demo.User;
@RestController
@RequestMapping(value="/users")//通过这里配置使下面的映射都在/users下
publicclass UserController {
//这里为了方便测试,直接将数据存储在map中,实际请从数据库获取.
privatestaticMap<Long,User>users = Collections.synchronizedMap(newHashMap<Long,User>());
/**
*返回所有的用户.
*@return
*/
@RequestMapping(value="", method=RequestMethod.GET)
public List<User> getUserList() {
// 处理"/users/"的GET请求,用来获取用户列表
// 还可以通过@RequestParam从页面中传递参数来进行查询条件或者翻页信息的传递
List<User> r = newArrayList<User>(users.values());
returnr;
}
@RequestMapping(value="/{id}",method=RequestMethod.GET)
public User getUser(@PathVariable Longid) {
// 处理"/users/{id}"的GET请求,用来获取url中id值的User信息
// url中的id可通过@PathVariable绑定到函数的参数中
returnusers.get(id);
}
/**
* post保存用户.
*@param user
*@return
*/
@RequestMapping(value ="",method=RequestMethod.POST)
public String postUser(Useruser){
// 处理"/users/"的POST请求,用来创建User
//@ModelAttribute User user
// 除了@ModelAttribute绑定参数之外,还可以通过@RequestParam从页面中传递参数
users.put(user.getId(),user);
return"success";
}
/**
*使用put进行更新用户.
*@param id
*@param user
*@return
*/
@RequestMapping(value="/{id}",method=RequestMethod.PUT)
public String putUser(@PathVariable Longid,Useruser){
// 处理"/users/{id}"的GET请求,用来获取url中id值的User信息
User u = users.get(id);
u.setName(user.getName());
u.setAge(user.getAge());
users.put(id,u);
return"success";
}
/**
*使用delete删除用户.
*@param id
*@return
*/
@RequestMapping(value="/{id}", method=RequestMethod.DELETE)
public String deleteUser(@PathVariable Longid) {
// 处理"/users/{id}"的DELETE请求,用来删除User
// url中的id可通过@PathVariable绑定到函数的参数中
users.remove(id);
return"success";
}
}
下面针对该Controller编写测试用例验证正确性,具体如下。当然也可以通过浏览器插件等进行请求提交验证:
。。。。。。。。。。。。。。。。。
版权原因,完整文章,请参考如下:48. spring boot单元测试restfull API【从零开始学Spring Boot】