SpringMVC 中的控制器如何使用 @RequestParam 注解

SpringMVC 中的控制器如何使用 @RequestParam 注解

引言

SpringMVC 是一个非常流行的 Java Web 框架，它采用了基于注解的方式来配置和管理控制器。在 SpringMVC 中，控制器是处理 HTTP 请求的关键组件，而 @RequestParam 注解则是控制器中用来获取 HTTP 请求参数的一种非常方便的方式。本文将介绍 @RequestParam 注解的使用方法，并通过示例代码演示如何在 SpringMVC 中使用 @RequestParam 注解。

@RequestParam 注解

@RequestParam 注解是 SpringMVC 中用来获取 HTTP 请求参数的注解，它可以用来获取 GET 或 POST 请求中的参数值，并将其赋值给控制器方法中的参数。@RequestParam 注解支持以下参数：

• value：指定参数名称，如果不指定，默认使用参数名作为参数名称。
• required：指定参数是否为必填参数，默认为 true。
• defaultValue：指定参数的默认值，当请求中没有该参数时，将使用默认值。

使用 @RequestParam 注解获取 GET 请求参数

在 SpringMVC 中，可以使用 @RequestParam 注解来获取 GET 请求中的参数值。下面是一个使用 @RequestParam 注解获取 GET 请求参数的示例代码：

@Controller
@RequestMapping("/user")
public class UserController {
    
    @RequestMapping("/get")
    @ResponseBody
    public String getUser(@RequestParam("id") int userId) {
        return "User Id: " + userId;
    }
}

在上面的示例代码中，我们定义了一个名为 getUser 的控制器方法，并使用 @RequestParam 注解来获取 GET 请求中名为 id 的参数值。当控制器接收到如下请求时，将返回响应内容 “User Id: 1001”：

http://localhost:8080/user/get?id=1001

使用 @RequestParam 注解获取 POST 请求参数

在 SpringMVC 中，可以使用 @RequestParam 注解来获取 POST 请求中的参数值。下面是一个使用 @RequestParam 注解获取 POST 请求参数的示例代码：

@Controller
@RequestMapping("/user")
public class UserController {
    
    @RequestMapping("/add")
    @ResponseBody
    public String addUser(@RequestParam("name") String userName, 
                          @RequestParam("age") int userAge) {
        return "User Name: " + userName + ", Age: " + userAge;
    }
}

在上面的示例代码中，我们定义了一个名为 addUser 的控制器方法，并使用 @RequestParam 注解来获取 POST 请求中名为 name 和 age 的参数值。当控制器接收到如下请求时，将返回响应内容 “User Name: Tom, Age: 20”：

POST http://localhost:8080/user/add
Content-Type: application/x-www-form-urlencoded

name=Tom&age=20

使用默认值和非必填参数

在 SpringMVC 中，可以使用 defaultValue 参数来指定参数的默认值，如果请求中没有该参数，则使用默认值。同时，可以使用 required 参数来指定参数是否为必填参数，默认为 true。下面是一个使用 defaultValue 和 required 参数的示例代码：

@Controller
@RequestMapping("/user")
public class UserController {
    
    @RequestMapping("/get")
    @ResponseBody
    public String getUser(@RequestParam(value="id", defaultValue="1001") int userId,
                          @RequestParam(value="name", required=false) String userName) {
        return "User Id: " + userId + ", Name: " + userName;
    }
}

在上面的示例代码中，我们定义了一个名为 getUser 的控制器方法，并使用 @RequestParam 注解来获取 GET 请求中名为 id 和 name 的参数值。其中，id 参数使用了 defaultValue 参数，如果请求中没有 id 参数，则使用默认值 1001；name 参数使用了 required 参数，如果请求中没有 name 参数，则不会报错，而是将 userName 参数赋值为 null。

小结

本文介绍了在 SpringMVC 中使用 @RequestParam 注解来获取 HTTP 请求参数的方法，并通过示例代码演示了如何获取 GET 和 POST 请求参数，以及如何使用 defaultValue 和 required 参数。掌握了 @RequestParam 注解的使用方法，可以让我们更加方便地处理 HTTP 请求参数，提高代码编写效率。