SpringCloud学习之－RestTemplate使用详解

最新推荐文章于 2024-12-31 00:36:11 发布

weixin_33949359

最新推荐文章于 2024-12-31 00:36:11 发布

阅读量263

点赞数

文章标签： java

原文链接：https://juejin.im/post/5d08a80cf265da1bac4019ee

版权

本文详细探究RestTemplate的使用。它是基于http请求的封装，可根据http请求属性学习其用法。介绍了请求连接和读取时间的设置，可通过传递ClientHttpRequestFactory对象设置；说明了设置请求头可使用exchange方法；还讲解了获取响应头及状态码信息，可通过XXXForEntity方法，也能自定义ResponseErrorHandler。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

上一篇学习了如何使用RestTemplate发送http请求，但是讲解比较简单。所以这篇更加详细的探究一下RestTemplate的使用。

首先我们得知道RestTemplate是基于http请求的封装，所以我们就可以根据http请求相关属性来学习RestTemplate的使用。

1.请求连接时间和读取时间的设置

在http请求中，有一个最大的连接时间和读取时间的设置，那这个在RestTemplate中该怎么设置呢？

	public RestTemplate(ClientHttpRequestFactory requestFactory) {
		this();
		setRequestFactory(requestFactory);
	}
复制代码

查看RestTemplate的构造函数，我们可以传递一个ClientHttpRequestFactory对象进去（通过set方法也可以设置该属性）。查看源码，该对象的默认值是SimpleClientHttpRequestFactory。在SimpleClientHttpRequestFactory对象中，我们就可以设置connectTimeout和readTimeout两个属性了。

2.如何设置请求头

在上一期使用getForObject方法的时候，我们并没有设置请求头相关的属性，如果需要设置该怎么办呢？

这个时候可以使用RestTemplate的exchange方法。

	<T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity,
			Class<T> responseType, Object... uriVariables) throws RestClientException;
复制代码

exchange方法中第三个参数为HttpEntity，在HttpEntity中我们就可以设置请求头相关属性了。

另外，除了getForXXX方法外，像postForObject方法可以直接将HttpEntity对象作为request传进去。RestTemplate会自动解析。

public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType,
		Object... uriVariables) throws RestClientException {

	RequestCallback requestCallback = httpEntityCallback(request, responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
    return execute(url, HttpMethod.POST, requestCallback,responseExtractor, uriVariables);
}
	
public <T> RequestCallback httpEntityCallback(@Nullable Object requestBody, Type responseType) {
	return new HttpEntityRequestCallback(requestBody, responseType);
}

public HttpEntityRequestCallback(@Nullable Object requestBody, @Nullable Type responseType) {
	super(responseType);
	//判断request对象属性是否是HttpEntity
	if (requestBody instanceof HttpEntity) {
		this.requestEntity = (HttpEntity<?>) requestBody;
	}
	else if (requestBody != null) {
		this.requestEntity = new HttpEntity<>(requestBody);
	}
	else {
		this.requestEntity = HttpEntity.EMPTY;
	}
}
复制代码

3.如何获取响应头及状态码信息

如果想要获取响应头相关的信息，可以通过XXXForEntity相关的方法，获取到ResponseEntity对象，通过ResponseEntity对象就可以获取到响应头和响应状态码了。

但是在默认情况下，如果响应的状态码不为200的话，依然会抛出异常。因为默认的ResponseErrorHandler就是这么干的。

        private ResponseErrorHandler errorHandler = new DefaultResponseErrorHandler();

	protected void handleError(ClientHttpResponse response, HttpStatus statusCode) throws IOException {
		String statusText = response.getStatusText();
		HttpHeaders headers = response.getHeaders();
		byte[] body = getResponseBody(response);
		Charset charset = getCharset(response);
		switch (statusCode.series()) {
			case CLIENT_ERROR:
				throw HttpClientErrorException.create(statusCode, statusText, headers, body, charset);
			case SERVER_ERROR:
				throw HttpServerErrorException.create(statusCode, statusText, headers, body, charset);
			default:
				throw new UnknownHttpStatusCodeException(statusCode.value(), statusText, headers, body, charset);
		}
	}
复制代码

如果想自定义的话可以自己实现一个ResponseErrorHandler，

RestTemplate template = new RestTemplate();
template.setErrorHandler(new ResponseErrorHandler() {
    @Override
    public boolean hasError(ClientHttpResponse response) throws IOException {
        return false;
    }
    @Override
    public void handleError(ClientHttpResponse response) throws IOException {
    }
});
复制代码

这样的话即便是返回吗不为200，也不会抛出异常。方便我们更加自定义的编码。