Spring Boot構建RESTful API

  • @Controller:修飾class,用來建立處理http請求的對象
  • @RestController:Spring4以後加入的註解,原來在@Controller中返回json須要@ResponseBody來配合,若是直接用@RestController替代@Controller就不須要再配置@ResponseBody,默認返回json格式。
  • @RequestMapping:配置url映射

下面咱們嘗試使用Spring MVC來實現一組對User對象操做的RESTful API,配合註釋詳細說明在Spring MVC中如何映射HTTP請求、如何傳參、如何編寫單元測試。spring

RESTful API具體設計以下:json

User實體定義:api

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";
}

}
相關文章
相關標籤/搜索