脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring @RequestMapping 注解

Spring @RequestMapping 注解及使用技巧详解

 更新时间：2025年06月06日 11:28:29   作者：可问 可问春风  
@RequestMapping是Spring MVC 中定义请求映射规则的核心注解,用于将HTTP请求映射到Controller处理方法,下面给大家介绍Spring @RequestMapping 注解及使用技巧,感兴趣的朋友一起看看吧

@RequestMapping 是 Spring MVC 中 定义请求映射规则的核心注解，用于将 HTTP 请求映射到 Controller 处理方法。以下通过场景化解释其功能、参数及使用技巧：

一、核心作用

URL 路径映射
将特定 URL 请求路由到对应的 Controller 方法。

@Controller
@RequestMapping("/user")  // 类级别路径，所有方法路径前添加 /user
public class UserController {
    @RequestMapping("/profile")  // 完整路径：/user/profile
    public String profile() {
        return "user/profile";
    }
}

支持多种HTTP方法
通过 method 参数限定请求方法（GET、POST等）。

@RequestMapping(value = "/create", method = RequestMethod.POST)
public String createUser(User user) {
    userService.save(user);
    return "redirect:/user/list";
}

多请求处理
支持同时响应多个 URL 路径或请求参数。

@RequestMapping(value = {"/list", "/all"}, method = RequestMethod.GET)
public String listUsers(Model model) {
    model.addAttribute("users", userService.findAll());
    return "user/list";
}

二、关键参数说明

参数作用描述示例
value / path指定映射的URL路径（可多路径）@RequestMapping("/api/user")
method限制HTTP请求方法（GET、POST等）method = RequestMethod.PUT
params要求请求必须包含特定参数params = "type=admin" （参数须为 type=admin）
headers限制请求头条件headers = "Content-Type=application/json"
consumes指定处理的请求内容类型（Content-Type）consumes = MediaType.APPLICATION_JSON_VALUE
produces指定响应内容的类型（Accept头匹配）produces = "text/plain;charset=UTF-8"

三、快捷组合注解

Spring 4.3+ 提供简化的HTTP方法注解，替代 method 参数配置：

  • @GetMapping → @RequestMapping(method = GET)
  • @PostMapping → @RequestMapping(method = POST)
  • @PutMapping、@DeleteMapping、@PatchMapping

用法示例：

@RestController
@RequestMapping("/api/v1")
public class UserApiController {
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable Long id) {
        return userService.findById(id);
    }
    @PostMapping("/users")
    public ResponseEntity<?> createUser(@RequestBody User user) {
        userService.save(user);
        return ResponseEntity.created(URI.create("/users/" + user.getId())).build();
    }
}

四、动态路径参数（@PathVariable）

通过 {变量名} 语法捕获 URL 路径中的动态值，搭配 @PathVariable 使用：

@GetMapping("/detail/{userId}/{type}")
public String userDetail(
    @PathVariable("userId") Long id, 
    @PathVariable String type  // 变量名相同可省略参数
) {
    // 示例URL：/user/detail/123/admin
    // id=123, type="admin"
    return "user/detail";
}

五、匹配请求参数（params条件）

要求存在某个参数

@RequestMapping(value = "/search", params = "keyword")
public String searchByKeyword(String keyword) { ... }

参数值匹配指定模式

@GetMapping(value = "/filter", params = "status=active")
public List<User> getActiveUsers() { ... }

六、常见问题与解决

1. 路径冲突问题

  • 问题：多个处理方法映射到同一路径导致冲突。
  • 解决：通过 method 或 params 进一步区分请求。
@GetMapping("/edit")
public String editForm() { ... }
@PostMapping("/edit")
public String saveEdit(User user) { ... }

2. 模糊匹配优先问题

  • 问题：/user/* 和 /user/123 同时存在时，优先匹配更具体的路径。
  • 规则：Spring 优先匹配精确路径，再匹配通配符路径。

七、最佳实践

RESTful 风格设计
使用HTTP方法区分操作：

  • GET → 查询资源
  • POST → 新增资源
  • PUT → 更新完整资源
  • PATCH → 部分更新资源
  • DELETE → 删除资源

显式指定 Content-Type
使用 consumes 和 produces 明确请求与响应格式：

@PostMapping(value = "/create", consumes = "application/json", produces = "application/json")
public User createUserJson(@RequestBody User user) { ... }

推荐使用组合注解
优先用 @GetMapping、@PostMapping，提升代码可读性。

八、其他特性

Ant风格通配符支持：

  • ?: 匹配单个字符
  • *: 匹配任意数量的字符（不包含路径分隔符）
  • **: 跨多级路径匹配（例如 /api/** 匹配 /api/users/123）
@GetMapping("/files/*.txt")  // 匹配 /files/note.txt 或 /files/data.txt
public String handleTextFiles() { ... }

总结

  • 核心定位：@RequestMapping 是定义 HTTP 请求入口的关键注解。
  • 简化开发：通过 组合注解 + PathVariable + 参数条件 实现 RESTful 接口。
  • 注意点：确保路径唯一性，避免冲突；优先使用组合注解提升代码清晰度。

到此这篇关于Spring @RequestMapping 注解及使用技巧详解的文章就介绍到这了,更多相关Spring @RequestMapping 注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • mybatis collection关联查询多个参数方式

    mybatis collection关联查询多个参数方式

    在使用MyBatis进行关联查询时,往往需要根据多个参数进行查询,例如,使用evtId和businessType作为查询条件,同时在resultMap中配置id和businessType1作为结果映射,这种情况下,可以通过<sql>标签定义参数模板,或者使用@Param注解指定参数名称
    2024-10-10
  • Java爬虫范例之使用Htmlunit爬取学校教务网课程表信息

    Java爬虫范例之使用Htmlunit爬取学校教务网课程表信息

    htmlunit 是一款开源的java 页面分析工具，读取页面后，可以有效的使用htmlunit分析页面上的内容。项目可以模拟浏览器运行，被誉为java浏览器的开源实现。今天我们用这款分析工具来爬取学校教务网课程表信息
    2021-11-11
  • Java通过MyBatis框架对MySQL数据进行增删查改的基本方法

    Java通过MyBatis框架对MySQL数据进行增删查改的基本方法

    MyBatis框架由Java的JDBC API进一步封装而来,在操作数据库方面效果拔群,接下来我们就一起来看看Java通过MyBatis框架对MySQL数据进行增删查改的基本方法:
    2016-06-06
  • java策略枚举:消除在项目里大批量使用if-else的优雅姿势

    java策略枚举:消除在项目里大批量使用if-else的优雅姿势

    这篇文章主要给大家介绍了关于Java彻底消灭if-else的8种方案，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧
    2021-06-06
  • java计算机器人的运动范围

    java计算机器人的运动范围

    这篇文章主要为大家详细介绍了java计算机器人运动范围的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-01-01
  • java实现文件重命名功能

    java实现文件重命名功能

    这篇文章主要介绍了java实现文件重命名功能，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2020-03-03
  • 教你利用JAVA实现可以自行关闭服务器的方法

    教你利用JAVA实现可以自行关闭服务器的方法

    今天给大家带来的是关于Java的相关知识,文章围绕着利用JAVA实现可以自行关闭服务器的方法展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • Lucene实现多种高级搜索形式

    Lucene实现多种高级搜索形式

    这篇文章主要介绍了Lucene实现多种高级搜索形式的相关资料,需要的朋友可以参考下
    2017-04-04
  • Java使用正则提取字符串中的内容的详细步骤

    Java使用正则提取字符串中的内容的详细步骤

    这篇文章主要介绍了Java中使用正则表达式提取字符串内容的方法,通过Pattern和Matcher类实现,涵盖编译正则、查找匹配、分组捕获、数字与邮箱提取场景,以及命名分组、非贪婪匹配等技巧,需要的朋友可以参考下
    2025-08-08
  • 基于Springboot+Vue实现的在线答题闯关系统全过程

    基于Springboot+Vue实现的在线答题闯关系统全过程

    这篇文章主要介绍了基于Springboot+Vue实现的在线答题闯关系统的相关资料,文中包括前端Vue.js、后端SpringBoot及MySQL数据库的使用,系统功能涵盖顺序出题、体型练习、随机出题、错题本、收藏题和答题统计等,需要的朋友可以参考下
    2024-12-12

最新评论