CORS

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

简介

查看 Servlet 堆栈中的等效项

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

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

处理

查看 Servlet 堆栈中的等效项

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

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

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

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

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

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

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

  • CorsConfiguration

  • CorsProcessor 和 DefaultCorsProcessor

  • AbstractHandlerMapping

凭据请求

查看 Servlet 堆栈中的等效项

使用 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

查看 Servlet 堆栈中的等效项

如以下示例所示，@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

  • Kotlin

@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。 
@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) {
		// ...
	}
}
1 在类级别使用 @CrossOrigin。
2 在方法级别使用 @CrossOrigin。

全局配置

查看 Servlet 堆栈中的等效项

除了细粒度的控制器方法级配置之外，您可能还想定义一些全局 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

查看 Servlet 堆栈中的等效项

您可以通过内置的 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)
}