Java小强个人技术博客站点    手机版
当前位置： 首页 >> 开源 >> Spring中RestTemplate用法

Spring中RestTemplate用法

25590 开源 | 2022-1-29

RestTemplate 是从 Spring3.0 开始支持的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。RestTemplate 继承自 InterceptingHttpAccessor 并且实现了 RestOperations 接口，其中 RestOperations 接口定义了基本的 RESTful 操作，这些操作在 RestTemplate 中都得到了实现。接下来我们就来看看这些操作方法的使用。


这里有一个用户查询接口

# http://localhost:8081/user/1
返回格式
{
    "id": 1,
    "username": "java小强",
    "address": "北京市"
}


订单查询接口里面要查询用户信息，这里仅供演示

public Order queryOrderById(Long orderId) {
	// 1.查询订单
	Order order = orderMapper.findById(orderId);
	String url = "http://localhost:8081/user/{userId}";
	Map<String, Object> para = new Hashtable<>();
	para.put("userId", order.getUserId());
	User user = restTemplate.getForObject(url, User.class, para);
	order.setUser(user);
	// 4.返回
	return order;
}


通过代码点进去查看Spring源码，可以看到getForObject有三个重载方法

@Override
@Nullable
public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
	return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
}
@Override
@Nullable
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
	return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
}
@Override
@Nullable
public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
	return execute(url, HttpMethod.GET, requestCallback, responseExtractor);
}

这里使用了加参数的，如果不用Map传递参数，也可以URL中拼接，例如

String url = "http://" + host + ":" + port + "/hello?name="+ URLEncoder.encode(name,"UTF-8");
URI uri = URI.create(url);
ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);

但需要注意的是，这种传参方式，参数如果是中文的话，需要对参数进行编码，使用 URLEncoder.encode 方法来实现。


源码往下，可以看到还有三个返回为ResponseEntity的方法

@Override
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables)
		throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
	return nonNull(execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables));
}

@Override
public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables)
		throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
	return nonNull(execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables));
}

@Override
public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
	return nonNull(execute(url, HttpMethod.GET, requestCallback, responseExtractor));
}

有什么区别？点进去看

public class ResponseEntity<T> extends HttpEntity<T> {
// 省略
}

再进去看HttpEntity实现，看到它有一个HttpHeaders变量

private final HttpHeaders headers;

此时应该知道区别，就是HttpEntity可以获取响应头了。


RestTemplate再往下看可以看到还有专门只获取响应头的方法。

上面代码中getForObject，这个get是指使用get方式请求，如果往下翻源码，就可以看到Post等各种方式请求的调用方法。


QQ截图20220129080340.jpg

推荐您阅读更多有关于“ spring HTTP RestTemplate rest 源码 ”的文章

上一篇：SpringBoot搭建Eureka注册中心 下一篇：SpringBoot集成Redisson初步

猜你喜欢

发表评论：