程序包 cn.taketoday.web.client.config

类 RestTemplateBuilder

java.lang.Object

cn.taketoday.web.client.config.RestTemplateBuilder

public class RestTemplateBuilder
extends Object

Builder that can be used to configure and create a RestTemplate. Provides convenience methods to register converters, error handlers and UriTemplateHandlers.

By default the built RestTemplate will attempt to use the most suitable ClientHttpRequestFactory, call detectRequestFactory(false) if you prefer to keep the default. In a typical auto-configured application this builder is available as a bean and can be injected whenever a RestTemplate is needed.

从以下版本开始:

4.0

作者:

Stephane Nicoll, Phillip Webb, Andy Wilkinson, Brian Clozel, Dmytro Nosan, Kevin Strijbos, Ilya Lukyanovich, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private final BasicAuthentication	basicAuthentication
private final Set<RestTemplateCustomizer>	customizers
private final Map<String,List<String>>	defaultHeaders
private final boolean	detectRequestFactory
private final ResponseErrorHandler	errorHandler
private final Set<ClientHttpRequestInterceptor>	interceptors
private final Set<HttpMessageConverter<?>>	messageConverters
private final Set<RestTemplateRequestCustomizer<?>>	requestCustomizers
private final Function<ClientHttpRequestFactorySettings,ClientHttpRequestFactory>	requestFactory
private final ClientHttpRequestFactorySettings	requestFactorySettings
private final String	rootUri
private final UriTemplateHandler	uriTemplateHandler

构造器概要

构造器

限定符	构造器	说明
private	RestTemplateBuilder(ClientHttpRequestFactorySettings requestFactorySettings, boolean detectRequestFactory, String rootUri, Set<HttpMessageConverter<?>> messageConverters, Set<ClientHttpRequestInterceptor> interceptors, Function<ClientHttpRequestFactorySettings,ClientHttpRequestFactory> requestFactorySupplier, UriTemplateHandler uriTemplateHandler, ResponseErrorHandler errorHandler, BasicAuthentication basicAuthentication, Map<String,List<String>> defaultHeaders, Set<RestTemplateCustomizer> customizers, Set<RestTemplateRequestCustomizer<?>> requestCustomizers)
	RestTemplateBuilder(RestTemplateCustomizer... customizers)	Create a new RestTemplateBuilder instance.

方法概要

修饰符和类型	方法	说明
private void	addClientHttpRequestInitializer(RestTemplate restTemplate)
RestTemplateBuilder	additionalCustomizers(RestTemplateCustomizer... customizers)	Add RestTemplateCustomizers that should be applied to the RestTemplate.
RestTemplateBuilder	additionalCustomizers(Collection<? extends RestTemplateCustomizer> customizers)	Add RestTemplateCustomizers that should be applied to the RestTemplate.
RestTemplateBuilder	additionalInterceptors(ClientHttpRequestInterceptor... interceptors)	Add additional ClientHttpRequestInterceptors that should be used with the RestTemplate.
RestTemplateBuilder	additionalInterceptors(Collection<? extends ClientHttpRequestInterceptor> interceptors)	Add additional ClientHttpRequestInterceptors that should be used with the RestTemplate.
RestTemplateBuilder	additionalMessageConverters(HttpMessageConverter<?>... messageConverters)	Add additional HttpMessageConverters that should be used with the RestTemplate.
RestTemplateBuilder	additionalMessageConverters(Collection<? extends HttpMessageConverter<?>> messageConverters)	Add additional HttpMessageConverters that should be used with the RestTemplate.
RestTemplateBuilder	additionalRequestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)	Add the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest.
RestTemplateBuilder	additionalRequestCustomizers(Collection<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)	Add the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest.
private static <T> Set<T>	append(Collection<? extends T> collection, Collection<? extends T> additions)
private static <K, V> Map<K,List<V>>	append(Map<K,List<V>> map, K key, V[] values)
RestTemplateBuilder	basicAuthentication(String username, String password)	Add HTTP Basic Authentication to requests with the given username/password pair, unless a custom Authorization header has been set before.
RestTemplateBuilder	basicAuthentication(String username, String password, Charset charset)	Add HTTP Basic Authentication to requests with the given username/password pair, unless a custom Authorization header has been set before.
RestTemplate	build()	Build a new RestTemplate instance and configure it using this builder.
<T extends RestTemplate> T	build(Class<T> restTemplateClass)	Build a new RestTemplate instance of the specified type and configure it using this builder.
ClientHttpRequestFactory	buildRequestFactory()	Build a new ClientHttpRequestFactory instance using the settings of this builder.
<T extends RestTemplate> T	configure(T restTemplate)	Configure the provided RestTemplate instance using this builder.
private static <T> List<T>	copiedListOf(T[] items)
private <T> Set<T>	copiedSetOf(Collection<? extends T> collection)
private <T> Set<T>	copiedSetOf(T... items)
RestTemplateBuilder	customizers(RestTemplateCustomizer... customizers)	Set the RestTemplateCustomizers that should be applied to the RestTemplate.
RestTemplateBuilder	customizers(Collection<? extends RestTemplateCustomizer> customizers)	Set the RestTemplateCustomizers that should be applied to the RestTemplate.
RestTemplateBuilder	defaultHeader(String name, String... values)	Add a default header that will be set if not already present on the outgoing HttpClientRequest.
RestTemplateBuilder	defaultMessageConverters()	Set the HttpMessageConverters that should be used with the RestTemplate to the default set.
RestTemplateBuilder	detectRequestFactory(boolean detectRequestFactory)	Set if the ClientHttpRequestFactory should be detected based on the classpath.
RestTemplateBuilder	errorHandler(ResponseErrorHandler errorHandler)	Set the ResponseErrorHandler that should be used with the RestTemplate.
RestTemplateBuilder	interceptors(ClientHttpRequestInterceptor... interceptors)	Set the ClientHttpRequestInterceptors that should be used with the RestTemplate.
RestTemplateBuilder	interceptors(Collection<ClientHttpRequestInterceptor> interceptors)	Set the ClientHttpRequestInterceptors that should be used with the RestTemplate.
RestTemplateBuilder	messageConverters(HttpMessageConverter<?>... messageConverters)	Set the HttpMessageConverters that should be used with the RestTemplate.
RestTemplateBuilder	messageConverters(Collection<? extends HttpMessageConverter<?>> messageConverters)	Set the HttpMessageConverters that should be used with the RestTemplate.
RestTemplateBuilder	requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)	Set the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest.
RestTemplateBuilder	requestCustomizers(Collection<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)	Set the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest.
RestTemplateBuilder	requestFactory(Class<? extends ClientHttpRequestFactory> requestFactoryType)	Set the ClientHttpRequestFactory class that should be used with the RestTemplate.
RestTemplateBuilder	requestFactory(Function<ClientHttpRequestFactorySettings,ClientHttpRequestFactory> requestFactoryFunction)	Set the request factory function that should be called to provide a ClientHttpRequestFactory each time we build() a new RestTemplate instance.
RestTemplateBuilder	requestFactory(Supplier<ClientHttpRequestFactory> requestFactory)	Set the Supplier of ClientHttpRequestFactory that should be called each time we build() a new RestTemplate instance.
RestTemplateBuilder	rootUri(String rootUri)	Set a root URL that should be applied to each request that starts with '/'.
RestTemplateBuilder	setConnectTimeout(Duration connectTimeout)	Sets the connection timeout on the underlying ClientHttpRequestFactory.
RestTemplateBuilder	setReadTimeout(Duration readTimeout)	Sets the read timeout on the underlying ClientHttpRequestFactory.
RestTemplateBuilder	setSslBundle(cn.taketoday.core.ssl.SslBundle sslBundle)	Sets the SSL bundle on the underlying ClientHttpRequestFactory.
RestTemplateBuilder	uriTemplateHandler(UriTemplateHandler uriTemplateHandler)	Set the UriTemplateHandler that should be used with the RestTemplate.

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

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

字段详细资料

requestFactorySettings

private final ClientHttpRequestFactorySettings requestFactorySettings

detectRequestFactory

private final boolean detectRequestFactory

rootUri

@Nullable
private final String rootUri

messageConverters

@Nullable
private final Set<HttpMessageConverter<?>> messageConverters

interceptors

private final Set<ClientHttpRequestInterceptor> interceptors

requestFactory

@Nullable
private final Function<ClientHttpRequestFactorySettings,ClientHttpRequestFactory> requestFactory

uriTemplateHandler

@Nullable
private final UriTemplateHandler uriTemplateHandler

errorHandler

@Nullable
private final ResponseErrorHandler errorHandler

basicAuthentication

@Nullable
private final BasicAuthentication basicAuthentication

defaultHeaders

private final Map<String,List<String>> defaultHeaders

customizers

private final Set<RestTemplateCustomizer> customizers

requestCustomizers

private final Set<RestTemplateRequestCustomizer<?>> requestCustomizers

构造器详细资料

RestTemplateBuilder

public RestTemplateBuilder(RestTemplateCustomizer... customizers)

Create a new RestTemplateBuilder instance.

参数:

customizers - any RestTemplateCustomizers that should be applied when the RestTemplate is built

RestTemplateBuilder

private RestTemplateBuilder(ClientHttpRequestFactorySettings requestFactorySettings,
 boolean detectRequestFactory,
 @Nullable
 String rootUri,
 @Nullable
 Set<HttpMessageConverter<?>> messageConverters,
 Set<ClientHttpRequestInterceptor> interceptors,
 @Nullable
 Function<ClientHttpRequestFactorySettings,ClientHttpRequestFactory> requestFactorySupplier,
 @Nullable
 UriTemplateHandler uriTemplateHandler,
 @Nullable
 ResponseErrorHandler errorHandler,
 @Nullable
 BasicAuthentication basicAuthentication,
 Map<String,List<String>> defaultHeaders,
 Set<RestTemplateCustomizer> customizers,
 Set<RestTemplateRequestCustomizer<?>> requestCustomizers)

方法详细资料

detectRequestFactory

public RestTemplateBuilder detectRequestFactory(boolean detectRequestFactory)

Set if the ClientHttpRequestFactory should be detected based on the classpath. Default if true.

参数:

detectRequestFactory - if the ClientHttpRequestFactory should be detected

返回:

a new builder instance

rootUri

public RestTemplateBuilder rootUri(String rootUri)

Set a root URL that should be applied to each request that starts with '/'. Since this works by adding a UriTemplateHandler to the RestTemplate, the root URL will only apply when String variants of the RestTemplate methods are used for specifying the request URL. See RootUriTemplateHandler for details.

参数:

rootUri - the root URI or null

返回:

a new builder instance

messageConverters

public RestTemplateBuilder messageConverters(HttpMessageConverter<?>... messageConverters)

Set the HttpMessageConverters that should be used with the RestTemplate. Setting this value will replace any previously configured converters and any converters configured on the builder will replace RestTemplate's default converters.

参数:

messageConverters - the converters to set

返回:

a new builder instance

另请参阅:

• additionalMessageConverters(HttpMessageConverter...)

messageConverters

public RestTemplateBuilder messageConverters(Collection<? extends HttpMessageConverter<?>> messageConverters)

Set the HttpMessageConverters that should be used with the RestTemplate. Setting this value will replace any previously configured converters and any converters configured on the builder will replace RestTemplate's default converters.

参数:

messageConverters - the converters to set

返回:

a new builder instance

另请参阅:

• additionalMessageConverters(HttpMessageConverter...)

additionalMessageConverters

public RestTemplateBuilder additionalMessageConverters(HttpMessageConverter<?>... messageConverters)

Add additional HttpMessageConverters that should be used with the RestTemplate. Any converters configured on the builder will replace RestTemplate's default converters.

参数:

messageConverters - the converters to add

返回:

a new builder instance

另请参阅:

• messageConverters(HttpMessageConverter...)

additionalMessageConverters

public RestTemplateBuilder additionalMessageConverters(Collection<? extends HttpMessageConverter<?>> messageConverters)

Add additional HttpMessageConverters that should be used with the RestTemplate. Any converters configured on the builder will replace RestTemplate's default converters.

参数:

messageConverters - the converters to add

返回:

a new builder instance

另请参阅:

• messageConverters(HttpMessageConverter...)

defaultMessageConverters

public RestTemplateBuilder defaultMessageConverters()

Set the HttpMessageConverters that should be used with the RestTemplate to the default set. Calling this method will replace any previously defined converters.

返回:

a new builder instance

另请参阅:

• messageConverters(HttpMessageConverter...)

interceptors

public RestTemplateBuilder interceptors(ClientHttpRequestInterceptor... interceptors)

Set the ClientHttpRequestInterceptors that should be used with the RestTemplate. Setting this value will replace any previously defined interceptors.

参数:

interceptors - the interceptors to set

返回:

a new builder instance

另请参阅:

• additionalInterceptors(ClientHttpRequestInterceptor...)

interceptors

public RestTemplateBuilder interceptors(Collection<ClientHttpRequestInterceptor> interceptors)

Set the ClientHttpRequestInterceptors that should be used with the RestTemplate. Setting this value will replace any previously defined interceptors.

参数:

interceptors - the interceptors to set

返回:

a new builder instance

另请参阅:

• additionalInterceptors(ClientHttpRequestInterceptor...)

additionalInterceptors

public RestTemplateBuilder additionalInterceptors(ClientHttpRequestInterceptor... interceptors)

Add additional ClientHttpRequestInterceptors that should be used with the RestTemplate.

参数:

interceptors - the interceptors to add

返回:

a new builder instance

另请参阅:

• interceptors(ClientHttpRequestInterceptor...)

additionalInterceptors

public RestTemplateBuilder additionalInterceptors(Collection<? extends ClientHttpRequestInterceptor> interceptors)

Add additional ClientHttpRequestInterceptors that should be used with the RestTemplate.

参数:

interceptors - the interceptors to add

返回:

a new builder instance

另请参阅:

• interceptors(ClientHttpRequestInterceptor...)

requestFactory

public RestTemplateBuilder requestFactory(Class<? extends ClientHttpRequestFactory> requestFactoryType)

Set the ClientHttpRequestFactory class that should be used with the RestTemplate.

参数:

requestFactoryType - the request factory type to use

返回:

a new builder instance

requestFactory

public RestTemplateBuilder requestFactory(Supplier<ClientHttpRequestFactory> requestFactory)

Set the Supplier of ClientHttpRequestFactory that should be called each time we build() a new RestTemplate instance.

参数:

requestFactory - the supplier for the request factory

返回:

a new builder instance

requestFactory

public RestTemplateBuilder requestFactory(Function<ClientHttpRequestFactorySettings,ClientHttpRequestFactory> requestFactoryFunction)

Set the request factory function that should be called to provide a ClientHttpRequestFactory each time we build() a new RestTemplate instance.

参数:

requestFactoryFunction - the settings to request factory function

返回:

a new builder instance

另请参阅:

• ClientHttpRequestFactories

uriTemplateHandler

public RestTemplateBuilder uriTemplateHandler(UriTemplateHandler uriTemplateHandler)

Set the UriTemplateHandler that should be used with the RestTemplate.

参数:

uriTemplateHandler - the URI template handler to use

返回:

a new builder instance

errorHandler

public RestTemplateBuilder errorHandler(ResponseErrorHandler errorHandler)

Set the ResponseErrorHandler that should be used with the RestTemplate.

参数:

errorHandler - the error handler to use

返回:

a new builder instance

basicAuthentication

public RestTemplateBuilder basicAuthentication(String username,
 String password)

Add HTTP Basic Authentication to requests with the given username/password pair, unless a custom Authorization header has been set before.

参数:

username - the user name

password - the password

返回:

a new builder instance

另请参阅:

• basicAuthentication(String, String, Charset)

basicAuthentication

public RestTemplateBuilder basicAuthentication(String username,
 String password,
 @Nullable
 Charset charset)

Add HTTP Basic Authentication to requests with the given username/password pair, unless a custom Authorization header has been set before.

参数:

username - the user name

password - the password

charset - the charset to use

返回:

a new builder instance

defaultHeader

public RestTemplateBuilder defaultHeader(String name,
 String... values)

Add a default header that will be set if not already present on the outgoing HttpClientRequest.

参数:

name - the name of the header

values - the header values

返回:

a new builder instance

setConnectTimeout

public RestTemplateBuilder setConnectTimeout(Duration connectTimeout)

Sets the connection timeout on the underlying ClientHttpRequestFactory.

参数:

connectTimeout - the connection timeout

返回:

a new builder instance.

setReadTimeout

public RestTemplateBuilder setReadTimeout(Duration readTimeout)

Sets the read timeout on the underlying ClientHttpRequestFactory.

参数:

readTimeout - the read timeout

返回:

a new builder instance.

setSslBundle

public RestTemplateBuilder setSslBundle(cn.taketoday.core.ssl.SslBundle sslBundle)

Sets the SSL bundle on the underlying ClientHttpRequestFactory.

参数:

sslBundle - the SSL bundle

返回:

a new builder instance

customizers

public RestTemplateBuilder customizers(RestTemplateCustomizer... customizers)

Set the RestTemplateCustomizers that should be applied to the RestTemplate. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

参数:

customizers - the customizers to set

返回:

a new builder instance

另请参阅:

• additionalCustomizers(RestTemplateCustomizer...)

customizers

public RestTemplateBuilder customizers(Collection<? extends RestTemplateCustomizer> customizers)

Set the RestTemplateCustomizers that should be applied to the RestTemplate. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

参数:

customizers - the customizers to set

返回:

a new builder instance

另请参阅:

• additionalCustomizers(RestTemplateCustomizer...)

additionalCustomizers

public RestTemplateBuilder additionalCustomizers(RestTemplateCustomizer... customizers)

Add RestTemplateCustomizers that should be applied to the RestTemplate. Customizers are applied in the order that they were added after builder configuration has been applied.

参数:

customizers - the customizers to add

返回:

a new builder instance

另请参阅:

• customizers(RestTemplateCustomizer...)

additionalCustomizers

public RestTemplateBuilder additionalCustomizers(Collection<? extends RestTemplateCustomizer> customizers)

Add RestTemplateCustomizers that should be applied to the RestTemplate. Customizers are applied in the order that they were added after builder configuration has been applied.

参数:

customizers - the customizers to add

返回:

a new builder instance

另请参阅:

• customizers(RestTemplateCustomizer...)

requestCustomizers

public RestTemplateBuilder requestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)

Set the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest. Customizers are applied in the order that they were added. Setting this value will replace any previously configured request customizers.

参数:

requestCustomizers - the request customizers to set

返回:

a new builder instance

另请参阅:

• additionalRequestCustomizers(RestTemplateRequestCustomizer...)

requestCustomizers

public RestTemplateBuilder requestCustomizers(Collection<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)

Set the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest. Customizers are applied in the order that they were added. Setting this value will replace any previously configured request customizers.

参数:

requestCustomizers - the request customizers to set

返回:

a new builder instance

另请参阅:

• additionalRequestCustomizers(RestTemplateRequestCustomizer...)

additionalRequestCustomizers

public RestTemplateBuilder additionalRequestCustomizers(RestTemplateRequestCustomizer<?>... requestCustomizers)

Add the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest. Customizers are applied in the order that they were added.

参数:

requestCustomizers - the request customizers to add

返回:

a new builder instance

另请参阅:

• requestCustomizers(RestTemplateRequestCustomizer...)

additionalRequestCustomizers

public RestTemplateBuilder additionalRequestCustomizers(Collection<? extends RestTemplateRequestCustomizer<?>> requestCustomizers)

Add the RestTemplateRequestCustomizers that should be applied to the ClientHttpRequest. Customizers are applied in the order that they were added.

参数:

requestCustomizers - the request customizers to add

返回:

a new builder instance

另请参阅:

• requestCustomizers(Collection)

build

public RestTemplate build()

Build a new RestTemplate instance and configure it using this builder.

返回:

a configured RestTemplate instance.

另请参阅:

• build(Class)
• configure(RestTemplate)

build

public <T extends RestTemplate> T build(Class<T> restTemplateClass)

Build a new RestTemplate instance of the specified type and configure it using this builder.

类型参数:

T - the type of rest template

参数:

restTemplateClass - the template type to create

返回:

a configured RestTemplate instance.

另请参阅:

• build()
• configure(RestTemplate)

configure

public <T extends RestTemplate> T configure(T restTemplate)

Configure the provided RestTemplate instance using this builder.

类型参数:

T - the type of rest template

参数:

restTemplate - the RestTemplate to configure

返回:

the rest template instance

另请参阅:

• build()
• build(Class)

buildRequestFactory

@Nullable
public ClientHttpRequestFactory buildRequestFactory()

Build a new ClientHttpRequestFactory instance using the settings of this builder.

返回:

a ClientHttpRequestFactory or null

addClientHttpRequestInitializer

private void addClientHttpRequestInitializer(RestTemplate restTemplate)

copiedSetOf

private <T> Set<T> copiedSetOf(T... items)

copiedSetOf

private <T> Set<T> copiedSetOf(Collection<? extends T> collection)

copiedListOf

private static <T> List<T> copiedListOf(T[] items)

append

private static <T> Set<T> append(@Nullable
 Collection<? extends T> collection,
 @Nullable
 Collection<? extends T> additions)

append

private static <K,
V> Map<K,List<V>> append(@Nullable
 Map<K,List<V>> map,
 K key,
 @Nullable
 V[] values)