Spire 天擎

外观

class HttpClientBuilder ​

cangjie
public class HttpClientBuilder

功能：提供命名 HTTP 客户端的配置构建能力。

成员概览 ​

成员功能
prop name返回当前 HTTP 客户端名称。
prop services返回用于注册 HTTP 客户端的服务集合。

prop name ​

cangjie
public prop name: String

功能：返回当前 HTTP 客户端名称。

类型：String

prop services ​

cangjie
public prop services: ServiceCollection

功能：返回用于注册 HTTP 客户端的服务集合。

类型：ServiceCollection

扩展成员 ​

成员功能
func setHandlerLifetime(Duration)设置处理器生命周期。
func configureHttpClient((HttpClient) -> Unit)配置 HTTP 客户端实例。
func configureHttpClient((HttpClient, IServiceProvider) -> Unit)配置 HTTP 客户端实例并访问服务提供程序。
func addHttpMessageHandler(() -> DelegatingHandler)添加通过无参工厂创建的附加消息处理器。
func addHttpMessageHandler((IServiceProvider) -> DelegatingHandler)添加通过服务提供程序创建的附加消息处理器。
func addHttpMessageHandler()添加一个从依赖注入容器解析的附加消息处理器类型。
func configureHttpMessageHandlerBuilder((HttpMessageHandlerBuilder) -> Unit)配置消息处理器构建器。
func configurePrimaryHttpMessageHandler(() -> HttpMessageHandler)配置主 HTTP 消息处理器。
func configurePrimaryHttpMessageHandler((IServiceProvider) -> HttpMessageHandler)使用服务提供程序配置主 HTTP 消息处理器。
func configurePrimaryHttpMessageHandler()配置从依赖注入容器解析的主 HTTP 消息处理器类型。
func addTypedClient()注册一个使用默认构造规则的类型化 HTTP 客户端。
func addTypedClient((HttpClient) -> TImplementation)注册一个通过工厂创建的类型化 HTTP 客户端。
func addTypedClient((HttpClient, IServiceProvider) -> TImplementation)注册一个通过工厂和服务提供程序创建的类型化 HTTP 客户端。

func setHandlerLifetime(Duration) ​

cangjie
public func setHandlerLifetime(handlerLifetime: Duration): HttpClientBuilder

功能：设置处理器生命周期。

参数：

  • handlerLifetime: Duration - 处理器生命周期。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

异常：

  • IllegalArgumentException - 当处理器生命周期小于最小值且不为零时抛出。

func configureHttpClient((HttpClient) -> Unit) ​

cangjie
public func configureHttpClient(configureClient: (HttpClient) -> Unit): HttpClientBuilder

功能：配置 HTTP 客户端实例。

参数：

  • configureClient: (HttpClient) -> Unit - 用于配置 HTTP 客户端的回调。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func configureHttpClient((HttpClient, IServiceProvider) -> Unit) ​

cangjie
public func configureHttpClient(configureClient: (HttpClient, IServiceProvider) -> Unit): HttpClientBuilder

功能：配置 HTTP 客户端实例并访问服务提供程序。

参数：

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func addHttpMessageHandler(() -> DelegatingHandler) ​

cangjie
public func addHttpMessageHandler(configureHandler: () -> DelegatingHandler): HttpClientBuilder

功能：添加通过无参工厂创建的附加消息处理器。

参数：

  • configureHandler: () -> DelegatingHandler - 用于创建附加消息处理器的回调。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func addHttpMessageHandler((IServiceProvider) -> DelegatingHandler) ​

cangjie
public func addHttpMessageHandler(configureHandler: (IServiceProvider) -> DelegatingHandler): HttpClientBuilder

功能：添加通过服务提供程序创建的附加消息处理器。

参数：

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func addHttpMessageHandler() ​

cangjie
public func addHttpMessageHandler<THandler>(): HttpClientBuilder where THandler <: DelegatingHandler

功能：添加一个从依赖注入容器解析的附加消息处理器类型。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func configureHttpMessageHandlerBuilder((HttpMessageHandlerBuilder) -> Unit) ​

cangjie
public func configureHttpMessageHandlerBuilder(configureBuilder: (HttpMessageHandlerBuilder) -> Unit): HttpClientBuilder

功能：配置消息处理器构建器。

参数：

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func configurePrimaryHttpMessageHandler(() -> HttpMessageHandler) ​

cangjie
public func configurePrimaryHttpMessageHandler(configureHandler: () -> HttpMessageHandler): HttpClientBuilder

功能：配置主 HTTP 消息处理器。

参数：

  • configureHandler: () -> HttpMessageHandler - 用于创建主 HTTP 消息处理器的回调。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func configurePrimaryHttpMessageHandler((IServiceProvider) -> HttpMessageHandler) ​

cangjie
public func configurePrimaryHttpMessageHandler(configureHandler: (IServiceProvider) -> HttpMessageHandler): HttpClientBuilder

功能：使用服务提供程序配置主 HTTP 消息处理器。

参数：

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func configurePrimaryHttpMessageHandler() ​

cangjie
public func configurePrimaryHttpMessageHandler<THandler>(): HttpClientBuilder where THandler <: HttpMessageHandler

功能：配置从依赖注入容器解析的主 HTTP 消息处理器类型。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func addTypedClient() ​

cangjie
public func addTypedClient<TClient, TImplementation>(): HttpClientBuilder where TImplementation <: Object

功能：注册一个使用默认构造规则的类型化 HTTP 客户端。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func addTypedClient((HttpClient) -> TImplementation) ​

cangjie
public func addTypedClient<TClient, TImplementation>(factory: (HttpClient) -> TImplementation): HttpClientBuilder where TImplementation <: Object

功能：注册一个通过工厂创建的类型化 HTTP 客户端。

参数：

  • factory: (HttpClient) -> TImplementation - 基于 HTTP 客户端创建实现实例的工厂。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。

func addTypedClient((HttpClient, IServiceProvider) -> TImplementation) ​

cangjie
public func addTypedClient<TClient, TImplementation>(factory: (HttpClient, IServiceProvider) -> TImplementation): HttpClientBuilder where TImplementation <: Object

功能：注册一个通过工厂和服务提供程序创建的类型化 HTTP 客户端。

参数：

  • factory: (HttpClient, IServiceProvider) -> TImplementation - 基于 HTTP 客户端和服务提供程序创建实现实例的工厂。

返回值：

  • HttpClientBuilder - 返回当前 HTTP 客户端构建器，便于继续链式配置。