程序包 cn.taketoday.web.reactive.function.client

类 DefaultWebClientBuilder

java.lang.Object

cn.taketoday.web.reactive.function.client.DefaultWebClientBuilder

所有已实现的接口:

WebClient.Builder

final class DefaultWebClientBuilder
extends Object
implements WebClient.Builder

Default implementation of WebClient.Builder.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Brian Clozel

字段概要

字段

修饰符和类型	字段	说明
private String	baseUrl
private ClientHttpConnector	connector
private cn.taketoday.util.MultiValueMap<String,String>	defaultCookies
private HttpHeaders	defaultHeaders
private Consumer<WebClient.RequestHeadersSpec<?>>	defaultRequest
private Map<String,?>	defaultUriVariables
private ExchangeFunction	exchangeFunction
private List<ExchangeFilterFunction>	filters
private static final boolean	httpComponentsClientPresent
private static final boolean	jettyClientPresent
private static final boolean	reactorClientPresent
private Map<Predicate<HttpStatusCode>,Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>>>	statusHandlers
private ExchangeStrategies	strategies
private List<Consumer<ExchangeStrategies.Builder>>	strategiesConfigurers
private UriBuilderFactory	uriBuilderFactory

构造器概要

构造器

构造器	说明
DefaultWebClientBuilder()
DefaultWebClientBuilder(DefaultWebClientBuilder other)

方法概要

修饰符和类型	方法	说明
WebClient.Builder	apply(Consumer<WebClient.Builder> builderConsumer)	Apply the given Consumer to this builder instance.
WebClient.Builder	baseUrl(String baseUrl)	Configure a base URL for requests.
WebClient	build()	Builder the WebClient instance.
WebClient.Builder	clientConnector(ClientHttpConnector connector)	Configure the ClientHttpConnector to use.
WebClient.Builder	clone()	Clone this WebClient.Builder.
WebClient.Builder	codecs(Consumer<ClientCodecConfigurer> configurer)	Configure the codecs for the WebClient in the underlying ExchangeStrategies.
private cn.taketoday.util.MultiValueMap<String,String>	copyDefaultCookies()
private HttpHeaders	copyDefaultHeaders()
WebClient.Builder	defaultCookie(String cookie, String... values)	Global option to specify a cookie to be added to every request, if the request does not already contain such a cookie.
WebClient.Builder	defaultCookies(Consumer<cn.taketoday.util.MultiValueMap<String,String>> cookiesConsumer)	Provides access to every WebClient.Builder.defaultCookie(String, String...) declared so far with the possibility to add, replace, or remove.
WebClient.Builder	defaultHeader(String header, String... values)	Global option to specify a header to be added to every request, if the request does not already contain such a header.
WebClient.Builder	defaultHeaders(Consumer<HttpHeaders> headersConsumer)	Provides access to every WebClient.Builder.defaultHeader(String, String...) declared so far with the possibility to add, replace, or remove.
WebClient.Builder	defaultRequest(Consumer<WebClient.RequestHeadersSpec<?>> defaultRequest)	Provide a consumer to customize every request being built.
WebClient.Builder	defaultStatusHandler(Predicate<HttpStatusCode> statusPredicate, Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>> exceptionFunction)	Register a default status handler to apply to every response.
WebClient.Builder	defaultUriVariables(Map<String,?> defaultUriVariables)	Configure default URL variable values to use when expanding URI templates with a Map.
private void	doCopyMultiValueMap(cn.taketoday.util.MultiValueMap<String,String> source, cn.taketoday.util.MultiValueMap<String,String> copy)
WebClient.Builder	exchangeFunction(ExchangeFunction exchangeFunction)	Provide an ExchangeFunction pre-configured with ClientHttpConnector and ExchangeStrategies.
WebClient.Builder	exchangeStrategies(ExchangeStrategies strategies)	Configure the ExchangeStrategies to use.
WebClient.Builder	exchangeStrategies(Consumer<ExchangeStrategies.Builder> configurer)	Customize the strategies configured via WebClient.Builder.exchangeStrategies(ExchangeStrategies).
WebClient.Builder	filter(ExchangeFilterFunction filter)	Add the given filter to the end of the filter chain.
private ExchangeFunction	filterExchangeFunction(ExchangeFunction exchange)
WebClient.Builder	filters(Consumer<List<ExchangeFilterFunction>> filtersConsumer)	Manipulate the filters with the given consumer.
private ExchangeStrategies.Builder	getOrCreateBuilder()
private ClientHttpConnector	initConnector()
private cn.taketoday.util.MultiValueMap<String,String>	initCookies()
private ExchangeStrategies	initExchangeStrategies()
private List<ExchangeFilterFunction>	initFilters()
private HttpHeaders	initHeaders()
private UriBuilderFactory	initUriBuilderFactory()
WebClient.Builder	uriBuilderFactory(UriBuilderFactory uriBuilderFactory)	Provide a pre-configured UriBuilderFactory instance.

从类继承的方法 java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

reactorClientPresent

private static final boolean reactorClientPresent

jettyClientPresent

private static final boolean jettyClientPresent

httpComponentsClientPresent

private static final boolean httpComponentsClientPresent

baseUrl

@Nullable
private String baseUrl

defaultUriVariables

@Nullable
private Map<String,?> defaultUriVariables

uriBuilderFactory

@Nullable
private UriBuilderFactory uriBuilderFactory

defaultHeaders

@Nullable
private HttpHeaders defaultHeaders

defaultCookies

@Nullable
private cn.taketoday.util.MultiValueMap<String,String> defaultCookies

defaultRequest

@Nullable
private Consumer<WebClient.RequestHeadersSpec<?>> defaultRequest

statusHandlers

@Nullable
private Map<Predicate<HttpStatusCode>,Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>>> statusHandlers

filters

@Nullable
private List<ExchangeFilterFunction> filters

connector

@Nullable
private ClientHttpConnector connector

strategies

@Nullable
private ExchangeStrategies strategies

strategiesConfigurers

@Nullable
private List<Consumer<ExchangeStrategies.Builder>> strategiesConfigurers

exchangeFunction

@Nullable
private ExchangeFunction exchangeFunction

构造器详细资料

DefaultWebClientBuilder

public DefaultWebClientBuilder()

DefaultWebClientBuilder

public DefaultWebClientBuilder(DefaultWebClientBuilder other)

方法详细资料

baseUrl

public WebClient.Builder baseUrl(String baseUrl)

从接口复制的说明: WebClient.Builder

Configure a base URL for requests. Effectively a shortcut for:

 String baseUrl = "https://abc.go.com/v1";
 DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl);
 WebClient client = WebClient.builder().uriBuilderFactory(factory).build();
 

The DefaultUriBuilderFactory is used to prepare the URL for every request with the given base URL, unless the URL request for a given URL is absolute in which case the base URL is ignored.

Note: this method is mutually exclusive with WebClient.Builder.uriBuilderFactory(UriBuilderFactory). If both are used, the baseUrl value provided here will be ignored.

指定者:

baseUrl 在接口中 WebClient.Builder

另请参阅:

• DefaultUriBuilderFactory(String)
• WebClient.Builder.uriBuilderFactory(UriBuilderFactory)

defaultUriVariables

public WebClient.Builder defaultUriVariables(Map<String,?> defaultUriVariables)

从接口复制的说明: WebClient.Builder

Configure default URL variable values to use when expanding URI templates with a Map. Effectively a shortcut for:

 Map<String, ?> defaultVars = ...;
 DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory();
 factory.setDefaultVariables(defaultVars);
 WebClient client = WebClient.builder().uriBuilderFactory(factory).build();
 

Note: this method is mutually exclusive with WebClient.Builder.uriBuilderFactory(UriBuilderFactory). If both are used, the defaultUriVariables value provided here will be ignored.

指定者:

defaultUriVariables 在接口中 WebClient.Builder

另请参阅:

• DefaultUriBuilderFactory.setDefaultUriVariables(Map)
• WebClient.Builder.uriBuilderFactory(UriBuilderFactory)

uriBuilderFactory

public WebClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

从接口复制的说明: WebClient.Builder

Provide a pre-configured UriBuilderFactory instance. This is an alternative to, and effectively overrides the following shortcut properties:

• WebClient.Builder.baseUrl(String)
• WebClient.Builder.defaultUriVariables(Map).

指定者:

uriBuilderFactory 在接口中 WebClient.Builder

参数:

uriBuilderFactory - the URI builder factory to use

另请参阅:

• WebClient.Builder.baseUrl(String)
• WebClient.Builder.defaultUriVariables(Map)

defaultHeader

public WebClient.Builder defaultHeader(String header,
 String... values)

从接口复制的说明: WebClient.Builder

Global option to specify a header to be added to every request, if the request does not already contain such a header.

指定者:

defaultHeader 在接口中 WebClient.Builder

参数:

header - the header name

values - the header values

defaultHeaders

public WebClient.Builder defaultHeaders(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: WebClient.Builder

Provides access to every WebClient.Builder.defaultHeader(String, String...) declared so far with the possibility to add, replace, or remove.

指定者:

defaultHeaders 在接口中 WebClient.Builder

参数:

headersConsumer - the consumer

initHeaders

private HttpHeaders initHeaders()

defaultCookie

public WebClient.Builder defaultCookie(String cookie,
 String... values)

从接口复制的说明: WebClient.Builder

Global option to specify a cookie to be added to every request, if the request does not already contain such a cookie.

指定者:

defaultCookie 在接口中 WebClient.Builder

参数:

cookie - the cookie name

values - the cookie values

defaultCookies

public WebClient.Builder defaultCookies(Consumer<cn.taketoday.util.MultiValueMap<String,String>> cookiesConsumer)

从接口复制的说明: WebClient.Builder

Provides access to every WebClient.Builder.defaultCookie(String, String...) declared so far with the possibility to add, replace, or remove.

指定者:

defaultCookies 在接口中 WebClient.Builder

参数:

cookiesConsumer - a function that consumes the cookies map

initCookies

private cn.taketoday.util.MultiValueMap<String,String> initCookies()

defaultRequest

public WebClient.Builder defaultRequest(Consumer<WebClient.RequestHeadersSpec<?>> defaultRequest)

从接口复制的说明: WebClient.Builder

Provide a consumer to customize every request being built.

指定者:

defaultRequest 在接口中 WebClient.Builder

参数:

defaultRequest - the consumer to use for modifying requests

defaultStatusHandler

public WebClient.Builder defaultStatusHandler(Predicate<HttpStatusCode> statusPredicate,
 Function<ClientResponse,reactor.core.publisher.Mono<? extends Throwable>> exceptionFunction)

从接口复制的说明: WebClient.Builder

Register a default status handler to apply to every response. Such default handlers are applied in the order in which they are registered, and after any others that are registered for a specific response.

指定者:

defaultStatusHandler 在接口中 WebClient.Builder

参数:

statusPredicate - to match responses with

exceptionFunction - to map the response to an error signal

返回:

this builder

filter

public WebClient.Builder filter(ExchangeFilterFunction filter)

从接口复制的说明: WebClient.Builder

Add the given filter to the end of the filter chain.

指定者:

filter 在接口中 WebClient.Builder

参数:

filter - the filter to be added to the chain

filters

public WebClient.Builder filters(Consumer<List<ExchangeFilterFunction>> filtersConsumer)

从接口复制的说明: WebClient.Builder

Manipulate the filters with the given consumer. The list provided to the consumer is "live", so that the consumer can be used to remove filters, change ordering, etc.

指定者:

filters 在接口中 WebClient.Builder

参数:

filtersConsumer - a function that consumes the filter list

返回:

this builder

initFilters

private List<ExchangeFilterFunction> initFilters()

clientConnector

public WebClient.Builder clientConnector(ClientHttpConnector connector)

从接口复制的说明: WebClient.Builder

Configure the ClientHttpConnector to use. This is useful for plugging in and/or customizing options of the underlying HTTP client library (e.g. SSL).

By default this is set to ReactorClientHttpConnector.

指定者:

clientConnector 在接口中 WebClient.Builder

参数:

connector - the connector to use

codecs

public WebClient.Builder codecs(Consumer<ClientCodecConfigurer> configurer)

从接口复制的说明: WebClient.Builder

Configure the codecs for the WebClient in the underlying ExchangeStrategies.

指定者:

codecs 在接口中 WebClient.Builder

参数:

configurer - the configurer to apply

exchangeStrategies

public WebClient.Builder exchangeStrategies(ExchangeStrategies strategies)

从接口复制的说明: WebClient.Builder

Configure the ExchangeStrategies to use.

For most cases, prefer using WebClient.Builder.codecs(Consumer) which allows customizing the codecs in the ExchangeStrategies rather than replace them. That ensures multiple parties can contribute to codecs configuration.

By default this is set to ExchangeStrategies.withDefaults().

指定者:

exchangeStrategies 在接口中 WebClient.Builder

参数:

strategies - the strategies to use

exchangeStrategies

public WebClient.Builder exchangeStrategies(Consumer<ExchangeStrategies.Builder> configurer)

从接口复制的说明: WebClient.Builder

Customize the strategies configured via WebClient.Builder.exchangeStrategies(ExchangeStrategies). This method is designed for use in scenarios where multiple parties wish to update the ExchangeStrategies.

指定者:

exchangeStrategies 在接口中 WebClient.Builder

exchangeFunction

public WebClient.Builder exchangeFunction(ExchangeFunction exchangeFunction)

从接口复制的说明: WebClient.Builder

Provide an ExchangeFunction pre-configured with ClientHttpConnector and ExchangeStrategies.

This is an alternative to, and effectively overrides WebClient.Builder.clientConnector(cn.taketoday.http.client.reactive.ClientHttpConnector), and WebClient.Builder.exchangeStrategies(ExchangeStrategies).

指定者:

exchangeFunction 在接口中 WebClient.Builder

参数:

exchangeFunction - the exchange function to use

apply

public WebClient.Builder apply(Consumer<WebClient.Builder> builderConsumer)

从接口复制的说明: WebClient.Builder

Apply the given Consumer to this builder instance.

This can be useful for applying pre-packaged customizations.

指定者:

apply 在接口中 WebClient.Builder

参数:

builderConsumer - the consumer to apply

clone

public WebClient.Builder clone()

从接口复制的说明: WebClient.Builder

Clone this WebClient.Builder.

指定者:

clone 在接口中 WebClient.Builder

覆盖:

clone 在类中 Object

build

public WebClient build()

从接口复制的说明: WebClient.Builder

Builder the WebClient instance.

指定者:

build 在接口中 WebClient.Builder

filterExchangeFunction

private ExchangeFunction filterExchangeFunction(ExchangeFunction exchange)

initConnector

private ClientHttpConnector initConnector()

initExchangeStrategies

private ExchangeStrategies initExchangeStrategies()

getOrCreateBuilder

private ExchangeStrategies.Builder getOrCreateBuilder()

initUriBuilderFactory

private UriBuilderFactory initUriBuilderFactory()

copyDefaultHeaders

@Nullable
private HttpHeaders copyDefaultHeaders()

copyDefaultCookies

@Nullable
private cn.taketoday.util.MultiValueMap<String,String> copyDefaultCookies()

doCopyMultiValueMap

private void doCopyMultiValueMap(cn.taketoday.util.MultiValueMap<String,String> source,
 cn.taketoday.util.MultiValueMap<String,String> copy)