Spire 天擎

外观

class CorsOptions ​

cangjie
public class CorsOptions

功能：表示 CORS 组件使用的选项集合。

成员概览 ​

成员功能
var policyResolver根据请求上下文和策略名称解析 CORS 策略。
prop defaultPolicyName获取或设置默认 CORS 策略名称。
func addDefaultPolicy(CorsPolicy)将指定策略注册为默认 CORS 策略。
func addDefaultPolicy((CorsPolicyBuilder) -> Unit)通过构建回调注册默认 CORS 策略。
func addPolicy(String, (CorsPolicyBuilder) -> Unit)通过构建回调注册指定名称的 CORS 策略。
func addPolicy(String, CorsPolicy)注册指定名称的 CORS 策略。
func getPolicy(String)按名称获取已注册的 CORS 策略。

var policyResolver ​

cangjie
public var policyResolver: (HttpContext, ?String) -> ?CorsPolicy =

功能：根据请求上下文和策略名称解析 CORS 策略。

类型：(HttpContext, ?String) -> ?CorsPolicy

prop defaultPolicyName ​

cangjie
public mut prop defaultPolicyName: String

功能：获取或设置默认 CORS 策略名称。

类型：String

func addDefaultPolicy(CorsPolicy) ​

cangjie
public func addDefaultPolicy(policy: CorsPolicy): Unit

功能：将指定策略注册为默认 CORS 策略。

参数：

  • policy: CorsPolicy - 要注册为默认策略的 CORS 策略。

返回值：

  • Unit

func addDefaultPolicy((CorsPolicyBuilder) -> Unit) ​

cangjie
public func addDefaultPolicy(configurePolicy: (CorsPolicyBuilder) -> Unit): Unit

功能：通过构建回调注册默认 CORS 策略。

参数：

返回值：

  • Unit

异常：

  • UnsupportedException - 当构建出的策略同时允许任意源和凭据时抛出。

func addPolicy(String, (CorsPolicyBuilder) -> Unit) ​

cangjie
public func addPolicy(name: String, configurePolicy: (CorsPolicyBuilder) -> Unit): Unit

功能：通过构建回调注册指定名称的 CORS 策略。

参数：

  • name: String - 要注册的 CORS 策略名称。
  • configurePolicy: (CorsPolicyBuilder) -> Unit - 用于配置策略的回调。

返回值：

  • Unit

异常：

  • UnsupportedException - 当构建出的策略同时允许任意源和凭据时抛出。

func addPolicy(String, CorsPolicy) ​

cangjie
public func addPolicy(name: String, policy: CorsPolicy): Unit

功能：注册指定名称的 CORS 策略。

参数：

  • name: String - 要注册的 CORS 策略名称。
  • policy: CorsPolicy - 要注册的 CORS 策略实例。

返回值：

  • Unit

func getPolicy(String) ​

cangjie
public func getPolicy(name: String): ?CorsPolicy

功能：按名称获取已注册的 CORS 策略。

参数：

  • name: String - 要查找的 CORS 策略名称。

返回值：

  • ?CorsPolicy - 返回匹配的 CORS 策略；如果不存在则返回空。