深入理解RequestMapping

一、RequestMapping介紹

RequestMapping是Spring MVC框架中最重要的註解的之一，其作用是將HTTP請求映射到控制器的處理方法上。RequestMapping的精髓就在於將URL映射到代碼執行上，實現不同的HTTP請求對應不同的方法調用，可以說是Web開發中不可缺少的註解。

二、RequestMapping的用法

RequestMapping註解可以用於類和方法兩個級別上，用於類級別上時，表示該類里所有方法的URL都是這個，比如@RestController、@RequestMapping(“/user”)，之後提到的所有URL都是在/user之後拼接的。

RequestMapping註解的value屬性來指定處理請求的URL，請求可以設置一個或多個參數，如value和method等等。屬性值通過花括弧括起來，並用逗號分隔，如：@RequestMapping(value={“”,””},method=RequestMethod.GET)。

三、RequestMapping的屬性

1. value/ path ：用於指定請求的實際地址，指定的地址可以是URI Template 模式

    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
    public void getUser(@PathVariable Long id, ModelMap modelMap) {
        // get some user data
    }

2. method：用於指定請求的method類型，注意：可以是POST、GET、PUT、DELETE等

    @RequestMapping(value = "/user/{id}", method = RequestMethod.POST)
    public void updateUser(@PathVariable Long id, @RequestBody User user) {
        // update user data
    }

3. params：用於指定request中必須包含某些參數值是，才能被匹配上，如：”params= {“name”}”表示請求中必須包含name參數

    @RequestMapping(value = "/user/{id}", method = RequestMethod.POST,params= {"name"})
    public void updateUser(@PathVariable Long id, @RequestBody User user) {
        // update user data
    }

4. headers：用於指定request中必須包含某些指定的HTTP請求頭是，才能被匹配上，如：”headers = {“content-type=text/*”}”表示請求中必須包含content-type為text/*類型的請求頭

    @RequestMapping(value = "/user/{id}", method = RequestMethod.POST,headers = {"content-type=text/*"})
    public void updateUser(@PathVariable Long id, @RequestBody User user) {
        // update user data
    }

5. consumes：用於指定處理請求的提交內容類型（Content-Type），如：”consumes = {“text/plain”, “application/*”}”，表示處理請求的提交內容類型必須是text/plain或者是application/*

    @RequestMapping(value = "/user/{id}", method = RequestMethod.POST, consumes = {"text/plain", "application/*"})
    public void updateUser(@PathVariable Long id, @RequestBody User user) {
        // update user data
    }

6. produces：用於指定返回的內容類型，僅當request請求頭中的(Accept)類型和produces指定的類型相同時，才會返回；如：produces={“application/xml”, “application/json”}，表示返回的內容類型必須是application/xml或者是application/json

    @RequestMapping(value = "/user/{id}", method = RequestMethod.GET, produces = {"application/xml", "application/json"})
    public @ResponseBody User getUser(@PathVariable Long id) {
        // get user data
    }

四、RequestMapping示例

示例展示如何通過RequestMapping註解實現get請求和post請求的映射。

1. get請求映射：

    @RequestMapping(method = RequestMethod.GET, value = "/healthz")
    public ResponseEntity checkHealth() {
        return ResponseEntity.status(HttpStatus.OK).body("OK");
    }

上述代碼將get請求的URI”/healthz”映射到了checkHealth方法，該方法返回一個字元串”OK”並將狀態設置為HttpStatus.OK。

2. post請求映射：

    @PostMapping(path = "/register")
    public ResponseEntity createUser(@RequestBody RegisterRequest request) {
        //create user logic...
        return ResponseEntity.status(HttpStatus.OK).body("User created with id:" + userId);
    }

上述代碼將post請求的URI”/register”映射到了createUser方法，該方法創建了一個用戶，並將其ID返回。

五、總結

RequestMapping作為Spring MVC框架中最重要的註解之一，是將HTTP請求映射到控制器的處理方法上的重要手段之一。其通過各種不同屬性的設置，實現了請求到方法調用的轉換，為Web應用開發提供了便利。