Spire 天擎

外观

class ApplicationBuilder ​

cangjie
public open class ApplicationBuilder

功能：提供构建 HTTP 中间件管道的能力。

成员概览 ​

成员功能
init(IServiceProvider)使用指定服务提供器创建应用构建器。
init(ApplicationBuilder)基于现有应用构建器创建新的应用构建器。
prop services返回当前构建器使用的服务提供器。
prop properties返回当前构建器维护的属性集合。
func use((RequestDelegate) -> RequestDelegate)追加一个请求委托转换中间件。
func use((HttpContext, RequestDelegate) -> Unit)追加一个基于上下文和下一个委托的中间件。
func use(IMiddleware)追加一个中间件实例。
func use(Array<Any>)创建并追加一个中间件类型实例。
func new()创建一个复制当前配置的新应用构建器。
func build()构建并返回请求处理管道。

init(IServiceProvider) ​

cangjie
public init(services: IServiceProvider)

功能：使用指定服务提供器创建应用构建器。

参数：

init(ApplicationBuilder) ​

cangjie
public init(builder: ApplicationBuilder)

功能：基于现有应用构建器创建新的应用构建器。

参数：

prop services ​

cangjie
public prop services: IServiceProvider

功能：返回当前构建器使用的服务提供器。

类型：IServiceProvider

prop properties ​

cangjie
public prop properties: HashMap<String, Any>

功能：返回当前构建器维护的属性集合。

类型：HashMap<String, Any>

func use((RequestDelegate) -> RequestDelegate) ​

cangjie
public func use(middleware: (RequestDelegate) -> RequestDelegate): This

功能：追加一个请求委托转换中间件。

参数：

返回值：

  • This - 返回当前应用构建器。

func use((HttpContext, RequestDelegate) -> Unit) ​

cangjie
public func use(middleware: (HttpContext, RequestDelegate) -> Unit): This

功能：追加一个基于上下文和下一个委托的中间件。

参数：

返回值：

  • This - 返回当前应用构建器。

func use(IMiddleware) ​

cangjie
public func use(middleware: IMiddleware): This

功能：追加一个中间件实例。

参数：

  • middleware: IMiddleware - 要追加的中间件实例。

返回值：

  • This - 返回当前应用构建器。

func use(Array<Any>) ​

cangjie
public func use<TMiddleware>(args: Array<Any>): This where TMiddleware <: IMiddleware

功能：创建并追加一个中间件类型实例。

参数：

  • args: Array<Any> - 创建中间件实例时使用的附加参数。

返回值：

  • This - 返回当前应用构建器。

func new() ​

cangjie
public func new(): ApplicationBuilder

功能：创建一个复制当前配置的新应用构建器。

返回值：

func build() ​

cangjie
public func build(): RequestDelegate

功能：构建并返回请求处理管道。

返回值：

扩展成员 ​

成员功能
func mapWhen((HttpContext) -> Bool, (ApplicationBuilder) -> Unit)按条件将请求分支到独立的中间件管道。

func mapWhen((HttpContext) -> Bool, (ApplicationBuilder) -> Unit) ​

cangjie
public func mapWhen(predicate: (HttpContext) -> Bool, configuration: (ApplicationBuilder) -> Unit): ApplicationBuilder

功能：按条件将请求分支到独立的中间件管道。

参数：

  • predicate: (HttpContext) -> Bool - 判断是否进入分支的条件。
  • configuration: (ApplicationBuilder) -> Unit - 分支管道的配置回调。

返回值：