程序包 cn.taketoday.test.web.reactive.server

类 DefaultWebTestClientBuilder

java.lang.Object

cn.taketoday.test.web.reactive.server.DefaultWebTestClientBuilder

所有已实现的接口:

WebTestClient.Builder

class DefaultWebTestClientBuilder
extends Object
implements WebTestClient.Builder

Default implementation of WebTestClient.Builder.

从以下版本开始:

4.0

作者:

Rossen Stoyanchev, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private String	baseUrl
private cn.taketoday.http.client.reactive.ClientHttpConnector	connector
private cn.taketoday.util.MultiValueMap<String,String>	defaultCookies
private cn.taketoday.http.HttpHeaders	defaultHeaders
private Consumer<EntityExchangeResult<?>>	entityResultConsumer
private List<cn.taketoday.web.reactive.function.client.ExchangeFilterFunction>	filters
private static final boolean	httpComponentsClientPresent
private static final boolean	jettyClientPresent
private static final boolean	reactorNetty2ClientPresent
private static final boolean	reactorNettyClientPresent
private Duration	responseTimeout
private cn.taketoday.web.reactive.function.client.ExchangeStrategies	strategies
private List<Consumer<cn.taketoday.web.reactive.function.client.ExchangeStrategies.Builder>>	strategiesConfigurers
private cn.taketoday.web.util.UriBuilderFactory	uriBuilderFactory

构造器概要

构造器

构造器	说明
DefaultWebTestClientBuilder()
DefaultWebTestClientBuilder(cn.taketoday.http.client.reactive.ClientHttpConnector connector)
DefaultWebTestClientBuilder(DefaultWebTestClientBuilder other)	Copy constructor.

方法概要

修饰符和类型	方法	说明
WebTestClient.Builder	apply(WebTestClientConfigurer configurer)	Apply the given configurer to this builder instance.
WebTestClient.Builder	baseUrl(String baseUrl)	Configure a base URI as described in WebClient.create(String).
WebTestClient	build()	Build the WebTestClient instance.
WebTestClient.Builder	clientConnector(cn.taketoday.http.client.reactive.ClientHttpConnector connector)	Set the ClientHttpConnector to use.
WebTestClient.Builder	codecs(Consumer<cn.taketoday.http.codec.ClientCodecConfigurer> configurer)	Configure the codecs for the WebClient in the underlying ExchangeStrategies.
WebTestClient.Builder	defaultCookie(String cookie, String... values)	Add the given header to all requests that haven't added it.
WebTestClient.Builder	defaultCookies(Consumer<cn.taketoday.util.MultiValueMap<String,String>> cookiesConsumer)	Manipulate the default cookies with the given consumer.
WebTestClient.Builder	defaultHeader(String header, String... values)	Add the given header to all requests that haven't added it.
WebTestClient.Builder	defaultHeaders(Consumer<cn.taketoday.http.HttpHeaders> headersConsumer)	Manipulate the default headers with the given consumer.
WebTestClient.Builder	entityExchangeResultConsumer(Consumer<EntityExchangeResult<?>> entityResultConsumer)	Configure an EntityExchangeResult callback that is invoked every time after a response is fully decoded to a single entity, to a List of entities, or to a byte[].
WebTestClient.Builder	exchangeStrategies(cn.taketoday.web.reactive.function.client.ExchangeStrategies strategies)	Configure the ExchangeStrategies to use.
WebTestClient.Builder	exchangeStrategies(Consumer<cn.taketoday.web.reactive.function.client.ExchangeStrategies.Builder> configurer)	Customize the strategies configured via WebTestClient.Builder.exchangeStrategies(ExchangeStrategies).
WebTestClient.Builder	filter(cn.taketoday.web.reactive.function.client.ExchangeFilterFunction filter)	Add the given filter to the filter chain.
WebTestClient.Builder	filters(Consumer<List<cn.taketoday.web.reactive.function.client.ExchangeFilterFunction>> filtersConsumer)	Manipulate the filters with the given consumer.
private static cn.taketoday.http.client.reactive.ClientHttpConnector	initConnector()
private cn.taketoday.util.MultiValueMap<String,String>	initCookies()
private cn.taketoday.web.reactive.function.client.ExchangeStrategies	initExchangeStrategies()
private List<cn.taketoday.web.reactive.function.client.ExchangeFilterFunction>	initFilters()
private cn.taketoday.http.HttpHeaders	initHeaders()
private cn.taketoday.web.util.UriBuilderFactory	initUriBuilderFactory()
WebTestClient.Builder	responseTimeout(Duration timeout)	Max amount of time to wait for responses.
WebTestClient.Builder	uriBuilderFactory(cn.taketoday.web.util.UriBuilderFactory uriBuilderFactory)	Provide a pre-configured UriBuilderFactory instance as an alternative to and effectively overriding WebTestClient.Builder.baseUrl(String).

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

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

字段详细资料

reactorNettyClientPresent

private static final boolean reactorNettyClientPresent

reactorNetty2ClientPresent

private static final boolean reactorNetty2ClientPresent

jettyClientPresent

private static final boolean jettyClientPresent

httpComponentsClientPresent

private static final boolean httpComponentsClientPresent

connector

@Nullable
private cn.taketoday.http.client.reactive.ClientHttpConnector connector

baseUrl

@Nullable
private String baseUrl

uriBuilderFactory

@Nullable
private cn.taketoday.web.util.UriBuilderFactory uriBuilderFactory

defaultHeaders

@Nullable
private cn.taketoday.http.HttpHeaders defaultHeaders

defaultCookies

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

filters

@Nullable
private List<cn.taketoday.web.reactive.function.client.ExchangeFilterFunction> filters

entityResultConsumer

private Consumer<EntityExchangeResult<?>> entityResultConsumer

strategies

@Nullable
private cn.taketoday.web.reactive.function.client.ExchangeStrategies strategies

strategiesConfigurers

@Nullable
private List<Consumer<cn.taketoday.web.reactive.function.client.ExchangeStrategies.Builder>> strategiesConfigurers

responseTimeout

@Nullable
private Duration responseTimeout

构造器详细资料

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder()

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder(@Nullable
 cn.taketoday.http.client.reactive.ClientHttpConnector connector)

DefaultWebTestClientBuilder

DefaultWebTestClientBuilder(DefaultWebTestClientBuilder other)

Copy constructor.

方法详细资料

baseUrl

public WebTestClient.Builder baseUrl(String baseUrl)

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

Configure a base URI as described in WebClient.create(String).

指定者:

baseUrl 在接口中 WebTestClient.Builder

uriBuilderFactory

public WebTestClient.Builder uriBuilderFactory(cn.taketoday.web.util.UriBuilderFactory uriBuilderFactory)

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

Provide a pre-configured UriBuilderFactory instance as an alternative to and effectively overriding WebTestClient.Builder.baseUrl(String).

指定者:

uriBuilderFactory 在接口中 WebTestClient.Builder

defaultHeader

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

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

Add the given header to all requests that haven't added it.

指定者:

defaultHeader 在接口中 WebTestClient.Builder

参数:

header - the header name

values - the header values

defaultHeaders

public WebTestClient.Builder defaultHeaders(Consumer<cn.taketoday.http.HttpHeaders> headersConsumer)

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

Manipulate the default headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

指定者:

defaultHeaders 在接口中 WebTestClient.Builder

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

initHeaders

private cn.taketoday.http.HttpHeaders initHeaders()

defaultCookie

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

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

Add the given header to all requests that haven't added it.

指定者:

defaultCookie 在接口中 WebTestClient.Builder

参数:

cookie - the cookie name

values - the cookie values

defaultCookies

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

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

Manipulate the default cookies with the given consumer. The map provided to the consumer is "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other MultiValueMap methods.

指定者:

defaultCookies 在接口中 WebTestClient.Builder

参数:

cookiesConsumer - a function that consumes the cookies map

返回:

this builder

initCookies

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

filter

public WebTestClient.Builder filter(cn.taketoday.web.reactive.function.client.ExchangeFilterFunction filter)

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

Add the given filter to the filter chain.

指定者:

filter 在接口中 WebTestClient.Builder

参数:

filter - the filter to be added to the chain

filters

public WebTestClient.Builder filters(Consumer<List<cn.taketoday.web.reactive.function.client.ExchangeFilterFunction>> filtersConsumer)

从接口复制的说明: WebTestClient.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 在接口中 WebTestClient.Builder

参数:

filtersConsumer - a function that consumes the filter list

返回:

this builder

initFilters

private List<cn.taketoday.web.reactive.function.client.ExchangeFilterFunction> initFilters()

entityExchangeResultConsumer

public WebTestClient.Builder entityExchangeResultConsumer(Consumer<EntityExchangeResult<?>> entityResultConsumer)

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

Configure an EntityExchangeResult callback that is invoked every time after a response is fully decoded to a single entity, to a List of entities, or to a byte[]. In effect, equivalent to each and all of the below but registered once, globally:

 client.get().uri("/accounts/1")
         .exchange()
         .expectBody(Person.class).consumeWith(exchangeResult -> ... ));

 client.get().uri("/accounts")
         .exchange()
         .expectBodyList(Person.class).consumeWith(exchangeResult -> ... ));

 client.get().uri("/accounts/1")
         .exchange()
         .expectBody().consumeWith(exchangeResult -> ... ));
 

Note that the configured consumer does not apply to responses decoded to Flux<T> which can be consumed outside the workflow of the test client, for example via reactor.test.StepVerifier.

指定者:

entityExchangeResultConsumer 在接口中 WebTestClient.Builder

参数:

entityResultConsumer - the consumer to apply to entity responses

返回:

the builder

codecs

public WebTestClient.Builder codecs(Consumer<cn.taketoday.http.codec.ClientCodecConfigurer> configurer)

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

Configure the codecs for the WebClient in the underlying ExchangeStrategies.

指定者:

codecs 在接口中 WebTestClient.Builder

参数:

configurer - the configurer to apply

exchangeStrategies

public WebTestClient.Builder exchangeStrategies(cn.taketoday.web.reactive.function.client.ExchangeStrategies strategies)

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

Configure the ExchangeStrategies to use.

For most cases, prefer using WebTestClient.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 在接口中 WebTestClient.Builder

参数:

strategies - the strategies to use

exchangeStrategies

public WebTestClient.Builder exchangeStrategies(Consumer<cn.taketoday.web.reactive.function.client.ExchangeStrategies.Builder> configurer)

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

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

指定者:

exchangeStrategies 在接口中 WebTestClient.Builder

apply

public WebTestClient.Builder apply(WebTestClientConfigurer configurer)

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

Apply the given configurer to this builder instance.

This can be useful for applying pre-packaged customizations.

指定者:

apply 在接口中 WebTestClient.Builder

参数:

configurer - the configurer to apply

responseTimeout

public WebTestClient.Builder responseTimeout(Duration timeout)

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

Max amount of time to wait for responses.

By default 5 seconds.

指定者:

responseTimeout 在接口中 WebTestClient.Builder

参数:

timeout - the response timeout value

clientConnector

public WebTestClient.Builder clientConnector(cn.taketoday.http.client.reactive.ClientHttpConnector connector)

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

Set the ClientHttpConnector to use.

By default, this is initialized and set internally. However, the connector may also be prepared externally and passed via WebTestClient.bindToServer(ClientHttpConnector) such as for MockMvcWebTestClient tests, and in that case you can use this from WebTestClient.mutateWith(WebTestClientConfigurer) to replace it.

指定者:

clientConnector 在接口中 WebTestClient.Builder

参数:

connector - the connector to use

build

public WebTestClient build()

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

Build the WebTestClient instance.

指定者:

build 在接口中 WebTestClient.Builder

initConnector

private static cn.taketoday.http.client.reactive.ClientHttpConnector initConnector()

initExchangeStrategies

private cn.taketoday.web.reactive.function.client.ExchangeStrategies initExchangeStrategies()

initUriBuilderFactory

private cn.taketoday.web.util.UriBuilderFactory initUriBuilderFactory()