深入浅出 SpringMVC @RequestMapping 注解用法解析

SpringMVC 中 @RequestMapping 注解简介

在 SpringMVC 框架中，@RequestMapping 注解是一种常用的注解，它用于将 HTTP 请求映射到特定的控制器方法。通过使用 @RequestMapping 注解，我们可以简化请求处理过程，实现更清晰、更可维护的代码。

@RequestMapping 注解语法结构

@RequestMapping(value = "/mapping-path", method = RequestMethod.METHOD)

其中：

• value： 指定请求映射路径，支持 URI 模板（后面会详细介绍）。
• method： 指定请求方法，默认为 GET。

类和方法上的 @RequestMapping 注解

修饰类

当 @RequestMapping 注解修饰类时，表示该类中所有方法都映射到指定路径。例如：

@RequestMapping("/user")
public class UserController {
    // 省略 UserController 中的方法
}

这表示 UserController 中所有方法都将映射到 /user 路径下。

修饰方法

当 @RequestMapping 注解修饰方法时，表示该方法映射到指定路径和请求方法。例如：

@RequestMapping(value = "/user/create", method = RequestMethod.POST)
public String createUser() {
    // 省略 createUser 方法的代码
}

这表示 createUser 方法将映射到 /user/create 路径下，并且只处理 POST 请求。

URI 模板

URI 模板是一种强大的功能，它允许我们使用占位符定义动态的请求路径。例如：

@RequestMapping("/user/{id}")
public String getUser(@PathVariable("id") Long id) {
    // 省略 getUser 方法的代码
}

在这个示例中，{id} 是一个占位符，表示用户 ID。当请求到达 /user/123 时，方法参数 id 将自动绑定为 123。

方法映射

@RequestMapping 注解还可以用于方法映射，即根据请求中的参数值动态选择要执行的方法。例如：

@RequestMapping(value = "/user", params = "action=create")
public String createUser() {
    // 省略 createUser 方法的代码
}

这表示当请求包含参数 action=create 时，将执行 createUser 方法。

更多用法

除了上述用法外，@RequestMapping 注解还支持许多其他特性，包括：

• consumes： 指定请求内容类型。
• produces： 指定响应内容类型。
• headers： 指定请求头条件。
• params： 指定请求参数条件。

这些特性为更加精细的请求映射提供了灵活性。

总结

@RequestMapping 注解是 SpringMVC 中一个非常重要的注解，它极大地简化了 HTTP 请求的映射和处理过程。通过理解其语法结构、用法以及其他特性，我们可以高效地构建 RESTful API 或其他 Web 服务。