映射请求

查看 Servlet 栈中的对应内容

本节讨论注解控制器的请求映射。

@RequestMapping

查看 Servlet 栈中的对应内容

@RequestMapping 注解用于将请求映射到控制器方法。它有各种属性，可以根据 URL、HTTP 方法、请求参数、请求头和媒体类型进行匹配。您可以在类级别使用它来表达共享映射，或者在方法级别使用它来细化到特定的端点映射。

还有针对特定 HTTP 方法的 @RequestMapping 快捷变体：

  • @GetMapping

  • @PostMapping

  • @PutMapping

  • @DeleteMapping

  • @PatchMapping

前面的注解是 自定义注解，提供它们是因为，可以说，大多数控制器方法应该映射到特定的 HTTP 方法，而不是使用默认匹配所有 HTTP 方法的 @RequestMapping。同时，在类级别仍然需要 @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 模式

查看 Servlet 栈中的对应内容

您可以使用 glob 模式和通配符映射请求：

模式 描述 示例

?

匹配一个字符

"/pages/t?st.html" 匹配 "/pages/test.html" 和 "/pages/t3st.html"

*

匹配路径段内的零个或多个字符

"/resources/*.png" 匹配 "/resources/file.png"

"/projects/*/versions" 匹配 "/projects/spring/versions" 但不匹配 "/projects/spring/boot/versions"

**

匹配路径末尾的零个或多个路径段

"/resources/**" 匹配 "/resources/file.png" 和 "/resources/images/file.png"

"/resources/**/file.png" 是无效的，因为 ** 只允许在路径的末尾。

{name}

匹配一个路径段并将其捕获为名为 "name" 的变量

"/projects/{project}/versions" 匹配 "/projects/spring/versions" 并捕获 project=spring

{name:[a-z]}+

将正则表达式 "[a-z]"+ 匹配为名为 "name" 的路径变量

"/projects/{project:[a-z]}/versions"` 匹配 `"/projects/spring/versions"` 但不匹配 `"/projects/spring1/versions"`

{*path}

匹配路径末尾的零个或多个路径段，并将其捕获为名为 "path" 的变量

"/resources/{*file}" 匹配 "/resources/images/file.png" 并捕获 file=/images/file.png

捕获的 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。

Spring WebFlux 使用 PathPattern 和 PathPatternParser 支持 URI 路径匹配。这两个类都位于 spring-web 中，并且专门设计用于匹配 Web 应用中大量 URI 路径模式的 HTTP URL 路径。

Spring WebFlux 不支持后缀模式匹配——这与 Spring MVC 不同，在 Spring MVC 中，/person 这样的映射也匹配 /person.*。对于基于 URL 的内容协商，如果需要，我们建议使用查询参数，它更简单、更明确，并且更不容易受到基于 URL 路径的攻击。

模式比较

查看 Servlet 栈中的对应内容

当多个模式匹配同一个 URL 时，必须对它们进行比较以找到最佳匹配。这是通过 PathPattern.SPECIFICITY_COMPARATOR 完成的，它寻找更具体的模式。

对于每个模式，都会根据 URI 变量和通配符的数量计算一个分数，其中 URI 变量的分数低于通配符。总分较低的模式获胜。如果两个模式的分数相同，则选择较长的那个。

全匹配模式（例如 **、{*varName}）不参与评分，并且总是排在最后。如果两个模式都是全匹配模式，则选择较长的那个。

可消费媒体类型

查看 Servlet 栈中的对应内容

您可以根据请求的 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。

可生成媒体类型

查看 Servlet 栈中的对应内容

您可以根据 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。

参数和请求头

查看 Servlet 栈中的对应内容

您可以根据查询参数条件细化请求映射。您可以测试查询参数是否存在（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。

HTTP HEAD, OPTIONS

查看 Servlet 栈中的对应内容

@GetMapping 和 @RequestMapping(method=HttpMethod.GET) 透明地支持 HTTP HEAD，用于请求映射目的。控制器方法无需更改。在 HttpHandler 服务器适配器中应用的响应包装器确保将 Content-Length 头设置为写入的字节数，而无需实际写入响应。

默认情况下，HTTP OPTIONS 通过将 Allow 响应头设置为所有匹配 URL 模式的 @RequestMapping 方法中列出的 HTTP 方法列表来处理。

对于没有声明 HTTP 方法的 @RequestMapping，Allow 头会设置为 GET,HEAD,POST,PUT,PATCH,DELETE,OPTIONS。控制器方法应始终声明支持的 HTTP 方法（例如，通过使用特定 HTTP 方法的变体——@GetMapping、@PostMapping 等）。

您可以显式地将 @RequestMapping 方法映射到 HTTP HEAD 和 HTTP OPTIONS，但在一般情况下没有必要。

自定义注解

查看 Servlet 栈中的对应内容

Spring WebFlux 支持将 组合注解 用于请求映射。这些注解本身用 @RequestMapping 元注解标注，并通过组合重新声明 @RequestMapping 的部分（或全部）属性，以达到更窄、更具体的目的。

@GetMapping、@PostMapping、@PutMapping、@DeleteMapping 和 @PatchMapping 是组合注解的示例。提供它们是因为，可以说，大多数控制器方法应该映射到特定的 HTTP 方法，而不是使用默认匹配所有 HTTP 方法的 @RequestMapping。如果您需要如何实现组合注解的示例，请查看它们的声明方式。

@RequestMapping 不能与声明在同一元素（类、接口或方法）上的其他 @RequestMapping 注解一起使用。如果在同一元素上检测到多个 @RequestMapping 注解，将会记录警告，并且只使用第一个映射。这也适用于组合的 @RequestMapping 注解，例如 @GetMapping、@PostMapping 等。

Spring WebFlux 还支持具有自定义请求匹配逻辑的自定义请求映射属性。这是一个更高级的选项，需要子类化 RequestMappingHandlerMapping 并覆盖 getCustomMethodCondition 方法，在该方法中您可以检查自定义属性并返回您自己的 RequestCondition。

显式注册

查看 Servlet 栈中的对应内容

您可以程序化注册 Handler 方法，这可用于动态注册或高级用例，例如在不同 URL 下使用同一 Handler 的不同实例。以下示例演示了如何执行此操作：

  • 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 注入目标 Handler 和控制器的 Handler 映射。
2 准备请求映射元数据。
3 获取 Handler 方法。
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 注入目标 Handler 和控制器的 Handler 映射。
2 准备请求映射元数据。
3 获取 Handler 方法。
4 添加注册。

@HttpExchange

查看 Servlet 栈中的对应内容

虽然 @HttpExchange 的主要目的是通过生成的代理来抽象 HTTP 客户端代码，但放置此类注解的 HTTP Interface 是一个对客户端与服务器使用保持中立的契约。除了简化客户端代码外，在某些情况下，HTTP Interface 也可能是服务器暴露其 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 的列表。