SpringMVC 注解詳解

1. 引言

SpringMVC 是 Spring 框架中的 Web 層解決方案，它通過注解的方式來簡化 MVC 模式的實現。本篇將詳細介紹 SpringMVC 中常用的注解及其用法。

2. SpringMVC 注解分類

SpringMVC 的注解主要分為以下幾類：

2.1 核心注解

• @Controller：用于標識是一個控制器。
• @RestController：組合注解，等同于 @Controller + @ResponseBody，用于標識 RESTful Web Services。
• @RequestMapping：用于將 HTTP 請求映射到對應的方法上。

2.2 數據綁定注解

• @RequestParam：用于將請求參數與控制器方法的參數進行綁定。
• @PathVariable：用于將 URI 模板變量與控制器方法的參數進行綁定。
• @RequestBody：用于讀取 Http 請求的正文，將其綁定到相應的 bean 上。
• @ResponseBody：表示該方法的返回結果直接作為 Web 響應正文返回，用于異步請求處理。

2.3 其他注解

• @ModelAttribute：用于將請求參數與模型對象進行綁定。
• @CookieValue：用于將 Cookie 與控制器方法的參數進行綁定。
• @RequestHeader：用于將 Http 請求頭與控制器方法的參數進行綁定。

3. 核心注解詳解

3.1 @Controller

@Controller 注解是 SpringMVC 中最基本的注解之一，它用于聲明一個類為 SpringMVC 控制器，通常包含處理請求的方法。

@Controller
public class MyController {// ...
}

3.2 @RestController

@RestController 是 @Controller 和 @ResponseBody 的組合，用于創建 RESTful Web Services。

@RestController
public class MyRestController {// ...
}

3.3 @RequestMapping

@RequestMapping 用于將 URL 路徑與控制器中的方法進行映射。

@RequestMapping(value = "/hello", method = RequestMethod.GET)
public String sayHello() {return "Hello, World!";
}

4. 數據綁定注解詳解

4.1 @RequestParam

@RequestParam 用于將請求參數與控制器方法的參數進行綁定。

@RequestMapping(value = "/user", method = RequestMethod.GET)
public String getUser(@RequestParam("id") int id) {// ...
}

4.2 @PathVariable

@PathVariable 用于將 URI 模板變量與控制器方法的參數進行綁定。

@RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
public String getUserById(@PathVariable int id) {// ...
}

4.3 @RequestBody

@RequestBody 用于讀取 Http 請求的正文，將其綁定到相應的 bean 上。

@PostMapping("/user")
public UserResponse createUser(@RequestBody UserRequest userRequest) {// ...
}

4.4 @ResponseBody

@ResponseBody 表示該方法的返回結果直接作為 Web 響應正文返回。

@Controller
public class MyController {@ResponseBody@RequestMapping(value = "/hello", method = RequestMethod.GET)public String sayHello() {return "Hello, World!";}
}

5. 其他注解詳解

5.1 @ModelAttribute

@ModelAttribute 用于將請求參數與模型對象進行綁定。

@RequestMapping(value = "/add", method = RequestMethod.POST)
public String add(@ModelAttribute("data") MyData data) {// ...
}

5.2 @CookieValue

@CookieValue 用于將 Cookie 與控制器方法的參數進行綁定。

@RequestMapping(value = "/user", method = RequestMethod.GET)
public String getUser(@CookieValue("JSESSIONID") String cookie) {// ...
}

5.3 @RequestHeader

@RequestHeader 用于將 Http 請求頭與控制器方法的參數進行綁定。

@RequestMapping(value = "/user", method = RequestMethod.GET)
public String getUser(@RequestHeader("Authorization") String authorization) {// ...
}

SpringMVC 的注解極大地簡化了 Web 應用程序的開發過程，通過上述注解的靈活使用，開發者可以快速構建出功能強大且易于維護的 Web 應用。理解并掌握這些注解對于使用 SpringMVC 至關重要。