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

类 DefaultWebClient.DefaultRequestBodyUriSpec

java.lang.Object

cn.taketoday.web.reactive.function.client.DefaultWebClient.DefaultRequestBodyUriSpec

所有已实现的接口:

WebClient.RequestBodySpec, WebClient.RequestBodyUriSpec, WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>, WebClient.RequestHeadersUriSpec<WebClient.RequestBodySpec>, WebClient.UriSpec<WebClient.RequestBodySpec>

封闭类:

DefaultWebClient

private class DefaultWebClient.DefaultRequestBodyUriSpec
extends Object
implements WebClient.RequestBodyUriSpec

字段概要

字段

修饰符和类型	字段	说明
private final Map<String,Object>	attributes
private Function<reactor.util.context.Context,reactor.util.context.Context>	contextModifier
private cn.taketoday.util.MultiValueMap<String,String>	cookies
private HttpHeaders	headers
private final HttpMethod	httpMethod
private Consumer<ClientHttpRequest>	httpRequestConsumer
private BodyInserter<?,? super ClientHttpRequest>	inserter
private URI	uri

构造器概要

构造器

构造器	说明
DefaultRequestBodyUriSpec(HttpMethod httpMethod)

方法概要

修饰符和类型	方法	说明
DefaultWebClient.DefaultRequestBodyUriSpec	accept(MediaType... acceptableMediaTypes)	Set the list of acceptable media types, as specified by the Accept header.
DefaultWebClient.DefaultRequestBodyUriSpec	acceptCharset(Charset... acceptableCharsets)	Set the list of acceptable charsets, as specified by the Accept-Charset header.
WebClient.RequestBodySpec	attribute(String name, Object value)	Set the attribute with the given name to the given value.
WebClient.RequestBodySpec	attributes(Consumer<Map<String,Object>> attributesConsumer)	Provides access to every attribute declared so far with the possibility to add, replace, or remove values.
WebClient.RequestHeadersSpec<?>	body(BodyInserter<?,? super ClientHttpRequest> inserter)	Set the body of the request using the given body inserter.
WebClient.RequestHeadersSpec<?>	body(Object producer, cn.taketoday.core.ParameterizedTypeReference<?> elementTypeRef)	Variant of WebClient.RequestBodySpec.body(Publisher, ParameterizedTypeReference) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.
WebClient.RequestHeadersSpec<?>	body(Object producer, Class<?> elementClass)	Variant of WebClient.RequestBodySpec.body(Publisher, Class) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.
<T, P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?>	body(P publisher, cn.taketoday.core.ParameterizedTypeReference<T> elementTypeRef)	Variant of WebClient.RequestBodySpec.body(Publisher, Class) that allows providing element type information with generics.
<T, P extends org.reactivestreams.Publisher<T>> WebClient.RequestHeadersSpec<?>	body(P publisher, Class<T> elementClass)	Shortcut for WebClient.RequestBodySpec.body(BodyInserter) with a Publisher inserter.
WebClient.RequestHeadersSpec<?>	bodyValue(Object body)	Shortcut for WebClient.RequestBodySpec.body(BodyInserter) with a value inserter.
DefaultWebClient.DefaultRequestBodyUriSpec	contentLength(long contentLength)	Set the length of the body in bytes, as specified by the Content-Length header.
DefaultWebClient.DefaultRequestBodyUriSpec	contentType(MediaType contentType)	Set the media type of the body, as specified by the Content-Type header.
WebClient.RequestBodySpec	context(Function<reactor.util.context.Context,reactor.util.context.Context> contextModifier)	Provide a function to populate the Reactor Context.
DefaultWebClient.DefaultRequestBodyUriSpec	cookie(String name, String value)	Add a cookie with the given name and value.
DefaultWebClient.DefaultRequestBodyUriSpec	cookies(Consumer<cn.taketoday.util.MultiValueMap<String,String>> cookiesConsumer)	Provides access to every cookie declared so far with the possibility to add, replace, or remove values.
private HttpRequest	createRequest()
reactor.core.publisher.Mono<ClientResponse>	exchange()	Perform the HTTP request and return a ClientResponse with the response status and headers.
<V> reactor.core.publisher.Flux<V>	exchangeToFlux(Function<ClientResponse,? extends reactor.core.publisher.Flux<V>> responseHandler)	An alternative to WebClient.RequestHeadersSpec.retrieve() that provides more control via access to the ClientResponse.
<V> reactor.core.publisher.Mono<V>	exchangeToMono(Function<ClientResponse,? extends reactor.core.publisher.Mono<V>> responseHandler)	An alternative to WebClient.RequestHeadersSpec.retrieve() that provides more control via access to the ClientResponse.
private cn.taketoday.util.MultiValueMap<String,String>	getCookies()
private HttpHeaders	getHeaders()
DefaultWebClient.DefaultRequestBodyUriSpec	header(String headerName, String... headerValues)	Add the given, single header value under the given name.
DefaultWebClient.DefaultRequestBodyUriSpec	headers(Consumer<HttpHeaders> headersConsumer)	Provides access to every header declared so far with the possibility to add, replace, or remove values.
WebClient.RequestBodySpec	httpRequest(Consumer<ClientHttpRequest> requestConsumer)	Callback for access to the ClientHttpRequest that in turn provides access to the native request of the underlying HTTP library.
DefaultWebClient.DefaultRequestBodyUriSpec	ifModifiedSince(ZonedDateTime ifModifiedSince)	Set the value of the If-Modified-Since header.
DefaultWebClient.DefaultRequestBodyUriSpec	ifNoneMatch(String... ifNoneMatches)	Set the values of the If-None-Match header.
private void	initCookies(cn.taketoday.util.MultiValueMap<String,String> out)
private void	initHeaders(HttpHeaders out)
private ClientRequest.Builder	initRequestBuilder()
private URI	initUri()
WebClient.ResponseSpec	retrieve()	Proceed to declare how to extract the response.
WebClient.RequestBodySpec	uri(String uriTemplate, Object... uriVariables)	Specify the URI for the request using a URI template and URI variables.
WebClient.RequestBodySpec	uri(String uriTemplate, Function<UriBuilder,URI> uriFunction)	Specify the URI starting with a URI template and finishing off with a UriBuilder created from the template.
WebClient.RequestBodySpec	uri(String uriTemplate, Map<String,?> uriVariables)	Specify the URI for the request using a URI template and URI variables.
WebClient.RequestBodySpec	uri(URI uri)	Specify the URI using an absolute, fully constructed URI.
WebClient.RequestBodySpec	uri(Function<UriBuilder,URI> uriFunction)	Specify the URI by through a UriBuilder.

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

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

字段详细资料

httpMethod

private final HttpMethod httpMethod

uri

@Nullable
private URI uri

headers

@Nullable
private HttpHeaders headers

cookies

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

inserter

@Nullable
private BodyInserter<?,? super ClientHttpRequest> inserter

attributes

private final Map<String,Object> attributes

contextModifier

@Nullable
private Function<reactor.util.context.Context,reactor.util.context.Context> contextModifier

httpRequestConsumer

@Nullable
private Consumer<ClientHttpRequest> httpRequestConsumer

构造器详细资料

DefaultRequestBodyUriSpec

DefaultRequestBodyUriSpec(HttpMethod httpMethod)

方法详细资料

uri

public WebClient.RequestBodySpec uri(String uriTemplate,
 Object... uriVariables)

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

Specify the URI for the request using a URI template and URI variables. If a UriBuilderFactory was configured for the client (e.g. with a base URI) it will be used to expand the URI template.

指定者:

uri 在接口中 WebClient.UriSpec<WebClient.RequestBodySpec>

uri

public WebClient.RequestBodySpec uri(String uriTemplate,
 Map<String,?> uriVariables)

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

Specify the URI for the request using a URI template and URI variables. If a UriBuilderFactory was configured for the client (e.g. with a base URI) it will be used to expand the URI template.

指定者:

uri 在接口中 WebClient.UriSpec<WebClient.RequestBodySpec>

uri

public WebClient.RequestBodySpec uri(String uriTemplate,
 Function<UriBuilder,URI> uriFunction)

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

Specify the URI starting with a URI template and finishing off with a UriBuilder created from the template.

指定者:

uri 在接口中 WebClient.UriSpec<WebClient.RequestBodySpec>

uri

public WebClient.RequestBodySpec uri(Function<UriBuilder,URI> uriFunction)

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

Specify the URI by through a UriBuilder.

指定者:

uri 在接口中 WebClient.UriSpec<WebClient.RequestBodySpec>

另请参阅:

• WebClient.UriSpec.uri(String, Function)

uri

public WebClient.RequestBodySpec uri(URI uri)

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

Specify the URI using an absolute, fully constructed URI.

指定者:

uri 在接口中 WebClient.UriSpec<WebClient.RequestBodySpec>

getHeaders

private HttpHeaders getHeaders()

getCookies

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

header

public DefaultWebClient.DefaultRequestBodyUriSpec header(String headerName,
 String... headerValues)

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

Add the given, single header value under the given name.

指定者:

header 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

headers

public DefaultWebClient.DefaultRequestBodyUriSpec headers(Consumer<HttpHeaders> headersConsumer)

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

Provides access to every header declared so far with the possibility to add, replace, or remove values.

指定者:

headers 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

headersConsumer - the consumer to provide access to

返回:

this builder

accept

public DefaultWebClient.DefaultRequestBodyUriSpec accept(MediaType... acceptableMediaTypes)

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

Set the list of acceptable media types, as specified by the Accept header.

指定者:

accept 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

acceptableMediaTypes - the acceptable media types

返回:

this builder

acceptCharset

public DefaultWebClient.DefaultRequestBodyUriSpec acceptCharset(Charset... acceptableCharsets)

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

Set the list of acceptable charsets, as specified by the Accept-Charset header.

指定者:

acceptCharset 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

acceptableCharsets - the acceptable charsets

返回:

this builder

contentType

public DefaultWebClient.DefaultRequestBodyUriSpec contentType(MediaType contentType)

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

Set the media type of the body, as specified by the Content-Type header.

指定者:

contentType 在接口中 WebClient.RequestBodySpec

参数:

contentType - the content type

返回:

this builder

另请参阅:

• HttpHeaders.setContentType(MediaType)

contentLength

public DefaultWebClient.DefaultRequestBodyUriSpec contentLength(long contentLength)

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

Set the length of the body in bytes, as specified by the Content-Length header.

指定者:

contentLength 在接口中 WebClient.RequestBodySpec

参数:

contentLength - the content length

返回:

this builder

另请参阅:

• HttpHeaders.setContentLength(long)

cookie

public DefaultWebClient.DefaultRequestBodyUriSpec cookie(String name,
 String value)

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

Add a cookie with the given name and value.

指定者:

cookie 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

name - the cookie name

value - the cookie value

返回:

this builder

cookies

public DefaultWebClient.DefaultRequestBodyUriSpec cookies(Consumer<cn.taketoday.util.MultiValueMap<String,String>> cookiesConsumer)

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

Provides access to every cookie declared so far with the possibility to add, replace, or remove values.

指定者:

cookies 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

cookiesConsumer - the consumer to provide access to

返回:

this builder

ifModifiedSince

public DefaultWebClient.DefaultRequestBodyUriSpec ifModifiedSince(ZonedDateTime ifModifiedSince)

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

Set the value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

指定者:

ifModifiedSince 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

ifModifiedSince - the new value of the header

返回:

this builder

ifNoneMatch

public DefaultWebClient.DefaultRequestBodyUriSpec ifNoneMatch(String... ifNoneMatches)

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

Set the values of the If-None-Match header.

指定者:

ifNoneMatch 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

ifNoneMatches - the new value of the header

返回:

this builder

attribute

public WebClient.RequestBodySpec attribute(String name,
 Object value)

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

Set the attribute with the given name to the given value.

指定者:

attribute 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

name - the name of the attribute to add

value - the value of the attribute to add

返回:

this builder

attributes

public WebClient.RequestBodySpec attributes(Consumer<Map<String,Object>> attributesConsumer)

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

Provides access to every attribute declared so far with the possibility to add, replace, or remove values.

指定者:

attributes 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

attributesConsumer - the consumer to provide access to

返回:

this builder

context

public WebClient.RequestBodySpec context(Function<reactor.util.context.Context,reactor.util.context.Context> contextModifier)

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

Provide a function to populate the Reactor Context.

指定者:

context 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

contextModifier - the function to modify the context with

httpRequest

public WebClient.RequestBodySpec httpRequest(Consumer<ClientHttpRequest> requestConsumer)

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

Callback for access to the ClientHttpRequest that in turn provides access to the native request of the underlying HTTP library. This could be useful for setting advanced, per-request options that exposed by the underlying library.

指定者:

httpRequest 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

参数:

requestConsumer - a consumer to access the ClientHttpRequest with

返回:

ResponseSpec to specify how to decode the body

bodyValue

public WebClient.RequestHeadersSpec<?> bodyValue(Object body)

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

Shortcut for WebClient.RequestBodySpec.body(BodyInserter) with a value inserter. For example:

 Person person = ... ;

 Mono<Void> result = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .bodyValue(person)
     .retrieve()
     .bodyToMono(Void.class);
 

For multipart requests consider providing MultiValueMap prepared with MultipartBodyBuilder.

指定者:

bodyValue 在接口中 WebClient.RequestBodySpec

参数:

body - the value to write to the request body

返回:

this builder

body

public <T,
P extends org.reactivestreams.Publisher<T>>
WebClient.RequestHeadersSpec<?> body(P publisher,
 cn.taketoday.core.ParameterizedTypeReference<T> elementTypeRef)

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

Variant of WebClient.RequestBodySpec.body(Publisher, Class) that allows providing element type information with generics.

指定者:

body 在接口中 WebClient.RequestBodySpec

类型参数:

T - the type of the elements contained in the publisher

P - the type of the Publisher

参数:

publisher - the Publisher to write to the request

elementTypeRef - the type of elements published

返回:

this builder

body

public <T,
P extends org.reactivestreams.Publisher<T>>
WebClient.RequestHeadersSpec<?> body(P publisher,
 Class<T> elementClass)

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

Shortcut for WebClient.RequestBodySpec.body(BodyInserter) with a Publisher inserter. For example:

 Mono<Person> personMono = ... ;

 Mono<Void> result = client.post()
     .uri("/persons/{id}", id)
     .contentType(MediaType.APPLICATION_JSON)
     .body(personMono, Person.class)
     .retrieve()
     .bodyToMono(Void.class);
 

指定者:

body 在接口中 WebClient.RequestBodySpec

类型参数:

T - the type of the elements contained in the publisher

P - the type of the Publisher

参数:

publisher - the Publisher to write to the request

elementClass - the type of elements published

返回:

this builder

body

public WebClient.RequestHeadersSpec<?> body(Object producer,
 Class<?> elementClass)

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

Variant of WebClient.RequestBodySpec.body(Publisher, Class) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.

指定者:

body 在接口中 WebClient.RequestBodySpec

参数:

producer - the producer to write to the request

elementClass - the type of elements produced

返回:

this builder

body

public WebClient.RequestHeadersSpec<?> body(Object producer,
 cn.taketoday.core.ParameterizedTypeReference<?> elementTypeRef)

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

Variant of WebClient.RequestBodySpec.body(Publisher, ParameterizedTypeReference) that allows using any producer that can be resolved to Publisher via ReactiveAdapterRegistry.

指定者:

body 在接口中 WebClient.RequestBodySpec

参数:

producer - the producer to write to the request

elementTypeRef - the type of elements produced

返回:

this builder

body

public WebClient.RequestHeadersSpec<?> body(BodyInserter<?,? super ClientHttpRequest> inserter)

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

Set the body of the request using the given body inserter. See BodyInserters for built-in BodyInserter implementations.

指定者:

body 在接口中 WebClient.RequestBodySpec

参数:

inserter - the body inserter to use for the request body

返回:

this builder

另请参阅:

• BodyInserters

retrieve

public WebClient.ResponseSpec retrieve()

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

Proceed to declare how to extract the response. For example to extract a ResponseEntity with status, headers, and body:

 Mono<ResponseEntity<Person>> entityMono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .retrieve()
     .toEntity(Person.class);
 

Or if interested only in the body:

 Mono<Person> entityMono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .retrieve()
     .bodyToMono(Person.class);
 

By default, 4xx and 5xx responses result in a WebClientResponseException. To customize error handling, use onStatus handlers.

指定者:

retrieve 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

createRequest

private HttpRequest createRequest()

exchangeToMono

public <V> reactor.core.publisher.Mono<V> exchangeToMono(Function<ClientResponse,? extends reactor.core.publisher.Mono<V>> responseHandler)

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

An alternative to WebClient.RequestHeadersSpec.retrieve() that provides more control via access to the ClientResponse. This can be useful for advanced scenarios, for example to decode the response differently depending on the response status:

 Mono<Person> entityMono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .exchangeToMono(response -> {
         if (response.statusCode().equals(HttpStatus.OK)) {
             return response.bodyToMono(Person.class);
         }
         else {
             return response.createError();
         }
     });
 

Note: After the returned Mono completes, the response body is automatically released if it hasn't been consumed. If the response content is needed, the provided function must declare how to decode it.

指定者:

exchangeToMono 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

类型参数:

V - the type of Object the response will be transformed to

参数:

responseHandler - the function to handle the response with

返回:

a Mono produced from the response

exchangeToFlux

public <V> reactor.core.publisher.Flux<V> exchangeToFlux(Function<ClientResponse,? extends reactor.core.publisher.Flux<V>> responseHandler)

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

An alternative to WebClient.RequestHeadersSpec.retrieve() that provides more control via access to the ClientResponse. This can be useful for advanced scenarios, for example to decode the response differently depending on the response status:

 Flux<Person> entityMono = client.get()
     .uri("/persons")
     .accept(MediaType.APPLICATION_JSON)
     .exchangeToFlux(response -> {
         if (response.statusCode().equals(HttpStatus.OK)) {
             return response.bodyToFlux(Person.class);
         }
         else {
             return response.createError().flux();
         }
     });
 

Note: After the returned Flux completes, the response body is automatically released if it hasn't been consumed. If the response content is needed, the provided function must declare how to decode it.

指定者:

exchangeToFlux 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

类型参数:

V - the type of Objects the response will be transformed to

参数:

responseHandler - the function to handle the response with

返回:

a Flux of Objects produced from the response

exchange

public reactor.core.publisher.Mono<ClientResponse> exchange()

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

Perform the HTTP request and return a ClientResponse with the response status and headers. You can then use methods of the response to consume the body:

 Mono<Person> mono = client.get()
     .uri("/persons/1")
     .accept(MediaType.APPLICATION_JSON)
     .exchange()
     .flatMap(response -> response.bodyToMono(Person.class));

 Flux<Person> flux = client.get()
     .uri("/persons")
     .accept(MediaType.APPLICATION_STREAM_JSON)
     .exchange()
     .flatMapMany(response -> response.bodyToFlux(Person.class));
 

NOTE: Unlike WebClient.RequestHeadersSpec.retrieve(), when using exchange(), it is the responsibility of the application to consume any response content regardless of the scenario (success, error, unexpected data, etc). Not doing so can cause a memory leak. See ClientResponse for a list of all the available options for consuming the body. Generally prefer using WebClient.RequestHeadersSpec.retrieve() unless you have a good reason to use exchange() which does allow to check the response status and headers before deciding how or if to consume the response.

Possibility to leak memory and/or connections; please use WebClient.RequestHeadersSpec.exchangeToMono(Function), WebClient.RequestHeadersSpec.exchangeToFlux(Function); consider also using WebClient.RequestHeadersSpec.retrieve() which provides access to the response status and headers via ResponseEntity along with error status handling.

指定者:

exchange 在接口中 WebClient.RequestHeadersSpec<WebClient.RequestBodySpec>

返回:

a Mono for the response

另请参阅:

• WebClient.RequestHeadersSpec.retrieve()

initRequestBuilder

private ClientRequest.Builder initRequestBuilder()

initUri

private URI initUri()

initHeaders

private void initHeaders(HttpHeaders out)

initCookies

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