映射请求

参见 Servlet 堆栈中的等效项

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

@RequestMapping

参见 Servlet 堆栈中的等效项

@RequestMapping 注释用于将请求映射到控制器方法。它具有各种属性，可按 URL、HTTP 方法、请求参数、标头和媒体类型进行匹配。你可以在类级别使用它来表示共享映射，或在方法级别使用它来缩小到特定端点映射。

还有 @RequestMapping 的 HTTP 方法特定快捷方式变体

  • @GetMapping

  • @PostMapping

  • @PutMapping

  • @DeleteMapping

  • @PatchMapping

前面的注释是 自定义注释，提供这些注释是因为可以说大多数控制器方法都应映射到特定 HTTP 方法，而不是使用 @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 模式

参见 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 中，并且专门设计用于在运行时匹配大量 URI 路径模式的 Web 应用程序中的 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 堆栈中的等效项

你可以以编程方式注册处理程序方法，这些方法可用于动态注册或高级用例，例如在不同 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

参见 Servlet 堆栈中的等效项

虽然 @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 的列表。