Spire 天擎

外观

class OptionsBuilder ​

cangjie
public class OptionsBuilder<TOptions> where TOptions <: Object

功能：提供命名选项的配置与验证构建能力。

成员概览 ​

成员功能
init(String, ServiceCollection)-
func configure((TOptions) -> Unit)配置选项实例。
func configure((TOptions, IServiceProvider) -> Unit)配置选项实例并访问服务提供程序。
func configureAfter((TOptions) -> Unit)在基础配置之后追加配置。
func configureAfter((TOptions, IServiceProvider) -> Unit)在基础配置之后追加配置并访问服务提供程序。
func validate((TOptions) -> Bool)添加一个使用默认失败消息的验证规则。
func validate(String, (TOptions) -> Bool)添加一个自定义失败消息的验证规则。
func validate((TOptions, IServiceProvider) -> Bool)添加一个可访问服务提供程序的验证规则。
func validate(String, (TOptions, IServiceProvider) -> Bool)添加一个可访问服务提供程序且带自定义失败消息的验证规则。
func validateOnStart()注册启动阶段验证当前选项的行为。

init(String, ServiceCollection) ​

cangjie
public init(name: String, services: ServiceCollection)

参数：

func configure((TOptions) -> Unit) ​

cangjie
public func configure(configureOptions: (TOptions) -> Unit): OptionsBuilder<TOptions>

功能：配置选项实例。

参数：

  • configureOptions: (TOptions) -> Unit - 用于配置选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func configure((TOptions, IServiceProvider) -> Unit) ​

cangjie
public func configure(configureOptions: (TOptions, IServiceProvider) -> Unit): OptionsBuilder<TOptions>

功能：配置选项实例并访问服务提供程序。

参数：

  • configureOptions: (TOptions, IServiceProvider) -> Unit - 用于配置选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func configureAfter((TOptions) -> Unit) ​

cangjie
public func configureAfter(configureOptions: (TOptions) -> Unit): OptionsBuilder<TOptions>

功能：在基础配置之后追加配置。

参数：

  • configureOptions: (TOptions) -> Unit - 用于追加配置选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func configureAfter((TOptions, IServiceProvider) -> Unit) ​

cangjie
public func configureAfter(configureOptions: (TOptions, IServiceProvider) -> Unit): OptionsBuilder<TOptions>

功能：在基础配置之后追加配置并访问服务提供程序。

参数：

  • configureOptions: (TOptions, IServiceProvider) -> Unit - 用于追加配置选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func validate((TOptions) -> Bool) ​

cangjie
public func validate(validation: (TOptions) -> Bool): OptionsBuilder<TOptions>

功能：添加一个使用默认失败消息的验证规则。

参数：

  • validation: (TOptions) -> Bool - 用于验证选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func validate(String, (TOptions) -> Bool) ​

cangjie
public func validate(failureMessage: String, validation: (TOptions) -> Bool): OptionsBuilder<TOptions>

功能：添加一个自定义失败消息的验证规则。

参数：

  • failureMessage: String - 验证失败时使用的消息。
  • validation: (TOptions) -> Bool - 用于验证选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func validate((TOptions, IServiceProvider) -> Bool) ​

cangjie
public func validate(validation: (TOptions, IServiceProvider) -> Bool): OptionsBuilder<TOptions>

功能：添加一个可访问服务提供程序的验证规则。

参数：

  • validation: (TOptions, IServiceProvider) -> Bool - 用于验证选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func validate(String, (TOptions, IServiceProvider) -> Bool) ​

cangjie
public func validate(failureMessage: String, validation: (TOptions, IServiceProvider) -> Bool): OptionsBuilder<TOptions>

功能：添加一个可访问服务提供程序且带自定义失败消息的验证规则。

参数：

  • failureMessage: String - 验证失败时使用的消息。
  • validation: (TOptions, IServiceProvider) -> Bool - 用于验证选项实例的回调。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。

func validateOnStart() ​

cangjie
public func validateOnStart(): OptionsBuilder<TOptions>

功能：注册启动阶段验证当前选项的行为。

返回值：

  • OptionsBuilder<TOptions> - 返回当前选项构建器，便于继续链式配置。