深入解析Spring MVC中的@RequestParam注解

最新推荐文章于 2024-09-18 15:43:24 发布

t0_54coder

最新推荐文章于 2024-09-18 15:43:24 发布

阅读量851

点赞数 24

文章标签： spring mvc java 编程开发

本文链接：https://blog.csdn.net/m0_62153576/article/details/141504169

版权

在Spring MVC框架中，@RequestParam注解是一个强大的工具，它允许我们将请求中的参数值绑定到控制器方法的参数上。本文将通过具体实例，详细解析@RequestParam的多种使用方式和注意事项。

基本使用

@RequestParam注解的value属性用于指定URL查询参数的名称。例如，以下处理器方法会映射到/employees?dept=IT的请求：

@Controller
@RequestMapping("employees")
public class EmployeeController {
    public String handleEmployeeRequestByDept(@RequestParam("dept") String deptName, Model map) {
        map.addAttribute("msg", "employees request by dept: " + deptName);
        return "my-page";
    }
}

在这个例子中，deptName的值将会是IT。

省略`value`属性

如果@RequestParam注解的value属性被省略，并且目标变量名与参数名相同，那么Spring MVC将自动绑定参数。这要求代码编译时包含调试信息。例如，以下处理器方法会映射到/employees?state=NC的请求：

@Controller
@RequestMapping("employees")
public class EmployeeController {
    public String handleEmployeeRequestByArea(@RequestParam String state, Model map) {
        map.addAttribute("msg", "employees request by area: " + state);
        return "my-page";
    }
}

此时，state参数的值将会是NC。

使用多个`@RequestParam`注解

一个方法可以有任意数量的@RequestParam注解。例如，以下方法会映射到/employees?dept=IT&state=NC的请求：

@Controller
@RequestMapping("employees")
public class EmployeeController {
    public String handleEmployeeRequestByDeptAndState(
        @RequestParam("dept") String deptName,
        @RequestParam("state") String stateCode,
        Model map) {
        map.addAttribute("msg", "employees request by dept and state code: " + deptName + ", " + stateCode);
        return "my-page";
    }
}

使用Map接收多个参数

如果方法参数是Map<String, String>或MultiValueMap<String, String>类型，那么这个Map将会被填充所有查询字符串的名称和值。例如，以下方法会映射到/employees/234/messages?sendBy=mgr&date=20160210的请求：

@Controller
@RequestMapping("employees")
public class EmployeeController {
    @RequestMapping("{id}/messages")
    public String handleEmployeeMessagesRequest(
        @PathVariable("id") String employeeId,
        @RequestParam Map<String, String> queryMap,
        Model model) {
        model.addAttribute("msg", "employee request by id and query map: " + employeeId + ", " + queryMap.toString());
        return "my-page";
    }
}

在这个例子中，employeeId将会是"234"，而queryMap将会是{sendBy=mgr, date=20160210}。

自动类型转换

如果目标方法参数不是String类型，Spring MVC将尝试自动类型转换。所有简单的类型，如int、long、Date等，默认都是支持的。例如，以下方法会映射到/employees/234/paystubsByMonths?months=5的请求：

@Controller
@RequestMapping("employees")
public class EmployeeController {
    @RequestMapping("{id}/paystubsByMonths")
    public String handleRequest4(
        @PathVariable("id") String employeeId,
        @RequestParam("months") int previousMonths,
        Model model) {
        model.addAttribute("employee request by id for paystub for previous months: " + employeeId + ", " + previousMonths);
        return "my-page";
    }
}

`required`属性

required属性定义了参数是否是必需的。默认值为true，这意味着如果请求中缺少参数，将会返回400状态码。我们可以将其设置为false，以在请求中参数不存在时返回null值。例如，以下方法会映射到/employees/234/report?project=mara和/employees/234/report的请求：

@Controller
@RequestMapping("employees")
public class EmployeeController {
    @RequestMapping(value = "{id}/report")
    public String handleEmployeeReportRequest(
        @PathVariable("id") String id,
        @RequestParam(value = "project", required = false) String projectName,
        Model model) {
        model.addAttribute("employee report request by id and project name: " + id + ", " + projectName);
        return "my-page";
    }
}

`defaultValue`属性

defaultValue属性用于在请求参数未提供或值为空时提供默认值。提供默认值隐式地将required设置为false。例如，我们可以为projectName指定一个默认值"kara"：

@RequestParam(value = "project", defaultValue = "kara") String projectName

避免歧义

定义不同的请求参数并不会定义不同的URI路径。例如，以下处理器方法将会引发运行时异常，因为它们具有歧义的映射：

@Controller
@RequestMapping("/employees")
public class EmployeeController {
    public String handleEmployeeRequestByDept(@RequestParam("dept") String deptName, Model map) { /* ... */ }
    public String handleEmployeeRequestByState(@RequestParam("state") String stateCode, Model map) { /* ... */ }
}

避免歧义的方法

如果不可能有不同的路径（从设计角度来看），并且我们没有其他因素可以解决歧义，例如不同的HTTP方法或消费/产生类型，那么一种解决方法是定义不同的@RequestMapping的params。Spring允许我们只指定参数名称而不指定其值，例如：

@RequestMapping(params = "dept")
public String handleEmployeeRequestByDept(/* ... */) { /* ... */ }

@RequestMapping(params = "state")
public String handleEmployeesRequestByArea(@RequestParam String state, Model map) { /* ... */ }

或者，我们可以将不同的方法合并为一个，拥有所有参数，并将required设置为false。或者我们可以使用一个单一的Map注解@RequestParam。然后根据哪些参数值是null，哪些不是，我们可以做出决定。但这不是一个可维护的方法。

示例项目

要测试控制器，可以在MyMvcControllerTest中运行单元测试。或者，您可以使用嵌入式Tomcat运行应用程序：

mvn clean compile tomcat7:run-war

然后尝试以下URL：

http://localhost:8080/spring-mvc-query-param/employees?dept=IT
http://localhost:8080/spring-mvc-query-param/employees?state=NC
http://localhost:8080/spring-mvc-query-param/employees?dept=IT&state=NC
http://localhost:8080/spring-mvc-query-param/employees/234/paystubs?months=5
http://localhost:8080/spring-mvc-query-param/employees/234/paystubs?startDate=2000-10-31&endDate=2000-10-31
http://localhost:8080/spring-mvc-query-param/employees/234/report
http://localhost:8080/spring-mvc-query-param/employees/234/report?project=mara
http://localhost:8080/spring-mvc-query-param/employees/234/messages?sendBy=mgr&date=20160210