RestTemplate 用法详解（一）

最新推荐文章于 2025-04-09 16:03:03 发布
最新推荐文章于 2025-04-09 16:03:03 发布
阅读量2.5k 收藏 7
点赞数 1
分类专栏： SpringBoot 文章标签： restful java spring boot resttemplate
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zfy_220/article/details/120057124
版权

RestTemplate 简介

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

RestTemplate实战使用

        写一个工具类RestUtil，在实际项目中往往使用单例模式来设计RestTemplate

/**
 * RestAPI 调用器
 */
private final static RestTemplate RT;

static {
	SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
	// 设置连接超时时间，单位为毫秒
	requestFactory.setConnectTimeout(30000);
	// 设置读取超时时间，单位为毫秒
	requestFactory.setReadTimeout(30000);
	RT = new RestTemplate(requestFactory);
	// 解决乱码问题
	RT.getMessageConverters().set(1, new StringHttpMessageConverter(StandardCharsets.UTF_8));
}

public static RestTemplate getRestTemplate() {
	return RT;
}

 在其他地方需要使用时只需一列下行代码即可：

private static RestTemplate restTemplate = RestUtil.getRestTemplate();

POST请求

        POST请求中有三个方法，分别是postForEntity，postForObject，postForLocation。这三类方法最直观的就是返回值类型定义不同，具体如下代码所示：

public <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
	RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
	ResponseExtractor<ResponseEntity<T>> responseExtractor = this.responseEntityExtractor(responseType);
	return (ResponseEntity)nonNull(this.execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables));
}

@Nullable
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
	RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
	HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters(), this.logger);
	return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor, (Object[])uriVariables);
}

@Nullable
// 返回值为URI对象，因为Post请求最常用来添加数据，如果需要将刚刚添加成功的数据的URL返回来，此时就可以使用这个方法
public URI postForLocation(String url, @Nullable Object request, Object... uriVariables) throws RestClientException {
	RequestCallback requestCallback = this.httpEntityCallback(request);
	HttpHeaders headers = (HttpHeaders)this.execute(url, HttpMethod.POST, requestCallback, this.headersExtractor(), uriVariables);
	return headers != null ? headers.getLocation() : null;
}

        参数类型分别为：

        1）String url        请求的url路径       

        2）@Nullable Object request        可为空的请求对象

        3）Class<T> responseType        返回类型的类定义

        4）Object... uriVariables        动态的uri参数，可传递多个

        5）Map<String, ?> uriVariables        以Map方式存储的uri参数

1、postForEntity方法

        参数可以是key/value类型也可以是json串

（一）传递key/value参数

        首先在服务端写一个Post请求的接口

@PostMapping(value = "/synchronizationCar")
public String synchronizationCar(@RequestBody MultiValueMap map) {
	System.out.println(map.get("name"));
	System.out.println(map.get("sex"));
	System.out.println(map.get("description"));
	return  "";
}

        客户端请求代码如下：

public static void main(String[] args) {
	HttpHeaders headers = new HttpHeaders();
	MultiValueMap map = new LinkedMultiValueMap();
	map.add("name", "雷锋");
	map.add("sex", "男");
	map.add("description", "乐于助人的好人");
	HttpEntity entity = new HttpEntity<>(map, headers);
	ResponseEntity<String> json = restTemplate.postForEntity("http://localhost:8099/basics/bisBasicsCar/synchronizationCar", entity, String.class);
}

（二）传递json字符串

        首先服务端解析代码如下：

@PostMapping(value = "/synchronizationCar")
public String synchronizationCar(@RequestBody String s) {
	JSONObject jsonObject = JSONObject.parseObject(s);
	JSONArray jsonArray = jsonObject.getJSONArray("data");
	List<BisBasicsCar> list = jsonArray.toJavaList(BisBasicsCar.class);
	System.out.println(list.size());
	return  "ok";
}

        客户端请求代码如下：

private void basicsSynchronization(){

	//车辆表
	List<BisBasicsCar> list = bisBasicsCarMapper.selectList(null);
	HttpHeaders headers = new HttpHeaders();
	headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
	JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(list));
	//object
	JSONObject jsonObject = new JSONObject();
	jsonObject.put("data", jsonArray);
	HttpEntity entity = new HttpEntity<>(jsonObject, headers);
//        String json = restTemplate.postForObject("http://localhost:8099/basics/bisBasicsCar/synchronizationCar", entity, String.class);
	ResponseEntity<String> json = restTemplate.postForEntity("http://localhost:8099/basics/bisBasicsCar/synchronizationCar", entity, String.class);
	if (json != null){
		/*JSONArray users = json.getJSONArray("data");
		list = users.toJavaList(BisBasicsCar.class);*/
	}
}

        此处注意的有以下几点：

        1、key/value传参要使用LinkedMultiValueMap而不是HashMap

        2、笔者使用的json转换是借用alibaba的第三方包fastjson

        3、server端要接收参数需要用@RequestBody注解，不然无法接收到参数

2、postForObject方法

        先看下源码中关于postForObject有三种不同传参的方法

@Nullable
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) throws RestClientException {
	RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
	HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters(), this.logger);
	return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor, (Object[])uriVariables);
}

@Nullable
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
	RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
	HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters(), this.logger);
	return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor, (Map)uriVariables);
}

@Nullable
public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {
	RequestCallback requestCallback = this.httpEntityCallback(request, responseType);
	HttpMessageConverterExtractor<T> responseExtractor = new HttpMessageConverterExtractor(responseType, this.getMessageConverters());
	return this.execute(url, HttpMethod.POST, requestCallback, responseExtractor);
}

        参数可以是Json字符串，JavaBean对象，也可以是map，其中本质都是使用了HttpEntity对象

（一）传递Json字符串

        传递Json字符串需要手动的将Json字符串添加到HttpEntity，具体做法如下：

public void test(){
	//车辆表
	List<BisBasicsCar> list = bisBasicsCarMapper.selectList(null);
	HttpHeaders headers = new HttpHeaders();
	headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
	JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(list));
	//object
	JSONObject jsonObject = new JSONObject();
	jsonObject.put("data", jsonArray);
	HttpEntity entity = new HttpEntity<>(jsonObject, headers);//@1
	String json = restTemplate.postForObject("http://localhost:8099/basics/bisBasicsCar/synchronizationCar", entity, String.class);
}

        @1:将Json字符串添加到HttpEntity 对象中

（二）传递JavaBean

        有两种做法，一种是手动把JavaBean添加到HttpEntity对象中，一种直接传JavaBean对象

public void test2(){
	BisBasicsCar bisBasicsCar = new BisBasicsCar();
	bisBasicsCar.setCarType("轿车");
	bisBasicsCar.setDriver("司机王师傅");
	bisBasicsCar.setLicenseNumber("沪A888888");
	HttpHeaders headers = new HttpHeaders();
	HttpEntity entity = new HttpEntity<>(bisBasicsCar, headers);//@1
	String json = restTemplate.postForObject("http://localhost:8099/basics/bisBasicsCar/synchronizationCar", entity, String.class);
}

public void test3(){
	BisBasicsCar bisBasicsCar = new BisBasicsCar();
	bisBasicsCar.setCarType("轿车");
	bisBasicsCar.setDriver("司机王师傅");
	bisBasicsCar.setLicenseNumber("沪A888888");
	String json = restTemplate.postForObject("http://localhost:8099/basics/bisBasicsCar/synchronizationCar", bisBasicsCar, String.class);//@2
}

        @1:手动将JavaBean加入到HttpEntity 对象中

        @2:直接传JavaBean对象

        为什么说本质上都是使用了HttpEntity对象呢？

        是因为源码中有这样一段代码：

public HttpEntityRequestCallback(@Nullable Object requestBody, @Nullable Type responseType) {
	super(responseType);
	if (requestBody instanceof HttpEntity) {
		this.requestEntity = (HttpEntity)requestBody;
	} else if (requestBody != null) {
		this.requestEntity = new HttpEntity(requestBody);
	} else {
		this.requestEntity = HttpEntity.EMPTY;
	}

}

        程序会自动判断，如果不是HttpEntity对象就手动添加一次

3、postForLocation

        postForLocation也是提交新资源，提交成功之后，返回新资源的URI，postForLocation的参数和前面两种的参数基本一致，只不过该方法的返回值为Uri，这个只需要服务提供者返回一个Uri即可，该Uri表示新资源的位置。

        然后看下列实际代码中会发现，最终还是使用了HttpEntity对象

public HttpEntityRequestCallback(@Nullable Object requestBody) {
	this(requestBody, (Type)null);//@1
}

public HttpEntityRequestCallback(@Nullable Object requestBody, @Nullable Type responseType) {//@2
	super(responseType);
	if (requestBody instanceof HttpEntity) {
		this.requestEntity = (HttpEntity)requestBody;
	} else if (requestBody != null) {
		this.requestEntity = new HttpEntity(requestBody);
	} else {
		this.requestEntity = HttpEntity.EMPTY;
	}

}

        Java多态的方法，但是还在@1的位置处调用了@2的方法

RestTemplate使用
a13763926743的博客
04-19 1582
官网https://docs.spring.io/spring-framework/docs/6.0.11/javadoc-api/org/springframework/web/client/RestTemplate.htmlRestTemplate是一款Spring框架中的HTTP客户端工具类库，它封装了大量的HTTP请求处理代码，使得我们可以方便地进行HTTP请求的发送与处理。
RestTemplate 详解
cnzzs的博客
07-10 1050
背景这段时间自己做的项目中需要调用服务提供者的服务(接口)，具体就是：我这边需要将页面所输入的 Groovy 脚本代码传给别人提供的服务接口，然后那边返回脚本编译的结果给我，我需要将编译结果展示在页面，用的就是 RestTemplate 了，那 RestTemplate 是什么呢？简单说就是：简化了发起 HTTP 请求以及...
RestTemplate实践（及遇到的问题）
Java知音
08-29 1412
作者：duanxzcnblogs.com/duanxz/p/3510622.html在微服务都是以HTTP接口的形式暴露自身服务的，因此在调用远程服务时就必须使用HTTP客户端。我们可以...
spring mvc 中 RestTemplate 全面详解及示例
最新发布
爱的叹息的专栏
04-09 772
spring mvc 中 RestTemplate 全面详解及示例
RestTemplate实践
musi_m的博客
05-13 337
转:http://liuxing.info/2015/05/21/RestTemplate实践/ 什么是RestTemplate？ RestTemplate是Spring提供的用于访问Rest服务的客户端，RestTemplate提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率。 调用RestTemplate的默认构造函数，RestTemplate对象在底层通过使用java....
RestTemplate请求处理时，返回HTTP错误状态码处理记录
SwiftPlus的博客
09-17 956
public void postTest() { String url = "https://xxxxxxxx"; RestTemplate restTemplate = new RestTemplate(); SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); requestFactory.setOutputStreamin
RestTemplate史上最全案例
XIPIKER的博客
03-19 1119
概述 RestTemplate是用来消费REST服务的，所以RestTemplate的主要方法都与REST的HTTP协议的一些方法紧密相连，例如HEAD、GET、POST、PUT、DELETE和OPTIONS等方法，这些方法在RestTemplate类对应的方法为headForHeaders()、getForObject()、postForObject()、put()、delete()等。 实...
Spring RestTemplate具体使用详解
08-26
Spring RestTemplate具体使用详解 RestTemplate是Spring框架中的一种ynchronous客户端HTTP访问的核心类，简化了与HTTP服务器的通信，并强制实施RESTful原则。它处理HTTP连接，让应用程序代码提供URL（可能具有模板...
精讲RestTemplate，POST请求方法使用详解.docx
07-03
最后，我们来看一下 `postForEntity` 的使用方法： ```java @Test public void testPostForEntity() { // 请求地址 String url = "http://jsonplaceholder.typicode.com/posts"; // 请求体 PostDTO postDTO = ...
基于RestTemplate的使用方法(详解)
08-29
`postForObject` 是`RestTemplate` 的核心方法之一，用于执行POST请求，并将响应转换为指定的对象。主要有两种使用方式： #### (1) 传入业务对象 ```java BaseUser baseUser = new BaseUser(); baseUser.setUserid...
Spring RestTemplate的使用详解
别念茶茶
06-09 543
Spring RestTemplate的使用 Spring Boot在1.4版本及之后，Spring Boot不再自动定义一个RestTemplate，而是定义了一个RestTemplateBuilder，允许您更好地控制RestTemplate的对象。你可以在标注了@Bean注解的方法中注入一个RestTemplateBuilder对象的参数来创建一个RestTemplate：（也就是说使用RestTemplate需要添加一个配置类） @Configuration public class Re.
RestTemplate使用详解
热门推荐
玲珑骰子安红豆，入骨相思知不知
11-07 6万+
一、什么是RestTemplate RestTemplate 是从 Spring3.0 开始支持的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。RestTemplate 继承自 InterceptingHttpAccessor 并且实现了 RestOperations 接口，其中 RestOperations 接口定义了基本的 RESTf...
java 单例模板_Spring Boot单例RestTemplate接受标头不断被附加到
weixin_39700548的博客
02-16 777
我正在使用Spring Boot(1.3.0.RELEASE)。我需要使用RestTemplate调用许多不同的RESTWeb服务。显然，我不想每次调用都创建一个RestTemplate的新实例，因此我为RestTemplate的一个实例创建了一个配置，如下所示：@Beanpublic RestTemplate restTemplate() {return new RestTemplate();}...
【Http客户端-1】Http客户端-RestTemplate的使用实例代码
xzb5566的专栏
08-17 450
http 客户端的工具越来越多，每次使用的时候又各有特点，所以在这里总结下各个http 客户端工具的使用，java代码如下。常见的http客户端工具有这些：httpClient， okHttp， RestTemplate，jesryClient【Http客户端】Http客户端-RestTemplate的使用实例代码今天我们说说 RestTemplate工具1. 构建一个RestTemplate 的单例bean当然你也可以直接在方法内部每次使用的时候 new 一个RestTemplate对象。
RestTemplate 使用
lzq199528的博客
12-09 228
1. 项目中创建单例（当然也可以使用时创建实例） @Configuration public class RestTemplateConfig { @Bean(name = "factory") public ClientHttpRequestFactory simpleClientHttpRequestFactory() { SimpleClientHttpReq...
resttemplate使用_RestTemplate的使用
weixin_32346177的博客
01-20 337
技术之路，不进即退 。吾等菜鸡应埋头于技术之路，破甲斩棘。勿做土鸡瓦狗，贪图安逸。今天我就来讲一讲我对于RestTemplate的一些理解，我相信大家肯定很多都会用。我今天把它拿出来讲的原因，就是让不清楚的人通过阅读这篇文章能够直接会用并且能懂得其中大概的原理。其实去年大学毕业到现在我可以说用过这个东西很多次了，由于网上的资料繁杂，所以当时只是单纯想着会用就行，具体的一些琐碎知识并未深究。一 ：概...
RestTemplate的应用
UTF8_8的博客
03-06 725
RestTemplate 是从 Spring3.0 开始支持的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。
RestTemplate详解
qq_62377885的博客
04-14 1万+
现如今的 IT 项目，由服务端向外发起网络请求的场景，基本上处处可见！传统情况下，在服务端代码里访问 http 服务时，一般会使用 JDK 的 HttpURLConnection 或者 Apache 的 HttpClient，不过这种方法使用起来太过繁琐，而且 api 使用起来非常的复杂，还得操心资源回收。以下载文件为例，通过 Apache 的 HttpClient方式进行下载文件，会很复杂其实Spring已经为我们提供了一种简单便捷的模板类来进行操作，它就是RestTemplate。
RestTemplate-postForObject详解、调用Https接口、源码解析，读懂这一篇文章就够了
C18298182575的博客
01-26 8775
RestTemplate 是 Spring 提供的，用于访问Rest服务的同步客户端，提供了一些简单的模板方法API；底层支持多种Http客户端类库，因为RestTemplate只是对其他的HTTP客户端的封装，其本身并没有实现HTTP相关的基础功能，底层实现可以按需配置；SimpleClientHttpRequestFactory，默认配置，对应的JDK自带的HttpURLConnection，不支持Http协议的Patch方法，也无法访问Https请求；
java RestTemplate 使用详解
05-23
Java中的RestTemplate是Spring框架提供的一个用于访问RESTful服务的客户端工具。它提供了一组用于HTTP请求的方法，使得我们能够方便地与RESTful服务进行交互。下面是使用RestTemplate的详细步骤。 1. 引入依赖 在pom.xml文件中引入RestTemplate依赖： ``` <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.3.0.RELEASE</version> </dependency> ``` 2. 创建RestTemplate对象 可以通过Spring的依赖注入来创建RestTemplate对象，也可以直接new一个对象。下面是使用依赖注入创建RestTemplate对象的示例： ``` @Autowired private RestTemplate restTemplate; ``` 3. 发送HTTP请求 RestTemplate提供了多种发送HTTP请求的方法，包括GET、POST、PUT、DELETE等。这里以GET请求为例： ``` String url = "http://example.com/get?param1=value1&param2=value2"; String result = restTemplate.getForObject(url, String.class); ``` 其中，url是请求的URL地址，result是响应的字符串。getForObject()方法会将响应的JSON字符串转换成Java对象并返回。 4. 发送带有参数的HTTP请求 可以通过RestTemplate的exchange()方法发送带有参数的HTTP请求： ``` String url = "http://example.com/post"; MultiValueMap<String, String> params= new LinkedMultiValueMap<>(); params.add("param1", "value1"); params.add("param2", "value2"); HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(params, headers); String result = restTemplate.exchange(url, HttpMethod.POST, requestEntity, String.class).getBody(); ``` 其中，url是请求的URL地址，params是请求的参数，headers是请求头，requestEntity是请求体，result是响应的字符串。 5. 发送带有请求体的HTTP请求 可以通过RestTemplate的postForObject()方法发送带有请求体的HTTP请求： ``` String url = "http://example.com/post"; String requestJson = "{\"param1\":\"value1\",\"param2\":\"value2\"}"; HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); HttpEntity<String> requestEntity = new HttpEntity<>(requestJson, headers); String result = restTemplate.postForObject(url, requestEntity, String.class); ``` 其中，url是请求的URL地址，requestJson是请求的JSON字符串，headers是请求头，requestEntity是请求体，result是响应的字符串。 6. 处理响应 RestTemplate发送的HTTP请求的响应可以是字符串、字节数组、输入流、Java对象等。可以根据需要选择不同的处理方式： ``` // 响应为字符串 String result = restTemplate.getForObject(url, String.class); // 响应为字节数组 byte[] result = restTemplate.getForObject(url, byte[].class); // 响应为输入流 InputStream result = restTemplate.getForObject(url, InputStream.class); // 响应为Java对象 Response response = restTemplate.getForObject(url, Response.class); ``` 这里的Response是一个Java对象，它的属性与响应的JSON字符串对应。可以通过使用Jackson等JSON转换框架将JSON字符串转换成Java对象。 以上就是使用RestTemplate发送HTTP请求的详细步骤。需要注意的是，RestTemplate在处理HTTP请求时，会抛出一些异常，例如HttpStatusCodeException、ResourceAccessException等，需要进行适当的异常处理。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

zfy_220

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值