Spring MVC 中的 @RequestParam 注解

在现代 Web 开发中，参数传递是必不可少的，它使客户端能够向服务器发送数据。在 Spring MVC 中，@RequestParam 注解是处理请求参数的强有力工具。本文将深入探究这个注解，揭示其强大功能和灵活用法。

@RequestParam 注解概述

@RequestParam 注解用于从 HTTP 请求中获取参数，它本质上是一个控制器方法的参数。该注解具有以下语法：

@RequestParam(name = "paramName", defaultValue = "defaultValue") String paramValue

• name: 指定要获取的参数名。
• defaultValue: 可选的，指定如果请求中没有该参数，则返回的默认值。

使用 @RequestParam 处理参数

要使用 @RequestParam 注解处理参数，只需在控制器方法的参数前添加此注解即可。例如：

@PostMapping("/submitForm")
public String submitForm(@RequestParam String name, @RequestParam String email) {
    // 处理 name 和 email 参数
    return "success";
}

defaultValue 属性

defaultValue 属性允许指定一个默认值，如果请求中没有该参数，则返回该默认值。这在处理可选参数时非常有用。例如：

@GetMapping("/showProfile")
public String showProfile(@RequestParam(defaultValue = "default.png") String avatar) {
    // 使用 avatar 参数，如果没有则使用默认头像
    return "profile";
}

处理多个参数

@RequestParam 注解可以用于处理多个参数。只需在每个参数前添加该注解即可。例如：

@GetMapping("/search")
public List<Product> search(@RequestParam String query, @RequestParam(defaultValue = "10") int pageSize) {
    // 处理查询和页面大小参数
    return productService.search(query, pageSize);
}

强制要求参数

通过设置 required 属性为 true，可以强制要求参数存在。如果请求中缺少该参数，将抛出异常。

@PostMapping("/submitOrder")
public Order submitOrder(@RequestParam(name = "orderId", required = true) Long id) {
    // id 参数是必须的
    return orderService.findById(id);
}

结论

Spring MVC 中的 @RequestParam 注解是处理 HTTP 请求参数的强大工具。它提供了多种特性，包括指定参数名、设置默认值、处理多个参数和强制要求参数。通过熟练掌握 @RequestParam 注解，开发者可以轻松高效地构建健壮且可维护的 Web 应用程序。