Java新手指南：如何在Spring MVC中处理请求参数

小蓝

2023 年 12 月 06 日

106 次浏览

暂无评论

3729字数

Linux 技术杂烩

在Spring MVC中处理请求参数是通过使用各种注解来实现的。以下是在Spring MVC中处理不同类型请求参数的方法。

使用 `@RequestParam`注解

当你想要从查询字符串中获取单个参数值时，你可以使用 @RequestParam注解。例如：

@GetMapping("/search")
public String search(@RequestParam("query") String queryStr) {
    // 使用queryStr参数的值进行操作
    return "results";
}

这里 @RequestParam指明了参数 query应从请求的查询字符串中获取。你也可以使其为可选参数，并提供一个默认值，如下：

@GetMapping("/search")
public String search(@RequestParam(value = "query", required = false, defaultValue = "defaultQuery") String queryStr) {
    // 使用queryStr参数的值进行操作
    return "results";
}

此处，如果查询字符串中不包含 query参数，queryStr将使用默认值 defaultQuery。

利用 `@PathVariable`获取URI模板中的参数

当参数值是通过URL路径传递的，使用 @PathVariable。例如：

@GetMapping("/users/{userId}")
public String getUser(@PathVariable("userId") String userId) {
    // 使用userId进行操作
    return "userProfile";
}

在这个例子中，如果有人访问 /users/123，那么 userId将取值为 123。

使用 `@ModelAttribute`提取表单数据

对于从HTML表单提交的数据，@ModelAttribute注解可以用来自动填充一个模型对象。例如：

@PostMapping("/register")
public String submitRegistration(@ModelAttribute User user) {
    // 使用user对象进行操作，其属性已由表单数据填充
    return "success";
}

假设 User是一个包含属性如 username, password等的Java类，Spring MVC将会自动绑定表单中同名的字段到这些属性上。

解析复杂的请求体 `@RequestBody`

对于处理JSON或XML等复杂数据类型的请求体，你可以使用 @RequestBody注解。该注解用于访问HTTP请求的体部内容，并将其反序列化为Java对象，通常与POST或PUT请求一起使用：

@PostMapping("/api/items")
public ResponseEntity<?> createItem(@RequestBody Item item) {
    // 使用item对象进行操作
    // 返回响应实体
    return new ResponseEntity<>(HttpStatus.CREATED);
}

如果 Item是一个Java类，那么传递到 /api/items的请求体中的JSON将转换为此类的一个实例。

处理请求头 `@RequestHeader`

如果需要从请求头中获取值，可以使用 @RequestHeader注解。

@GetMapping("/demo")
public String demo(@RequestHeader("Host") String host) {
    // 使用请求头中的Host进行操作
    return "Header details";
}

这个例子中，从请求头中提取了Host这个字段的值。

结合 `@RequestMapping`使用

@RequestMapping是一个通用注解，它可以与上述注解连用，用来处理不同类型的请求方式，例如GET、POST、PUT等。比如：

@RequestMapping(value = "/submit", method = RequestMethod.POST)
public String submitForm(@RequestParam("email") String email) {
    // 使用email参数的值进行操作
    return "formSubmitted";
}

这个例子中，定义了一个处理POST请求的方法，它从查询参数中获取 email的值。

参数校验 `@Valid`

在Spring MVC中，还可以很容易地添加参数验证：

@PostMapping("/account")
public String newAccount(@Valid @ModelAttribute Account account, BindingResult result) {
    if (result.hasErrors()) {
        // 如果存在错误，处理错误
        return "accountForm";
    }
    // 创建账户操作
    return "accountCreated";
}

在该例子中，@Valid注解触发 @ModelAttribute注解的对象通过校验注解（如 @NotNull，@Size等）进行验证。

小结

处理Spring MVC中的请求参数是通过控制器方法中的注解来完成的。这些注解包括 @RequestParam, @PathVariable, @ModelAttribute, @RequestBody, @RequestHeader, @Valid, 和 @RequestMapping。使用这些注解可以轻松从HTTP请求中提取所需信息，例如URL参数、表单数据或者JSON请求体，并将其转换成Java对象以供进一步处理。