程序包 cn.taketoday.web.client

类 DefaultRestClientBuilder

java.lang.Object

cn.taketoday.web.client.DefaultRestClientBuilder

所有已实现的接口:

RestClient.Builder

final class DefaultRestClientBuilder
extends Object
implements RestClient.Builder

Default implementation of RestClient.Builder.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private String	baseUrl
private HttpHeaders	defaultHeaders
private Consumer<RestClient.RequestHeadersSpec<?>>	defaultRequest
private Map<String,?>	defaultUriVariables
private static final boolean	gsonPresent
private static final boolean	httpComponentsClientPresent
private List<ClientHttpRequestInitializer>	initializers
private List<ClientHttpRequestInterceptor>	interceptors
private static final boolean	jackson2CborPresent
private static final boolean	jackson2Present
private static final boolean	jackson2SmilePresent
private static final boolean	jdkClientPresent
private static final boolean	jettyClientPresent
private static final boolean	jsonbPresent
private List<HttpMessageConverter<?>>	messageConverters
private ClientHttpRequestFactory	requestFactory
private List<StatusHandler>	statusHandlers
private UriBuilderFactory	uriBuilderFactory

构造器概要

构造器

构造器	说明
DefaultRestClientBuilder()
DefaultRestClientBuilder(DefaultRestClientBuilder other)
DefaultRestClientBuilder(RestTemplate restTemplate)

方法概要

修饰符和类型	方法	说明
RestClient.Builder	apply(Consumer<RestClient.Builder> builderConsumer)	Apply the given Consumer to this builder instance.
RestClient.Builder	baseUrl(String baseUrl)	Configure a base URL for requests.
RestClient	build()	Build the RestClient instance.
RestClient.Builder	clone()	Clone this RestClient.Builder.
private HttpHeaders	copyDefaultHeaders()
RestClient.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.
RestClient.Builder	defaultHeaders(Consumer<HttpHeaders> headersConsumer)	Provide a consumer to access to every default header declared so far, with the possibility to add, replace, or remove.
RestClient.Builder	defaultRequest(Consumer<RestClient.RequestHeadersSpec<?>> defaultRequest)	Provide a consumer to customize every request being built.
RestClient.Builder	defaultStatusHandler(ResponseErrorHandler errorHandler)	Register a default status handler to apply to every response.
RestClient.Builder	defaultStatusHandler(Predicate<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler)	Register a default status handler to apply to every response.
private RestClient.Builder	defaultStatusHandlerInternal(StatusHandler statusHandler)
RestClient.Builder	defaultUriVariables(Map<String,?> defaultUriVariables)	Configure default URL variable values to use when expanding URI templates with a Map.
private HttpHeaders	initHeaders()
private List<ClientHttpRequestInitializer>	initInitializers()
private List<ClientHttpRequestInterceptor>	initInterceptors()
private List<HttpMessageConverter<?>>	initMessageConverters()
private ClientHttpRequestFactory	initRequestFactory()
private UriBuilderFactory	initUriBuilderFactory()
RestClient.Builder	messageConverters(Consumer<List<HttpMessageConverter<?>>> configurer)	Configure the message converters for the RestClient to use.
RestClient.Builder	requestFactory(ClientHttpRequestFactory requestFactory)	Configure the ClientHttpRequestFactory to use.
RestClient.Builder	requestInitializer(ClientHttpRequestInitializer initializer)	Add the given request initializer to the end of the initializer chain.
RestClient.Builder	requestInitializers(Consumer<List<ClientHttpRequestInitializer>> initializersConsumer)	Manipulate the initializers with the given consumer.
RestClient.Builder	requestInterceptor(ClientHttpRequestInterceptor interceptor)	Add the given request interceptor to the end of the interceptor chain.
RestClient.Builder	requestInterceptors(Consumer<List<ClientHttpRequestInterceptor>> interceptorsConsumer)	Manipulate the interceptors with the given consumer.
RestClient.Builder	uriBuilderFactory(UriBuilderFactory uriBuilderFactory)	Provide a pre-configured UriBuilderFactory instance.

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

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

字段详细资料

httpComponentsClientPresent

private static final boolean httpComponentsClientPresent

jettyClientPresent

private static final boolean jettyClientPresent

jdkClientPresent

private static final boolean jdkClientPresent

jackson2Present

private static final boolean jackson2Present

gsonPresent

private static final boolean gsonPresent

jsonbPresent

private static final boolean jsonbPresent

jackson2SmilePresent

private static final boolean jackson2SmilePresent

jackson2CborPresent

private static final boolean jackson2CborPresent

baseUrl

@Nullable
private String baseUrl

defaultUriVariables

@Nullable
private Map<String,?> defaultUriVariables

uriBuilderFactory

@Nullable
private UriBuilderFactory uriBuilderFactory

defaultHeaders

@Nullable
private HttpHeaders defaultHeaders

defaultRequest

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

statusHandlers

@Nullable
private List<StatusHandler> statusHandlers

requestFactory

@Nullable
private ClientHttpRequestFactory requestFactory

messageConverters

@Nullable
private List<HttpMessageConverter<?>> messageConverters

interceptors

@Nullable
private List<ClientHttpRequestInterceptor> interceptors

initializers

@Nullable
private List<ClientHttpRequestInitializer> initializers

构造器详细资料

DefaultRestClientBuilder

public DefaultRestClientBuilder()

DefaultRestClientBuilder

public DefaultRestClientBuilder(DefaultRestClientBuilder other)

DefaultRestClientBuilder

public DefaultRestClientBuilder(RestTemplate restTemplate)

方法详细资料

baseUrl

public RestClient.Builder baseUrl(String baseUrl)

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

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

 String baseUrl = "https://abc.go.com/v1";
 DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl);
 RestClient client = RestClient.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 RestClient.Builder.uriBuilderFactory(UriBuilderFactory). If both are used, the baseUrl value provided here will be ignored.

指定者:

baseUrl 在接口中 RestClient.Builder

返回:

this builder

另请参阅:

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

defaultUriVariables

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

从接口复制的说明: RestClient.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);
 RestClient client = RestClient.builder().uriBuilderFactory(factory).build();
 

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

指定者:

defaultUriVariables 在接口中 RestClient.Builder

返回:

this builder

另请参阅:

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

uriBuilderFactory

public RestClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

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

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

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

指定者:

uriBuilderFactory 在接口中 RestClient.Builder

参数:

uriBuilderFactory - the URI builder factory to use

返回:

this builder

另请参阅:

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

defaultHeader

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

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

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

指定者:

defaultHeader 在接口中 RestClient.Builder

参数:

header - the header name

values - the header values

返回:

this builder

defaultHeaders

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

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

Provide a consumer to access to every default header declared so far, with the possibility to add, replace, or remove.

指定者:

defaultHeaders 在接口中 RestClient.Builder

参数:

headersConsumer - the consumer

返回:

this builder

initHeaders

private HttpHeaders initHeaders()

defaultRequest

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

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

Provide a consumer to customize every request being built.

指定者:

defaultRequest 在接口中 RestClient.Builder

参数:

defaultRequest - the consumer to use for modifying requests

返回:

this builder

defaultStatusHandler

public RestClient.Builder defaultStatusHandler(Predicate<HttpStatusCode> statusPredicate,
 RestClient.ResponseSpec.ErrorHandler errorHandler)

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

参数:

statusPredicate - to match responses with

errorHandler - handler that typically, though not necessarily, throws an exception

返回:

this builder

defaultStatusHandler

public RestClient.Builder defaultStatusHandler(ResponseErrorHandler errorHandler)

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

参数:

errorHandler - handler that typically, though not necessarily, throws an exception

返回:

this builder

defaultStatusHandlerInternal

private RestClient.Builder defaultStatusHandlerInternal(StatusHandler statusHandler)

requestInterceptor

public RestClient.Builder requestInterceptor(ClientHttpRequestInterceptor interceptor)

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

Add the given request interceptor to the end of the interceptor chain.

指定者:

requestInterceptor 在接口中 RestClient.Builder

参数:

interceptor - the interceptor to be added to the chain

返回:

this builder

requestInterceptors

public RestClient.Builder requestInterceptors(Consumer<List<ClientHttpRequestInterceptor>> interceptorsConsumer)

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

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

指定者:

requestInterceptors 在接口中 RestClient.Builder

参数:

interceptorsConsumer - a function that consumes the interceptors list

返回:

this builder

initInterceptors

private List<ClientHttpRequestInterceptor> initInterceptors()

requestInitializer

public RestClient.Builder requestInitializer(ClientHttpRequestInitializer initializer)

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

Add the given request initializer to the end of the initializer chain.

指定者:

requestInitializer 在接口中 RestClient.Builder

参数:

initializer - the initializer to be added to the chain

返回:

this builder

requestInitializers

public RestClient.Builder requestInitializers(Consumer<List<ClientHttpRequestInitializer>> initializersConsumer)

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

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

指定者:

requestInitializers 在接口中 RestClient.Builder

参数:

initializersConsumer - a function that consumes the initializers list

返回:

this builder

initInitializers

private List<ClientHttpRequestInitializer> initInitializers()

requestFactory

public RestClient.Builder requestFactory(ClientHttpRequestFactory requestFactory)

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

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

If no request factory is specified, RestClient uses Apache Http Client, Jetty Http Client if available on the classpath, and defaults to the JDK HttpClient if the java.net.http module is loaded, or to a simple default otherwise.

指定者:

requestFactory 在接口中 RestClient.Builder

参数:

requestFactory - the request factory to use

返回:

this builder

messageConverters

public RestClient.Builder messageConverters(Consumer<List<HttpMessageConverter<?>>> configurer)

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

Configure the message converters for the RestClient to use.

指定者:

messageConverters 在接口中 RestClient.Builder

参数:

configurer - the configurer to apply

返回:

this builder

apply

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

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

Apply the given Consumer to this builder instance.

This can be useful for applying pre-packaged customizations.

指定者:

apply 在接口中 RestClient.Builder

参数:

builderConsumer - the consumer to apply

返回:

this builder

initMessageConverters

private List<HttpMessageConverter<?>> initMessageConverters()

clone

public RestClient.Builder clone()

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

Clone this RestClient.Builder.

指定者:

clone 在接口中 RestClient.Builder

覆盖:

clone 在类中 Object

build

public RestClient build()

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

Build the RestClient instance.

指定者:

build 在接口中 RestClient.Builder

initRequestFactory

private ClientHttpRequestFactory initRequestFactory()

initUriBuilderFactory

private UriBuilderFactory initUriBuilderFactory()

copyDefaultHeaders

@Nullable
private HttpHeaders copyDefaultHeaders()