|
此版本仍在开发中，尚未稳定。如需最新的稳定版本，请使用 Spring Framework 7.0.6！ |
映射请求
本节讨论带注解的控制器的请求映射。
@RequestMapping
The @RequestMapping 注解用于将请求映射到控制器方法。它有多种属性可以匹配 URL、HTTP 方法、请求参数、标头和媒体类型。您可以在类级别使用它来表达共享映射，或在方法级别使用它来缩小到特定的端点映射。
还有针对HTTP方法的@RequestMapping的快捷变体：
-
@GetMapping -
@PostMapping -
@PutMapping -
@DeleteMapping -
@PatchMapping
上述注解是自定义注解，它们被提供是因为，可以说，大多数控制器方法应该映射到特定的HTTP方法，而不是使用@RequestMapping，默认情况下，@RequestMapping匹配所有HTTP方法。同时，在类级别仍然需要一个@RequestMapping来表达共享映射。
@RequestMapping 不能与在同一元素（类、接口或方法）上声明的其他 @RequestMapping 注解一起使用。如果在同一个元素上检测到多个 @RequestMapping 注解，将记录一条警告，并且仅第一个映射会被使用。这也适用于组合的 @RequestMapping 注解，例如 @GetMapping、@PostMapping 等。 |
以下示例使用类型和方法级别的映射：
-
Java
-
Kotlin
@RestController
@RequestMapping("/persons")
class PersonController {
@GetMapping("/{id}")
public Person getPerson(@PathVariable Long id) {
// ...
}
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public void add(@RequestBody Person person) {
// ...
}
}@RestController
@RequestMapping("/persons")
class PersonController {
@GetMapping("/{id}")
fun getPerson(@PathVariable id: Long): Person {
// ...
}
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
fun add(@RequestBody person: Person) {
// ...
}
}URI 模式
您可以使用通配符模式和通配符来映射请求：
| 模式 | 描述 | 示例 |
|---|---|---|
|
字面模式 |
|
|
匹配一个字符 |
|
|
匹配路径段中的零个或多个字符 |
|
|
匹配零个或多个路径段 |
|
|
与 |
|
|
匹配正则表达式 |
|
|
与 |
|
捕获的URI变量可以通过@PathVariable访问，如下例所示：
-
Java
-
Kotlin
@GetMapping("/owners/{ownerId}/pets/{petId}")
public Pet findPet(@PathVariable Long ownerId, @PathVariable Long petId) {
// ...
}@GetMapping("/owners/{ownerId}/pets/{petId}")
fun findPet(@PathVariable ownerId: Long, @PathVariable petId: Long): Pet {
// ...
}您可以在类和方法级别声明URI变量，如下例所示：
-
Java
-
Kotlin
@Controller
@RequestMapping("/owners/{ownerId}") (1)
public class OwnerController {
@GetMapping("/pets/{petId}") (2)
public Pet findPet(@PathVariable Long ownerId, @PathVariable Long petId) {
// ...
}
}| 1 | 类级别的URI映射。 |
| 2 | 方法级别的URI映射。 |
@Controller
@RequestMapping("/owners/{ownerId}") (1)
class OwnerController {
@GetMapping("/pets/{petId}") (2)
fun findPet(@PathVariable ownerId: Long, @PathVariable petId: Long): Pet {
// ...
}
}| 1 | 类级别的URI映射。 |
| 2 | 方法级别的URI映射。 |
URI 变量会自动转换为适当的类型，或者抛出 TypeMismatchException。简单类型（int、long、Date 等）默认受支持，并且你可以注册对任何其他数据类型的支持。
请参见 类型转换 和 DataBinder。
URI 变量可以显式命名（例如 @PathVariable("customId")），但如果变量名称相同且您在编译代码时启用了 -parameters 编译器标志，则可以省略此细节。
语法 {*varName} 声明一个匹配零个或多个剩余路径段的URI变量。例如 /resources/{*path} 匹配 /resources/ 下的所有文件，而 "path" 变量捕获 /resources 下的完整路径。
语法{varName:regex}声明了一个具有正则表达式语法的URI变量：{varName:regex}。例如，给定一个URL为/spring-web-3.0.5.jar，以下方法提取名称、版本和文件扩展名：
-
Java
-
Kotlin
@GetMapping("/{name:[a-z-]+}-{version:\\d\\.\\d\\.\\d}{ext:\\.[a-z]+}")
public void handle(@PathVariable String version, @PathVariable String ext) {
// ...
}@GetMapping("/{name:[a-z-]+}-{version:\\d\\.\\d\\.\\d}{ext:\\.[a-z]+}")
fun handle(@PathVariable version: String, @PathVariable ext: String) {
// ...
}URI 路径模式还支持以下内容：
-
嵌入的
${…}占位符，这些占位符在启动时通过PropertySourcesPlaceholderConfigurer针对本地、系统、环境和其他属性源进行解析。例如，这可用于根据外部配置参数化基本URL，非常有用。 -
SpEL表达式
#{…}.
Spring WebFlux 使用 PathPattern 和 PathPatternParser 来支持 URI 路径匹配。
这两个类都位于 spring-web 中，并且专门设计用于在具有大量 URI 路径模式的 Web 应用程序中与 HTTP URL 路径一起使用，这些路径模式在运行时进行匹配。 |
Spring WebFlux 不支持后缀模式匹配——与 Spring MVC 不同，在 Spring MVC 中，像 /person 这样的映射也匹配到 /person.*。对于基于 URL 的内容协商，如果需要，我们建议使用查询参数，这样更简单、更明确，并且不容易受到基于 URL 路径的攻击。
模式比较
当多个模式匹配一个URL时，必须比较它们以找到最佳匹配。这是通过PathPattern.SPECIFICITY_COMPARATOR完成的，它会查找更具体的模式。
对于每个模式，都会根据URI变量和通配符的数量计算一个分数，其中URI变量的得分低于通配符。总分较低的模式胜出。如果两个模式的分数相同，则选择较长的那个。
通用模式（例如，**，{*varName}）被排除在评分之外，并且总是
排在最后。如果有两个模式都是通用模式，则选择较长的那个。
可消耗的媒体类型
您可以根据请求的Content-Type来缩小请求映射，如下例所示：
-
Java
-
Kotlin
@PostMapping(path = "/pets", consumes = "application/json")
public void addPet(@RequestBody Pet pet) {
// ...
}@PostMapping("/pets", consumes = ["application/json"])
fun addPet(@RequestBody pet: Pet) {
// ...
}consumes属性还支持否定表达式——例如，!text/plain表示任何
内容类型，除了text/plain。
您可以在类级别声明一个共享的consumes属性。然而，与其他大多数请求映射属性不同的是，当在类级别使用时，方法级别的consumes属性会覆盖而不是扩展类级别的声明。
MediaType 提供常用媒体类型的常量——例如，APPLICATION_JSON_VALUE 和 APPLICATION_XML_VALUE。 |
可生成的媒体类型
您可以根据Accept请求头和控制器方法生成的内容类型列表来缩小请求映射，如下例所示：
-
Java
-
Kotlin
@GetMapping(path = "/pets/{petId}", produces = "application/json")
@ResponseBody
public Pet getPet(@PathVariable String petId) {
// ...
}@GetMapping("/pets/{petId}", produces = ["application/json"])
@ResponseBody
fun getPet(@PathVariable petId: String): Pet {
// ...
}媒体类型可以指定字符集。支持否定表达式——例如，!text/plain 表示除了 text/plain 之外的任何内容类型。
您可以在类级别声明一个共享的produces属性。然而，与其他大多数请求映射属性不同的是，当在类级别使用时，方法级别的produces属性会覆盖而不是扩展类级别的声明。
MediaType 为常用的媒体类型提供了常量 — 例如，
APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE. |
参数和头部信息
您可以根据查询参数条件缩小请求映射。您可以测试查询参数是否存在（myParam），是否不存在（!myParam），或是否有特定值（myParam=myValue）。以下示例测试具有特定值的参数：
-
Java
-
Kotlin
@GetMapping(path = "/pets/{petId}", params = "myParam=myValue") (1)
public void findPet(@PathVariable String petId) {
// ...
}| 1 | 检查 myParam 是否等于 myValue。 |
@GetMapping("/pets/{petId}", params = ["myParam=myValue"]) (1)
fun findPet(@PathVariable petId: String) {
// ...
}| 1 | 检查 myParam 是否等于 myValue。 |
你也可以在请求头条件中使用相同的方法，如下例所示：
-
Java
-
Kotlin
@GetMapping(path = "/pets/{petId}", headers = "myHeader=myValue") (1)
public void findPet(@PathVariable String petId) {
// ...
}| 1 | 检查 myHeader 是否等于 myValue。 |
@GetMapping("/pets/{petId}", headers = ["myHeader=myValue"]) (1)
fun findPet(@PathVariable petId: String) {
// ...
}| 1 | 检查 myHeader 是否等于 myValue。 |
API 版本
没有标准的方式来指定API版本，因此当您在WebFlux 配置中启用API版本控制时，需要指定如何解析版本。WebFlux 配置会创建一个ApiVersionStrategy，该策略随后用于映射请求。
一旦API版本控制启用，您就可以开始映射带有版本的请求。
version属性支持以下内容：
-
固定版本（"1.2"）— 仅匹配给定的版本
-
基线版本（"1.2+"）— 匹配上述给定和支持的版本支持的版本
-
无值 - 匹配任何版本，但会被更具体的版本匹配所覆盖
如果多个控制器方法的版本号小于或等于请求的版本号， 则会选择其中版本号最高且最接近请求版本的那个方法作为考虑对象， 实际上替代了其他方法。
为了说明这一点，请考虑以下映射：
-
Java
@RestController
@RequestMapping("/account/{id}")
public class AccountController {
@GetMapping (1)
public Account getAccount() {
}
@GetMapping(version = "1.1") (2)
public Account getAccount1_1() {
}
@GetMapping(version = "1.2+") (3)
public Account getAccount1_2() {
}
@GetMapping(version = "1.5") (4)
public Account getAccount1_5() {
}
}| 1 | 匹配任何版本 |
| 2 | 匹配版本 1.1 |
| 3 | 匹配1.2及以上版本 |
| 4 | 匹配版本 1.5 |
对于带有版本号 "1.3" 的请求：
-
(1) 匹配任何版本
-
(2) 不匹配
-
(3) 符合条件，因为它匹配1.2及以上版本，并且作为最高匹配项被选中
-
(4) 版本更高，且不匹配
| 版本1.3必须存在于映射中，或被 配置为受支持。 |
对于带有版本号 "1.5" 的请求：
-
(1) 匹配任何版本
-
(2) 不匹配
-
(3) 符合条件，因为它匹配1.2及以上版本
-
(4) 个匹配项，并被选为最高匹配项
版本为"1.6"的请求没有匹配项。尽管(1)和(3)匹配，但被(4)覆盖，而(4)只允许严格匹配，因此并未匹配。
在这种情况下，使用NotAcceptableApiVersionException会导致返回400响应。
未带有版本号的控制器方法旨在支持在引入版本化替代方法之前创建的客户端。因此，尽管未版本化的控制器方法被认为与任何版本匹配，但实际上其优先级最低，且实际上会被任何带有版本的替代控制器方法所取代。
参见API版本控制以了解更多关于基础架构和对API版本控制的支持的详细信息。
HTTP HEAD, OPTIONS
@GetMapping 和 @RequestMapping(method=HttpMethod.GET) 为请求映射目的透明支持 HTTP HEAD。控制器方法无需更改。
响应包装器应用于 HttpHandler 服务器适配器中，确保设置 Content-Length 标头为已写入的字节数，而无需实际写入响应。
默认情况下，HTTP OPTIONS 通过将 Allow 响应头设置为所有具有匹配 URL 模式的 @RequestMapping 方法中列出的 HTTP 方法列表来处理。
对于一个@RequestMapping没有HTTP方法声明，Allow标头将被设置为GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS。控制器方法应该始终声明支持的HTTP方法（例如，通过使用特定的HTTP方法变体——@GetMapping、@PostMapping等）。
您可以显式地将@RequestMapping方法映射到HTTP HEAD和HTTP OPTIONS，但在常见情况下这不是必要的。
自定义注解
Spring WebFlux 支持使用 组合注解
进行请求映射。这些注解本身被元注解
@RequestMapping 标注，并组合起来重新声明 @RequestMapping
属性的子集（或全部），具有更窄、更特定的目的。
@GetMapping、@PostMapping、@PutMapping、@DeleteMapping 和 @PatchMapping 是组合注解的示例。提供它们的原因是，大多数控制器方法应该映射到特定的 HTTP 方法，而不是使用默认匹配所有 HTTP 方法的 @RequestMapping。如果你需要实现组合注解的示例，可以查看这些注解是如何声明的。
@RequestMapping 不能与在同一元素（类、接口或方法）上声明的其他 @RequestMapping 注解一起使用。如果在同一个元素上检测到多个 @RequestMapping 注解，将记录一条警告，并且仅第一个映射会被使用。这也适用于组合的 @RequestMapping 注解，例如 @GetMapping、@PostMapping 等。 |
Spring WebFlux 还支持带有自定义请求匹配逻辑的自定义请求映射属性。这是一个更高级的选项，需要子类化 RequestMappingHandlerMapping 并重写 getCustomMethodCondition 方法，在这里你可以检查自定义属性并返回你自己的 RequestCondition。
显式注册
您可以编程地注册处理器方法，这些方法可以用于动态注册或高级情况，例如在不同 URL 下注册同一个处理器的不同实例。以下示例展示了如何进行此类操作：
-
Java
-
Kotlin
@Configuration
public class MyConfig {
@Autowired
public void setHandlerMapping(RequestMappingHandlerMapping mapping, UserHandler handler) (1)
throws NoSuchMethodException {
RequestMappingInfo info = RequestMappingInfo
.paths("/user/{id}").methods(RequestMethod.GET).build(); (2)
Method method = UserHandler.class.getMethod("getUser", Long.class); (3)
mapping.registerMapping(info, handler, method); (4)
}
}| 1 | 注入目标处理器和控制器的处理器映射。 |
| 2 | 准备请求映射元数据。 |
| 3 | 获取处理器方法。 |
| 4 | 添加注册。 |
@Configuration
class MyConfig {
@Autowired
fun setHandlerMapping(mapping: RequestMappingHandlerMapping, handler: UserHandler) { (1)
val info = RequestMappingInfo.paths("/user/{id}").methods(RequestMethod.GET).build() (2)
val method = UserHandler::class.java.getMethod("getUser", Long::class.java) (3)
mapping.registerMapping(info, handler, method) (4)
}
}| 1 | 注入目标处理器和控制器的处理器映射。 |
| 2 | 准备请求映射元数据。 |
| 3 | 获取处理器方法。 |
| 4 | 添加注册。 |
@HttpExchange
主要用途虽然在于@HttpExchange作为带有生成代理的HTTP服务
客户端,
但承载此类注解的HTTP服务接口是独立于客户端与服务器使用的合同。除了简化客户端代码外，还存在一些情况
下，HTTP服务接口可能是服务器为客户端访问暴露其API的一种便捷方式。这导致客户端与服务器之间耦合度增加
，通常不是一个好的选择，特别是对于公共API，但对于内部API而言，这可能正是目标所在。这是Spring Cloud中常用的
一种方法，也是为什么在控制器类中支持使用@HttpExchange作为@RequestMapping的替代方案进行服务器端处理的原因。
例如：
-
Java
-
Kotlin
@HttpExchange("/persons")
interface PersonService {
@GetExchange("/{id}")
Person getPerson(@PathVariable Long id);
@PostExchange
void add(@RequestBody Person person);
}
@RestController
class PersonController implements PersonService {
public Person getPerson(@PathVariable Long id) {
// ...
}
@ResponseStatus(HttpStatus.CREATED)
public void add(@RequestBody Person person) {
// ...
}
}@HttpExchange("/persons")
interface PersonService {
@GetExchange("/{id}")
fun getPerson(@PathVariable id: Long): Person
@PostExchange
fun add(@RequestBody person: Person)
}
@RestController
class PersonController : PersonService {
override fun getPerson(@PathVariable id: Long): Person {
// ...
}
@ResponseStatus(HttpStatus.CREATED)
override fun add(@RequestBody person: Person) {
// ...
}
}@HttpExchange 和 @RequestMapping 存在差异。
@RequestMapping 可以通过路径模式、HTTP 方法等映射到任意数量的请求，而 @HttpExchange 则声明了一个具有具体 HTTP 方法、路径和内容类型的单一端点。
对于方法参数和返回值，通常情况下，@HttpExchange 支持 @RequestMapping 所支持的方法参数的一个子集。值得注意的是，它排除了任何特定于服务器端的参数类型。详细信息，请参见
@HttpExchange 和
@RequestMapping 的列表。