Spring Web MVC 获取请求参数-CFANZ编程社区

Spring Web MVC 获取请求参数详解

Spring Web MVC 是 Spring 框架中用于构建 Web 应用程序的强大模块，它提供了多种灵活的方式来获取客户端发送的请求参数。本文将详细介绍在 Spring Web MVC 中获取请求参数的各种方法，包括基本方式、高级特性以及最佳实践。

一、基本参数获取方式

通过方法参数直接绑定

Spring MVC 最简单直接的参数获取方式是通过控制器方法的参数直接绑定请求参数： @GetMapping("/user") public String getUser(@RequestParam String name, @RequestParam int age) { // 使用name和age参数 return "User: " + name + ", Age: " + age; }

• @RequestParam 注解用于将请求参数绑定到方法参数

• 请求参数名与方法参数名相同时，可以省略 value 或 name 属性

• 支持基本数据类型及其包装类、String 等

通过 HttpServletRequest 获取

传统的 Servlet API 方式： @GetMapping("/user") public String getUser(HttpServletRequest request) { String name = request.getParameter("name"); String ageStr = request.getParameter("age"); int age = Integer.parseInt(ageStr); return "User: " + name + ", Age: " + age; }

这种方式虽然直接，但不如注解方式简洁，且需要手动处理类型转换。

二、常用参数绑定注解

@RequestParam

用于绑定单个请求参数： @GetMapping("/search") public String search(@RequestParam String keyword, @RequestParam(defaultValue = "1") int page, @RequestParam(required = false) String category) { // 搜索逻辑 }

• required 属性：是否为必需参数（默认 true）

• defaultValue 属性：当参数不存在时的默认值

@PathVariable

用于绑定 URL 路径中的变量： @GetMapping("/user/{id}") public String getUser(@PathVariable Long id) { // 根据id获取用户 return "User ID: " + id; }

• 常用于 RESTful 风格的 URL 设计

• 支持路径中的多个变量

@RequestBody

用于绑定请求体中的 JSON 或 XML 数据（通常用于 POST/PUT 请求）： @PostMapping("/user") public ResponseEntity createUser(@RequestBody User user) { // 处理用户对象 return ResponseEntity.ok("User created"); }

• 要求请求 Content-Type 为 application/json 或 application/xml

• 需要对应的 Java 类（如 User）来映射 JSON 结构

@ModelAttribute

用于绑定表单数据到对象： @PostMapping("/user") public String submitForm(@ModelAttribute User user) { // 处理用户表单数据 return "success"; }

• 自动将表单字段映射到对象的属性

• 也可以用于 GET 请求获取模型属性

@RequestHeader

用于绑定请求头信息： @GetMapping("/info") public String getInfo(@RequestHeader("User-Agent") String userAgent, @RequestHeader(value = "Accept-Language", required = false) String acceptLanguage) { // 使用请求头信息 return "User-Agent: " + userAgent; }

@CookieValue

用于绑定 Cookie 值： @GetMapping("/profile") public String getProfile(@CookieValue("JSESSIONID") String sessionId) { // 使用cookie值 return "Session ID: " + sessionId; }

三、复杂参数绑定

绑定到自定义对象

Spring MVC 可以自动将请求参数绑定到自定义 Java 对象： @PostMapping("/user") public String createUser(User user) { // User类应包含与请求参数同名的属性 return "User created: " + user.getName(); }

请求参数如 name=John&age=30 会自动映射到 User 对象的 name 和 age 属性。

绑定嵌套对象

支持绑定嵌套的对象结构： public class Address { private String city; private String street; // getters and setters }

public class User { private String name; private Address address; // getters and setters }

@PostMapping("/user") public String createUser(User user) { // 可以接收如 name=John&address.city=Beijing&address.street=Main 的参数 return "User created"; }

绑定集合和数组

可以绑定请求参数到集合或数组： @PostMapping("/users") public String createUsers(@RequestParam("ids") List ids) { // 接收如 ids=1&ids=2&ids=3 的参数 return "Processed " + ids.size() + " users"; }

@PostMapping("/users") public String createUsers(@RequestParam("ids") Long[] ids) { // 也可以使用数组 return "Processed " + ids.length + " users"; }

对于对象集合： @PostMapping("/users") public String createUsers(@ModelAttribute("userForm") UserForm userForm) { // UserForm包含List users属性 return "Processed " + userForm.getUsers().size() + " users"; }

四、高级参数获取方式

使用 Servlet API 其他组件

除了 HttpServletRequest，还可以注入其他 Servlet API 组件： @GetMapping("/info") public String getInfo(HttpSession session, Principal principal) { // 使用session和principal return "Session: " + session.getId() + ", User: " + principal.getName(); }

自定义参数解析器

对于特殊需求，可以实现 HandlerMethodArgumentResolver 接口创建自定义参数解析器： public class CurrentUserMethodArgumentResolver implements HandlerMethodArgumentResolver {

@Override
public boolean supportsParameter(MethodParameter parameter) {
    return parameter.getParameterType().equals(CurrentUser.class);
}

@Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
        NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
    // 自定义解析逻辑，如从安全上下文中获取当前用户
    return new CurrentUser("currentUserId", "currentUserEmail");
}

}

然后注册解析器： @Configuration public class WebConfig implements WebMvcConfigurer {

@Override
public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
    resolvers.add(new CurrentUserMethodArgumentResolver());
}

}

使用自定义参数： @GetMapping("/profile") public String profile(CurrentUser currentUser) { return "Profile of " + currentUser.getEmail(); }

使用 @MatrixVariable (矩阵参数)

处理 URL 中的矩阵参数（如 /cars;color=red,green;year=2019）： @GetMapping("/cars") public String getCars(@MatrixVariable(pathVar = "color") List colors, @MatrixVariable(pathVar = "year") int year) { // 处理矩阵参数 return "Colors: " + colors + ", Year: " + year; }

需要在配置中启用矩阵变量支持： @Configuration public class WebConfig implements WebMvcConfigurer {

@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    UrlPathHelper urlPathHelper = new UrlPathHelper();
    urlPathHelper.setRemoveSemicolonContent(false);
    configurer.setUrlPathHelper(urlPathHelper);
}

}

五、参数验证

Spring MVC 支持使用 Bean Validation (JSR-380) 对参数进行验证： @PostMapping("/user") public String createUser(@Valid @RequestBody User user, BindingResult result) { if (result.hasErrors()) { // 处理验证错误 return "Validation errors"; } return "User created"; }

User 类中定义验证规则： public class User { @NotBlank(message = "Name is required") private String name;

@Min(value = 1, message = "Age must be at least 1")
@Max(value = 120, message = "Age must be at most 120")
private int age;

@Email(message = "Email should be valid")
private String email;
// getters and setters

}

需要添加依赖（如 Hibernate Validator）： org.hibernate.validator hibernate-validator

六、最佳实践