CORS

Spring WebFlux 允许您处理 CORS（跨域资源共享）。本节介绍如何实现。

简介

出于安全原因，浏览器禁止 AJAX 调用当前源之外的资源。例如，您可能在一个选项卡中打开银行账户，在另一个选项卡中打开 evil.com。来自 evil.com 的脚本不应该能够使用您的凭据向您的银行 API 发出 AJAX 请求——例如，从您的账户中取款！

跨域资源共享（CORS）是 W3C 规范，由 大多数浏览器实现，它允许您指定哪种跨域请求是经过授权的，而不是使用基于 IFRAME 或 JSONP 的安全性较低且功能较弱的变通方法。

处理

CORS 规范区分预检请求、简单请求和实际请求。要了解 CORS 的工作原理，您可以阅读 这篇文章（以及许多其他文章），或查阅规范以获取更多详细信息。

Spring WebFlux 的 HandlerMapping 实现提供了对 CORS 的内置支持。在成功将请求映射到处理器后，HandlerMapping 会检查给定请求和处理器的 CORS 配置，并采取进一步行动。预检请求直接处理，而简单和实际的 CORS 请求则被拦截、验证并设置所需的 CORS 响应头。

为了启用跨域请求（即，Origin 头存在且与请求的主机不同），您需要有一些明确声明的 CORS 配置。如果找不到匹配的 CORS 配置，预检请求将被拒绝。简单和实际的 CORS 请求的响应中不会添加 CORS 头，因此浏览器会拒绝它们。

每个 HandlerMapping 都可以通过基于 URL 模式的 CorsConfiguration 映射进行 单独配置。在大多数情况下，应用程序使用 WebFlux Java 配置来声明此类映射，这会生成一个传递给所有 HandlerMapping 实现的单一全局映射。

您可以将 HandlerMapping 级别的全局 CORS 配置与更细粒度的处理器级别 CORS 配置结合起来。例如，带注解的控制器可以使用类级别或方法级别的 @CrossOrigin 注解（其他处理器可以实现 CorsConfigurationSource）。

组合全局和本地配置的规则通常是累加的——例如，所有全局和所有本地来源。对于那些只能接受单个值的属性，例如 allowCredentials 和 maxAge，本地值会覆盖全局值。有关更多详细信息，请参阅 CorsConfiguration#combine(CorsConfiguration)。

要从源头了解更多信息或进行高级自定义，请参阅：

  • CorsConfiguration

  • CorsProcessor 和 DefaultCorsProcessor

  • AbstractHandlerMapping

凭证请求

将 CORS 与凭证请求一起使用需要启用 allowedCredentials。请注意，此选项与配置的域建立了高度信任，并通过暴露敏感的用户特定信息（如 cookie 和 CSRF 令牌）增加了 Web 应用程序的攻击面。

启用凭证还会影响配置的 "*" CORS 通配符的处理方式：

  • allowOrigins 中不允许使用通配符，但可以使用 allowOriginPatterns 属性来匹配动态的来源集合。

  • 当设置在 allowedHeaders 或 allowedMethods 上时，Access-Control-Allow-Headers 和 Access-Control-Allow-Methods 响应头通过复制 CORS 预检请求中指定的相关头和方法来处理。

  • 当设置在 exposedHeaders 上时，Access-Control-Expose-Headers 响应头被设置为配置的头列表或通配符。虽然 CORS 规范在 Access-Control-Allow-Credentials 设置为 true 时不允许使用通配符，但大多数浏览器都支持它，并且在 CORS 处理期间并非所有响应头都可用，因此，无论 allowCredentials 属性的值如何，指定通配符时，它都是使用的头值。

虽然这种通配符配置很方便，但建议在可能的情况下配置一组有限的值，以提供更高级别的安全性。

@CrossOrigin

@CrossOrigin 注解在带注解的控制器方法上启用跨域请求，如下例所示：

  • Java

  • Kotlin

@RestController
@RequestMapping("/account")
public class AccountController {

	@CrossOrigin
	@GetMapping("/{id}")
	public Mono<Account> retrieve(@PathVariable Long id) {
		// ...
	}

	@DeleteMapping("/{id}")
	public Mono<Void> remove(@PathVariable Long id) {
		// ...
	}
}
@RestController
@RequestMapping("/account")
class AccountController {

	@CrossOrigin
	@GetMapping("/{id}")
	suspend fun retrieve(@PathVariable id: Long): Account {
		// ...
	}

	@DeleteMapping("/{id}")
	suspend fun remove(@PathVariable id: Long) {
		// ...
	}
}

默认情况下，@CrossOrigin 允许：

  • 所有来源。

  • 所有头。

  • 控制器方法映射到的所有 HTTP 方法。

默认情况下不启用 allowCredentials，因为它建立了暴露敏感用户特定信息（例如 cookie 和 CSRF 令牌）的信任级别，并且只应在适当的情况下使用。当它被启用时，allowOrigins 必须设置为一个或多个特定域（但不是特殊值 "*"），或者可以使用 allowOriginPatterns 属性来匹配动态的来源集合。

maxAge 设置为 30 分钟。

@CrossOrigin 也支持在类级别使用，并被所有方法继承。以下示例指定了一个特定域并将 maxAge 设置为一小时：

  • Java

  • Kotlin

@CrossOrigin(origins = "https://domain2.com", maxAge = 3600)
@RestController
@RequestMapping("/account")
public class AccountController {

	@GetMapping("/{id}")
	public Mono<Account> retrieve(@PathVariable Long id) {
		// ...
	}

	@DeleteMapping("/{id}")
	public Mono<Void> remove(@PathVariable Long id) {
		// ...
	}
}
@CrossOrigin("https://domain2.com", maxAge = 3600)
@RestController
@RequestMapping("/account")
class AccountController {

	@GetMapping("/{id}")
	suspend fun retrieve(@PathVariable id: Long): Account {
		// ...
	}

	@DeleteMapping("/{id}")
	suspend fun remove(@PathVariable id: Long) {
		// ...
	}
}

您可以在类级别和方法级别使用 @CrossOrigin，如下例所示：

Java
@CrossOrigin(maxAge = 3600) [id="CO1-1"][id="CO1-1"][id="CO1-1"](1)
@RestController
@RequestMapping("/account")
public class AccountController {

	@CrossOrigin("https://domain2.com") [id="CO1-2"][id="CO1-2"][id="CO1-2"](2)
	@GetMapping("/{id}")
	public Mono<Account> retrieve(@PathVariable Long id) {
		// ...
	}

	@DeleteMapping("/{id}")
	public Mono<Void> remove(@PathVariable Long id) {
		// ...
	}
}
<1>  在类级别使用 `@CrossOrigin`。
<1>  在方法级别使用 `@CrossOrigin`。
Kotlin
@CrossOrigin(maxAge = 3600) [id="CO2-1"][id="CO1-3"][id="CO2-1"](1)
@RestController
@RequestMapping("/account")
class AccountController {

	@CrossOrigin("https://domain2.com") [id="CO2-2"][id="CO1-4"][id="CO2-2"](2)
	@GetMapping("/{id}")
	suspend fun retrieve(@PathVariable id: Long): Account {
		// ...
	}

	@DeleteMapping("/{id}")
	suspend fun remove(@PathVariable id: Long) {
		// ...
	}
}
<1>  在类级别使用 `@CrossOrigin`。
<1>  在方法级别使用 `@CrossOrigin`。

全局配置

除了细粒度的控制器方法级配置之外，您可能还希望定义一些全局 CORS 配置。您可以在任何 HandlerMapping 上单独设置基于 URL 的 CorsConfiguration 映射。然而，大多数应用程序使用 WebFlux Java 配置来完成此操作。

默认情况下，全局配置启用以下内容：

  • 所有来源。

  • 所有头。

  • GET、HEAD 和 POST 方法。

默认情况下不启用 allowedCredentials，因为它建立了暴露敏感用户特定信息（例如 cookie 和 CSRF 令牌）的信任级别，并且只应在适当的情况下使用。当它被启用时，allowOrigins 必须设置为一个或多个特定域（但不是特殊值 "*"），或者可以使用 allowOriginPatterns 属性来匹配动态的来源集合。

maxAge 设置为 30 分钟。

要在 WebFlux Java 配置中启用 CORS，您可以使用 CorsRegistry 回调，如下例所示：

  • Java

  • Kotlin

@Configuration
@EnableWebFlux
public class WebConfig implements WebFluxConfigurer {

	@Override
	public void addCorsMappings(CorsRegistry registry) {

		registry.addMapping("/api/**")
			.allowedOrigins("https://domain2.com")
			.allowedMethods("PUT", "DELETE")
			.allowedHeaders("header1", "header2", "header3")
			.exposedHeaders("header1", "header2")
			.allowCredentials(true).maxAge(3600);

		// Add more mappings...
	}
}
@Configuration
@EnableWebFlux
class WebConfig : WebFluxConfigurer {

	override fun addCorsMappings(registry: CorsRegistry) {

		registry.addMapping("/api/**")
				.allowedOrigins("https://domain2.com")
				.allowedMethods("PUT", "DELETE")
				.allowedHeaders("header1", "header2", "header3")
				.exposedHeaders("header1", "header2")
				.allowCredentials(true).maxAge(3600)

		// Add more mappings...
	}
}

CORS WebFilter

您可以通过内置的 CorsWebFilter 应用 CORS 支持，它与 函数式端点非常契合。

如果您尝试将 CorsFilter 与 Spring Security 一起使用，请记住 Spring Security 具有 内置支持 用于 CORS。

要配置过滤器，您可以声明一个 CorsWebFilter bean 并将 CorsConfigurationSource 传递给其构造函数，如下例所示：

  • Java

  • Kotlin

@Bean
CorsWebFilter corsFilter() {

	CorsConfiguration config = new CorsConfiguration();

	// Possibly...
	// config.applyPermitDefaultValues()

	config.setAllowCredentials(true);
	config.addAllowedOrigin("https://domain1.com");
	config.addAllowedHeader("*");
	config.addAllowedMethod("*");

	UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
	source.registerCorsConfiguration("/**", config);

	return new CorsWebFilter(source);
}
@Bean
fun corsFilter(): CorsWebFilter {

	val config = CorsConfiguration()

	// Possibly...
	// config.applyPermitDefaultValues()

	config.allowCredentials = true
	config.addAllowedOrigin("https://domain1.com")
	config.addAllowedHeader("*")
	config.addAllowedMethod("*")

	val source = UrlBasedCorsConfigurationSource().apply {
		registerCorsConfiguration("/**", config)
	}
	return CorsWebFilter(source)
}