从新手到专家：SpringMVC @RequestMapping 注解深入解析

SpringMVC 中的 @RequestMapping 注解：全面指南

摘要

在 SpringMVC 中，@RequestMapping 注解是将请求映射到处理方法的关键工具。了解其属性、使用场景和示例代码对于构建 RESTful Web 应用程序至关重要。

@RequestMapping 注解概述

@RequestMapping 注解用于将请求路径和处理方法关联起来。当请求到达服务器时，SpringMVC 会检查方法上的 @RequestMapping 注解，以确定哪个方法应该处理该请求。

@RequestMapping 注解的属性

@RequestMapping 注解提供了一系列属性，允许开发者定制映射关系：

• value： 请求路径（例如 "/hello"）。
• method： 请求方法（例如 RequestMethod.GET）。
• params： 请求参数（例如 "name=John"）。
• headers： 请求头部信息（例如 "Content-Type=application/json"）。
• consumes： 请求内容类型（例如 "application/json"）。
• produces： 响应内容类型（例如 "text/html"）。

@RequestMapping 注解的使用场景

@RequestMapping 注解可用于处理各种请求：

• 处理 GET 请求： @RequestMapping(method = RequestMethod.GET)
• 处理 POST 请求： @RequestMapping(method = RequestMethod.POST)
• 处理其他请求方法： @RequestMapping(method = RequestMethod.{PUT, DELETE, ...})
• 处理路径参数： @PathVariable("id") Long id
• 处理请求参数： @RequestParam("name") String name
• 处理请求头部信息： @RequestHeader("Content-Type") String contentType
• 处理请求内容类型： @RequestBody MyRequestObject requestObject
• 处理响应内容类型： @ResponseBody

代码示例

@RequestMapping("/hello")
public String hello() {
    return "hello";
}

@RequestMapping(value = "/users", method = RequestMethod.POST)
public User createUser(@RequestBody User user) {
    return userRepository.save(user);
}

结论

@RequestMapping 注解是 SpringMVC 中一个强大的工具，用于将请求映射到处理方法。通过理解其属性、使用场景和示例代码，开发者可以轻松地创建功能强大的 RESTful Web 应用程序。

常见问题解答

• 如何处理多个请求路径？ 使用 @RequestMapping(value = {"/path1", "/path2"})。
• 如何限制特定请求方法？ 使用 @RequestMapping(method = RequestMethod.GET) 或 @RequestMapping(method = {RequestMethod.GET, RequestMethod.POST})。
• 如何处理路径参数？ 使用 @PathVariable("id") Long id。
• 如何设置请求和响应的内容类型？ 使用 @Consumes("application/json") 和 @Produces("text/html")。
• 如何将方法返回值直接输出到响应主体？ 使用 @ResponseBody。