CORS

Spring WebFlux 允许您处理 CORS（跨源资源共享）。本节介绍如何执行此操作。

Introduction

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

跨源资源共享（CORS）是 most browsers实现的 W3C specification，它允许你指定授权的跨域请求类型，而不是使用基于 IFRAME 或 JSONP 的安全性较低且功能较弱的替代方法。

Processing

CORS 规范将预检请求、简单请求和实际请求区别开来。若要了解 CORS 的工作原理，可以阅读 this article，以及众多其他文章，或查阅规范以了解更多详情。

Spring WebFlux HandlerMapping 实现提供内置的 CORS 支持。在成功将请求映射到某个处理程序后，HandlerMapping 将检查给定请求和处理程序的 CORS 配置并执行进一步的操作。预检请求将直接处理，而简单和实际的 CORS 请求将被截取、验证，并设置必需的 CORS 响应头。

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

每个 HandlerMapping 均可以与基于 URL 模式的 CorsConfiguration 映射一起单独https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/reactive/handler/AbstractHandlerMapping.html#setCorsConfigurations-java.util.Map-[配置]。在大多数情况下，应用程序使用该 WebFlux Java 配置来申明此类映射，其结果是将一个全局映射传递给所有 HandlerMapping 实现。

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

组合全局和局部配置的规则通常是累加的，例如，所有全局和所有局部来源。对于只能接受单个值的那些属性，例如 allowCredentials 和 maxAge，则局部值覆盖全局值。有关更多详情，请参见https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/cors/CorsConfiguration.html#combine-org.springframework.web.cors.CorsConfiguration-[CorsConfiguration#combine(CorsConfiguration)]。

要从源代码了解详细信息或进行高级自定义，请参阅：

  • CorsConfiguration

  • CorsProcessor and DefaultCorsProcessor

  • AbstractHandlerMapping

Credentialed Requests

使用带有凭证请求的 CORS 需要启用 allowedCredentials。请注意，此选项建立了与配置域的高级别信任，并且还通过公开敏感的特定用户信息（例如 Cookie 和 CSRF 令牌），增加了 Web 应用程序的攻击面。

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

  • 通配符在 allowOrigins 中不被授权，但可以另行使用 allowOriginPatterns 属性来匹配一组动态来源。

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

  • 当在 exposedHeaders 上设置时，Access-Control-Expose-Headers 响应标头被设置为配置的标头列表或通配符。虽然在将 Access-Control-Allow-Credentials 设置为 true 时 CORS 规范不允许通配符，但大多数浏览器都支持该通配符，并且在 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 允许：

  • All origins.

  • All headers.

  • 控制器方法映射到的所有 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) (1)
@RestController
@RequestMapping("/account")
public class AccountController {

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

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

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

	@DeleteMapping("/{id}")
	suspend fun remove(@PathVariable id: Long) {
		// ...
	}
}
3 在类级别上使用 @CrossOrigin。
4 在方法级别上使用 @CrossOrigin。

Global Configuration

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

默认情况下，全局配置启用以下各项：

  • All origins.

  • All headers.

  • 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

您可以通过内置https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/cors/reactive/CorsWebFilter.html[CorsWebFilter]应用 CORS 支持，它与 functional endpoints配合良好。

如果您尝试将 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)
}