了解 Spring RequestMapping

2024-06-23 15:48
文章标签 java spring 了解 requestmapping

本文主要是介绍了解 Spring RequestMapping，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1. 概述

 

这篇文章会集中讨论 Spring MVC 的一个重要注解 @RequestMapping。

 

简要地说，该注解用于把 Web 请求映射到 Spring Controller 方法。

 

2. @RequestMapping 基础

 

先从一个简单的示例开始：通过设置基本条件把 HTTP 请求映射到某个方法。

 

2.1. 路径映射

 

@RequestMapping(value = "/ex/foos", method = RequestMethod.GET)
@ResponseBody
public String getFoosBySimplePath() {return "Get some Foos";
}

 

使用 curl 命令测试：

 

curl -i http://localhost:8080/spring-rest/ex/foos

 

2.2. HTTP 方法映射

 

HTTP 方法参数没有缺省值，如果不设参数值，请求会映射到所有 HTTP 请求。

 

下面的示例中，映射的是 HTTP POST 请求：

 

@RequestMapping(value = "/ex/foos", method = POST)
@ResponseBody
public String postFoos() {return "Post some Foos";
}

 

通过 curl 命令测试 POST 请求：

 

curl -i -X POST http://localhost:8080/spring-rest/ex/foos

 

3. 根据 HTTP Header 映射

 

3.1. 指定 Header 属性

 

通过为请求指定一个 header 进一步缩小映射：

 

@RequestMapping(value = "/ex/foos", headers = "key=val", method = GET)
@ResponseBody
public String getFoosWithHeader() {return "Get some Foos with Header";
}

 

使用 curl 命令带 header 测试：

 

curl -i -H "key:val" http://localhost:8080/spring-rest/ex/foos

 

还可以 @RequestMapping 的 headers 属性设置多个 header：

 

@RequestMapping(value = "/ex/foos",headers = { "key1=val1", "key2=val2" }, method = GET)
@ResponseBody
public String getFoosWithHeaders() {return "Get some Foos with Header";
}

 

使用以下命令测试：

 

curl -i -H "key1:val1" -H "key2:val2" http://localhost:8080/spring-rest/ex/foos

 

注意：curl 分隔 key 和 value 的语法是冒号与 HTTP 规范相同，而 Spring 中使用的是等号。

 

3.2. consume 与 produce 属性

 

对 Controller 媒体类型映射时需要特别注意：使用 @RequestMapping headers 还可以处理 Accept header：

 

@RequestMapping(value = "/ex/foos",method = GET,headers = "Accept=application/json")
@ResponseBody
public String getFoosAsJsonFromBrowser() {return "Get some Foos with Header Old";
}

 

定义 Accept Header 的匹配方式非常灵活。不仅支持 = 精确匹配，也支持多条件匹配，像下面这样：

 

curl -H "Accept:application/json,text/html"http://localhost:8080/spring-rest/ex/foos

 

自 Spring 3.1 开始，@RequestMapping 注解已支持 produce 和 consume 属性，适用以下的场景：

 

@RequestMapping(value = "/ex/foos",method = RequestMethod.GET,produces = "application/json"
)
@ResponseBody
public String getFoosAsJsonFromREST() {return "Get some Foos with Header New";
}

 

同时，header 映射会自动转换为新的 produces 机制，执行的效果相同。

 

使用 curl 命令测试：

 

curl -H "Accept:application/json"http://localhost:8080/spring-rest/ex/foos

 

此外，produces 也支持多个参数：

 

@RequestMapping(value = "/ex/foos",method = GET,produces = { "application/json", "application/xml" }
)

 

请注意：Spring 不支持同时用新旧两种方法指定 accept header，否则会抛出异常：

 

Caused by: java.lang.IllegalStateException: Ambiguous mapping found.
Cannot map 'fooController' bean method
java.lang.String
org.baeldung.spring.web.controller.FooController.getFoosAsJsonFromREST()
to
{ [/ex/foos],methods=[GET],params=[],headers=[],consumes=[],produces=[application/json],custom=[]
}:
There is already 'fooController' bean method
java.lang.String
org.baeldung.spring.web.controller.FooController.getFoosAsJsonFromBrowser()
mapped.

 

最后需要说明一点：produces 和 consumes 与其它注解的行为不同，方法级注解只覆盖不增加。

 

4. Path 变量

 

通过 @PathVariable 注解可以绑定 URI 变量。

 

4.1. @PathVariable 单个变量

 

单个变量使用示例：

 

@RequestMapping(value = "/ex/foos/{id}", method = GET)
@ResponseBody
public String getFoosBySimplePathWithPathVariable(@PathVariable("id") long id) {return "Get a specific Foo with id=" + id;
}

 

使用 curl 测试：

 

curl http://localhost:8080/spring-rest/ex/foos/1

 

如果方法的参数名与路径变量名完全匹配，可以直接使用@PathVariable 不带参数：

 

@RequestMapping(value = "/ex/foos/{id}", method = GET)
@ResponseBody
public String getFoosBySimplePathWithPathVariable(@PathVariable String id) {return "Get a specific Foo with id=" + id;
}

 

注意：@PathVariable 支持自动类型转换，id 还可以声明为：

 

@PathVariable long id

 

4.2. @PathVariable 多个变量

 

复杂 URI 可以把多个部分映射为多个 value：

 

@RequestMapping(value = "/ex/foos/{fooid}/bar/{barid}", method = GET)
@ResponseBody
public String getFoosBySimplePathWithPathVariables(@PathVariable long fooid, @PathVariable long barid) {return "Get a specific Bar with id=" + barid +" from a Foo with id=" + fooid;
}

 

同样可以使用 curl 测试：

 

curl http://localhost:8080/spring-rest/ex/foos/1/bar/2

 

4.3. @PathVariable 正则表达式

 

@PathVariable 支持正则表达式，比如用正则限制 id 只允许数值输入：

 

@RequestMapping(value = "/ex/bars/{numericId:[\\d]+}", method = GET)
@ResponseBody
public String getBarsBySimplePathWithPathVariable(@PathVariable long numericId) {return "Get a specific Bar with id=" + numericId;
}

 

下面 URI 可以匹配：

 

http://localhost:8080/spring-rest/ex/bars/1

 

下面 URI 不能匹配：

 

http://localhost:8080/spring-rest/ex/bars/abc

 

5. Request Parameters

 

@RequestMapping 通过 @RequestParam 注解可以对 URL 参数进行映射。

 

比如下面这个 URI：

 

http://localhost:8080/spring-rest/ex/bars?id=100

 

Java 代码：

 

@RequestMapping(value = "/ex/bars", method = GET)
@ResponseBody
public String getBarBySimplePathWithRequestParam(@RequestParam("id") long id) {return "Get a specific Bar with id=" + id;
}

 

然后，为 Controller 方法加上 @RequestParam("id") 注解提取 id 参数值。

 

使用 curl 命令发送带 id 请求：

 

curl -i -d id=100 http://localhost:8080/spring-rest/ex/bars

 

在上面的例子中，参数直接绑定，没有提前声明。

 

@RequestMapping 可以根据需要有选择地定义参数 减少请求映射：

 

@RequestMapping(value = "/ex/bars", params = "id", method = GET)
@ResponseBody
public String getBarBySimplePathWithExplicitRequestParam(@RequestParam("id") long id) {return "Get a specific Bar with id=" + id;
}

 

还支持更灵活的映射，设置多个 params 值，不需要全部映射：

 

@RequestMapping(value = "/ex/bars", params = "id", method = GET)
@ResponseBody
public String getBarBySimplePathWithExplicitRequestParam(@RequestParam("id") long id) {return "Get a specific Bar with id=" + id;
}

 

还可以设置多个 params 值，只使用其中一部分：

 

@RequestMapping(value = "/ex/bars",params = { "id", "second" },method = GET)
@ResponseBody
public String getBarBySimplePathWithExplicitRequestParams(@RequestParam("id") long id) {return "Narrow Get a specific Bar with id=" + id;
}

 

下面这个 URI：

 

http://localhost:8080/spring-rest/ex/bars?id=100&second=something

 

总能找到最佳的映射匹配（窄匹配），即同时定义了 id 和 second。

 

6. 边界案例

 

6.1. 多个 Path 映射到同一个 Controller 方法

 

虽然 @RequestMapping Path 通常与 Controller 方法一一对应，但这只是最佳实践而非硬性规定。某些情况需要把多个请求映射到同一个方法。这种情况下，@RequestMappingvalue 会包含多个映射：

 

@RequestMapping(value = { "/ex/advanced/bars", "/ex/advanced/foos" },method = GET)
@ResponseBody
public String getFoosOrBarsByPath() {return "Advanced - Get some Foos or Bars";
}

 

下面两个 curl 命令会命中相同的方法：

 

curl -i http://localhost:8080/spring-rest/ex/advanced/foos
curl -i http://localhost:8080/spring-rest/ex/advanced/bars

 

6.2. 多个 HTTP 请求映射到同一个 Controller 方法

 

可以把不同的 HTTP 请求映射到同一个 Controller 方法：

 

@RequestMapping(value = "*", method = RequestMethod.GET)
@ResponseBody
public String getFallback() {return "Fallback for GET Requests";
}

 

甚至可以处理所有请求：

 

@RequestMapping(value = "*",method = { RequestMethod.GET, RequestMethod.POST ... })
@ResponseBody
public String allFallback() {return "Fallback for All Requests";
}

 

6.4. 映射模糊错误

 

对于不同的 Controller 方法，Spring 会根据 HTTP 方法、URL、参数、Header 和媒体类型计算请求映射，如果结果相同会报告模糊映射错误。下面是一个映射模糊案例：

 

@GetMapping(value = "foos/duplicate")
public String duplicate() {return "Duplicate";
}
@GetMapping(value = "foos/duplicate")
public String duplicateEx() {return "Duplicate";
}

 

抛出的异常包含以下错误信息：

 

Caused by: java.lang.IllegalStateException: Ambiguous mapping.Cannot map 'fooMappingExamplesController' methodpublic java.lang.String org.baeldung.web.controller.FooMappingExamplesController.duplicateEx()to {[/ex/foos/duplicate],methods=[GET]}:There is already 'fooMappingExamplesController' bean methodpublic java.lang.String org.baeldung.web.controller.FooMappingExamplesController.duplicate() mapped.

 

 

上面的报错信息可以看到，Spring 无法映射 org.baeldung.web.controller.FooMappingExamplesController.duplicateEx()，因为已经与 org.baeldung.web.controller.FooMappingExamplesController.duplicate() 发生了冲突。

 

下面这两个方法返回的内容类型不同，就不会发生映射模糊错误：

 

@GetMapping(value = "foos/duplicate", produces = MediaType.APPLICATION_XML_VALUE)
public String duplicate() {return "Duplicate";
}
@GetMapping(value = "foos/duplicate", produces = MediaType.APPLICATION_JSON_VALUE)
public String duplicateEx() {return "Duplicate";
}

 

要解决上面例子中的问题，最简单的方法修改其中一个 URL。

 

7. 快速映射

 

Spring Framework 4.3 加入了一些 HTTP 映射新注解：

 

  • @GetMapping

  • @PostMapping

  • @PutMapping

  • @DeleteMapping

  • @PatchMapping

 

提高了代码的可读性，代码得到精简。下同是一个数据库 CRUD 操作 RESTful API 示例：

 

@GetMapping("/{id}")
public ResponseEntity<?> getBazz(@PathVariable String id){return new ResponseEntity<>(new Bazz(id, "Bazz"+id), HttpStatus.OK);
}
@PostMapping
public ResponseEntity<?> newBazz(@RequestParam("name") String name){return new ResponseEntity<>(new Bazz("5", name), HttpStatus.OK);
}
@PutMapping("/{id}")
public ResponseEntity<?> updateBazz(@PathVariable String id,@RequestParam("name") String name) {return new ResponseEntity<>(new Bazz(id, name), HttpStatus.OK);
}
@DeleteMapping("/{id}")
public ResponseEntity<?> deleteBazz(@PathVariable String id){return new ResponseEntity<>(new Bazz(id), HttpStatus.OK);
}

 

8. Spring Configuration

 

Spring MVC 配置非常简单，FooController 定义如下：

 

package org.baeldung.spring.web.controller;
@Controller
public class FooController { ... }

 

加上 @Configuration 就能启用 MVC并把 Controller 加到 classpath 搜索路径：

 

@Configuration
@EnableWebMvc
@ComponentScan({ "org.baeldung.spring.web.controller" })
public class MvcConfig {//
}

 

9. 总结

 

本文详细讨论了 Spring @RequestMapping 注解，包括基础用例、HTTP header 映射、@PathVariable 和 @RequestParam 示例。

 

想了解 Spring MVC 中另一个核心注解 @ModelAttribute 。

 

本文的完整代码可以在 Github 上找到。

github.com/eugenp/tutorials/tree/master/spring-rest-simple

这篇关于了解 Spring RequestMapping的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1087595。

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Java中Redisson 的原理深度解析

Java中Redisson 的原理深度解析

《Java中Redisson的原理深度解析》Redisson是一个高性能的Redis客户端,它通过将Redis数据结构映射为Java对象和分布式对象,实现了在Java应用中方便地使用Redis,本文... 目录前言一、核心设计理念二、核心架构与通信层1. 基于 Netty 的异步非阻塞通信2. 编解码器三、
阅读更多...
SpringBoot基于注解实现数据库字段回填的完整方案

SpringBoot基于注解实现数据库字段回填的完整方案

《SpringBoot基于注解实现数据库字段回填的完整方案》这篇文章主要为大家详细介绍了SpringBoot如何基于注解实现数据库字段回填的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解... 目录数据库表pom.XMLRelationFieldRelationFieldMapping基础的一些代
阅读更多...
一篇文章彻底搞懂macOS如何决定java环境

一篇文章彻底搞懂macOS如何决定java环境

《一篇文章彻底搞懂macOS如何决定java环境》MacOS作为一个功能强大的操作系统,为开发者提供了丰富的开发工具和框架,下面：本文主要介绍macOS如何决定java环境的相关资料,文中通过代码... 目录方法一：使用 which命令方法二：使用 Java_home工具（Apple 官方推荐）那问题来了，
阅读更多...
Java HashMap的底层实现原理深度解析

Java HashMap的底层实现原理深度解析

《JavaHashMap的底层实现原理深度解析》HashMap基于数组+链表+红黑树结构,通过哈希算法和扩容机制优化性能,负载因子与树化阈值平衡效率,是Java开发必备的高效数据结构,本文给大家介绍... 目录一、概述：HashMap的宏观结构二、核心数据结构解析1. 数组（桶数组）2. 链表节点（Node
阅读更多...
Java AOP面向切面编程的概念和实现方式

Java AOP面向切面编程的概念和实现方式

《JavaAOP面向切面编程的概念和实现方式》AOP是面向切面编程,通过动态代理将横切关注点（如日志、事务）与核心业务逻辑分离,提升代码复用性和可维护性,本文给大家介绍JavaAOP面向切面编程的概... 目录一、AOP 是什么？二、AOP 的核心概念与实现方式核心概念实现方式三、Spring AOP 的关
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
Java中的.close()举例详解

Java中的.close()举例详解

《Java中的.close()举例详解》.close()方法只适用于通过window.open()打开的弹出窗口,对于浏览器的主窗口,如果没有得到用户允许是不能关闭的,：本文主要介绍Java中的.... 目录当你遇到以下三种情况时，一定要记得使用 .close()：用法作用举例如何判断代码中的 input
阅读更多...
Spring Gateway动态路由实现方案

Spring Gateway动态路由实现方案

《SpringGateway动态路由实现方案》本文主要介绍了SpringGateway动态路由实现方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随... 目录前沿何为路由RouteDefinitionRouteLocator工作流程动态路由实现尾巴前沿S
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2