@RequestParam、@PathVariable、@RequestBody和@ModelAttribute怎么使用

@RequestParam、@PathVariable、@RequestBody和@ModelAttribute怎么使用

在Spring MVC中，處理HTTP請求時，我們經常需要從請求中提取數據并將其綁定到控制器方法的參數上。Spring提供了多種注解來幫助我們完成這一任務，其中最常用的包括@RequestParam、@PathVariable、@RequestBody和@ModelAttribute。本文將詳細介紹這些注解的使用方法和適用場景。

1. @RequestParam

@RequestParam注解用于從HTTP請求的查詢參數中提取數據。它通常用于處理GET請求中的查詢字符串參數。

1.1 基本用法

@GetMapping("/greet")
public String greet(@RequestParam String name) {
    return "Hello, " + name + "!";
}

在這個例子中，@RequestParam注解用于從請求的查詢參數中提取name參數。例如，如果請求的URL是/greet?name=John，那么name參數的值將是"John"。

1.2 可選參數

默認情況下，@RequestParam注解的參數是必需的。如果請求中沒有提供該參數，Spring會拋出MissingServletRequestParameterException異常。你可以通過設置required屬性為false來使參數變為可選的。

@GetMapping("/greet")
public String greet(@RequestParam(required = false) String name) {
    if (name == null) {
        return "Hello, World!";
    }
    return "Hello, " + name + "!";
}

1.3 默認值

你還可以通過defaultValue屬性為參數指定默認值。

@GetMapping("/greet")
public String greet(@RequestParam(defaultValue = "World") String name) {
    return "Hello, " + name + "!";
}

在這個例子中，如果請求中沒有提供name參數，name的值將默認為"World"。

2. @PathVariable

@PathVariable注解用于從URL路徑中提取數據。它通常用于處理RESTful風格的URL。

2.1 基本用法

@GetMapping("/users/{id}")
public String getUser(@PathVariable Long id) {
    return "User ID: " + id;
}

在這個例子中，@PathVariable注解用于從URL路徑中提取id參數。例如，如果請求的URL是/users/123，那么id參數的值將是123。

2.2 多個路徑變量

你可以在一個方法中使用多個@PathVariable注解。

@GetMapping("/users/{userId}/orders/{orderId}")
public String getOrder(@PathVariable Long userId, @PathVariable Long orderId) {
    return "User ID: " + userId + ", Order ID: " + orderId;
}

在這個例子中，URL路徑中的userId和orderId將被分別綁定到方法的參數上。

3. @RequestBody

@RequestBody注解用于將HTTP請求體中的數據綁定到方法的參數上。它通常用于處理POST或PUT請求中的JSON或XML數據。

3.1 基本用法

@PostMapping("/users")
public String createUser(@RequestBody User user) {
    // 處理用戶創建邏輯
    return "User created: " + user.getName();
}

在這個例子中，@RequestBody注解用于將請求體中的JSON數據綁定到User對象上。Spring會自動將JSON數據反序列化為User對象。

3.2 處理復雜對象

@RequestBody注解不僅可以用于簡單的POJO對象，還可以用于處理復雜的嵌套對象。

@PostMapping("/orders")
public String createOrder(@RequestBody Order order) {
    // 處理訂單創建邏輯
    return "Order created: " + order.getId();
}

在這個例子中，Order對象可能包含多個嵌套的OrderItem對象，Spring會自動處理這些嵌套對象的反序列化。

4. @ModelAttribute

@ModelAttribute注解用于將HTTP請求中的數據綁定到模型對象上。它通常用于處理表單提交或查詢參數。

4.1 基本用法

@PostMapping("/users")
public String createUser(@ModelAttribute User user) {
    // 處理用戶創建邏輯
    return "User created: " + user.getName();
}

在這個例子中，@ModelAttribute注解用于將請求中的表單數據綁定到User對象上。Spring會自動將表單字段映射到User對象的屬性上。

4.2 處理多個模型對象

你可以在一個方法中使用多個@ModelAttribute注解。

@PostMapping("/orders")
public String createOrder(@ModelAttribute Order order, @ModelAttribute User user) {
    // 處理訂單創建邏輯
    return "Order created: " + order.getId() + " for user: " + user.getName();
}

在這個例子中，Order和User對象將分別從請求中提取數據并綁定到方法的參數上。

4.3 在方法上使用@ModelAttribute

@ModelAttribute注解還可以用于控制器方法上，用于在每次請求處理之前將數據添加到模型中。

@ModelAttribute
public void addAttributes(Model model) {
    model.addAttribute("message", "Welcome to our website!");
}

在這個例子中，addAttributes方法會在每次請求處理之前被調用，并將message屬性添加到模型中。

5. 總結

• @RequestParam：用于從查詢參數中提取數據，適用于GET請求。
• @PathVariable：用于從URL路徑中提取數據，適用于RESTful風格的URL。
• @RequestBody：用于將請求體中的數據綁定到對象上，適用于POST或PUT請求中的JSON或XML數據。
• @ModelAttribute：用于將請求中的數據綁定到模型對象上，適用于表單提交或查詢參數。

通過合理使用這些注解，我們可以輕松地從HTTP請求中提取數據并將其綁定到控制器方法的參數上，從而簡化開發過程并提高代碼的可讀性和可維護性。