1. 程式人生 > >構建RESTful API

構建RESTful API

刪除 tco body nag ttr variable process 線程 get

首先,回顧並詳細說明一下在快速入門中使用的@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; 

    // 省略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"; 
    } 

}

技術分享圖片

構建RESTful API