RestTemplate Java调用restful接口

最新推荐文章于 2024-09-03 07:45:00 发布
最新推荐文章于 2024-09-03 07:45:00 发布
阅读量2.7k 收藏 7
点赞数
文章标签： restful RestTemplate
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42627162/article/details/129125608
版权
本文详细介绍了Spring的RestTemplate类，用于简化RESTful接口调用。主要内容包括GET请求的getForObject和getForEntity方法，POST请求的设置请求头和请求体，以及put、delete、options预检请求、exchange()和execute()的万能调用。还提到了如何处理调用失败时的返回体，并提供了相关代码示例。
摘要由CSDN通过智能技术生成

目录

RestTemplate 一种调用RESTful接口的方式，它简化了与HTTP服务器的通信，并实施了RESTful原则。（拦截器相关有时间整理）

# 使用前说明：

  1. 在新版本springboot中直接使用@Autowired注解注入RestTemplate
  2. 老版本springboot以及spring项目需要手动添加配置，配置如下：
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class WebConfiguration {

	@Bean
	public RestTemplate restTemplate() {
		return new RestTemplate();
	}
}

在需要的类中加入@Autowired RestTemplate 注入成功后就可以调用api来访问三方接口了。

  1. 在RestTemplate类中，不管是get还是post请求都是RestTemplate自己封装的方法，里面调用的都是函数 execute();exectue方法则是调用的包级别的<T> T doExecute(URI url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor)；如果RestTemplate提供的get和post等相关方法不满足需求，可以调用 execute();
  2. 不管是get、post相关方法还是exectue()方法如果请求失败都会直接抛出throws RestClientException异常，导致无法获取到异常时的响应内容。如果想获取响应内容需要在配置里重写方法，具体配置见 获取调用失败的返回体
  3. RestTemplate默认依赖于标准JDK建立HTTP连接。可以通过setRequestFactory属性切换到使用其他http源，如 Apache HttpComponents, Netty, and OkHttp
  4. RestTemplate中每个HTTP方法都有三个变体，分别是 接受URI模板字符串、URI变量（数组或映射）和 URI 类。通常3种均可，但是如果使用前两种时url参数或模板已经被编码，那么调用后将发生双重编码，建议直接传入 URI 类。

1. GET请求相关方法

（1）getForObject

  • <T> T getForObject() get方法请求，返回泛型T对应响应体中数据。以下是其三个重载方法。

<T> T getForObject(String url, Class<T> responseType, Object... urlVariables) 参数依次为：字符串类型url，T类型响应类型，Object类型url参数
<T> T getForObject(String url, Class<T> responseType, Map<String, ?> urlVariables)字符串类型url，T类型响应类型，Map类型url参数
<T> T getForObject(URI url, Class<T> responseType) URI 以及响应类型

调用示例：(无参调用以及两种url参数调用，URI不作演示，其余方法都相同)

String url = "http://localhost:8080/testGet";
JSONObject responseObj = restTemplate.getForObject(url, JSONObject.class);

String url1 = "http://localhost:8080/testGet1/{1}/{2}";
JSONObject responseObj = restTemplate.getForObject(url1, JSONObject.class, "11", "22");

String url2 = "http://localhost:8080/testGet2?a={param1}&b={param2}";
Map<String, String> uriVariables = new HashMap<>();
uriVariables.put("param1", "aaaa");
uriVariables.put("param2", "bbbbb");
JSONObject responseObj = restTemplate.getForObject(url1, JSONObject.class, uriVariables );

（2）getForEntity

  • <T> ResponseEntity<T> getForEntity get请求，返回ResponseEntity类型除响应体外的 头信息、状态码等。方法参数同上。

<T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... urlVariables)
<T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> urlVariables)
<T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType)

调用示例：

String url = "http://localhost:8080/testGet";
ResponseEntity<JSONObject> responseEntity = restTemplate.getForEntity(url, JSONObject.class);
JSONObject responseBody =  responseEntity .getBody();// 获取body
HttpStatus statusCode = responseEntity .getStatusCode(); // 状态码
HttpHeaders headers = responseEntity .getHeaders(); // 获取header

2. POST请求相关

设置请求头和请求体：HttpEntity

post系列请求比get请求多了一个Object类型的request参数，比如<T> T postForObject(URI url, Object request, Class<T> responseType)。这个参数一般用HttpEntity<T>来传参。感兴趣的小伙伴可以去源码里看看这个类的几个构造函数。
HttpEntity(T body, MultiValueMap<String, String> headers):
写几个例子：

// 没有headers和body可以直接设置null或者 new HttpEntity();
HttpEntity request = new HttpEntity();

// 只有headers
HttpHeaders headers = new HttpHeaders(); 
headers.setContentType(MediaType.APPLICATION_JSON);
// 也可用MultiValueMap<String, String> headers来创建headers
HttpEntity request = new HttpEntity(headers);

// 只有body
String json = "{\"auth\": \"1111\"}";
HttpEntity<JSONObject> requestEntity = new HttpEntity<JSONObject>(JSONObject.parseObject(json ));

//headers和body
HttpEntity<JSONObject> requestEntity = new HttpEntity<JSONObject>(JSONObject.parseObject(requestBody),headers);

组合好请求体就可以调用下面的方法来调接口了。

（1）postForLocation

URI postForLocation() 返回URI，多数场景为返回post添加的数据的URI
三种参数方法：
URI postForLocation(String url, Object request, Object... urlVariables)
URI postForLocation(String url, Object request, Map<String, ?> urlVariables)
URI postForLocation(URI url, Object request)

（2）postForObject

<T> T postForObject 返回响应体
同样，三种参数
<T> T postForObject(String url, Object request, Class<T> responseType, Object... uriVariables)
<T> T postForObject(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables)
<T> T postForObject(URI url, Object request, Class<T> responseType)

（3）postForEntity

<T> ResponseEntity<T> postForEntity返回ResponseEntity
三种参数
<T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Object... uriVariables)
<T> ResponseEntity<T> postForEntity(String url, Object request, Class<T> responseType, Map<String, ?> uriVariables)
<T> ResponseEntity<T> postForEntity(URI url, Object request, Class<T> responseType)

post系列这里放一个完整的示例：

String url = "http://localhost:8080/testPost";
HttpHeaders headers = new HttpHeaders(); 
headers.setContentType(MediaType.APPLICATION_JSON);
String json = "{\"auth\": \"1111\"}";
HttpEntity<JSONObject> requestEntity = new HttpEntity<JSONObject>(JSONObject.parseObject(requestBody),headers);

ResponseEntity<JSONObject> responseObj = restTemplate.postForEntity(url,requestEntity,JSONObject.class);
JSONObject responseBody = responseObj.getBody();

3. put、delete

只列方法，调用参数和以上相同，没有返回值。
void put(String url, Object request, Object... urlVariables)
void put(String url, Object request, Map<String, ?> urlVariables)
void put(URI url, Object request)

void delete(String url, Object... urlVariables)
void delete(String url, Map<String, ?> urlVariables)
void delete(URI url)

4. options 预检请求

返回的是headers.getAllow();
三种调用方法：
Set<HttpMethod> optionsForAllow(String url, Object... urlVariables)
Set<HttpMethod> optionsForAllow(String url, Map<String, ?> urlVariables)
Set<HttpMethod> optionsForAllow(URI url)

5. exchange()万能调用

相对于其他方法，我更喜欢用这个方法来进行一些封装，比较灵活，支持 GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE。返回类型固定为ResponseEntity<T>

具体方法如下：（前两个方法主要是参数Class<T> responseType 和ParameterizedTypeReference<T> responseType的不同，每个方法各自有三种url的传递方式，这里只列一种；后两个方法是把请求url和请求体等信息统一封装到RequestEntity类中，看需求和习惯选择调用）。

  • <T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables)
  • <T> ResponseEntity<T> exchange(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Object... uriVariables)
  • <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, Class<T> responseType)
  • <T> ResponseEntity<T> exchange(RequestEntity<?> requestEntity, ParameterizedTypeReference<T> responseType)

调用示例：

String url = "http://localhost:8080/testPost";
HttpHeaders headers = new HttpHeaders(); 
headers.setContentType(MediaType.APPLICATION_JSON);
String json = "{\"auth\": \"1111\"}";
HttpEntity<JSONObject> requestEntity = new HttpEntity<JSONObject>(JSONObject.parseObject(requestBody),headers);
ResponseEntity<JSONObject> responseEntity = restTemplate.exchange(url, HttpMethod.POST, requestEntity,JSONObject.class);

6. execute()万能调用

和exchange方法一样，只不过这个方法是所有封装方法的底层调用，返回的是泛型T的响应体对象。

  • <T> T execute(String url, HttpMethod method, RequestCallback requestCallback, ResponseExtractor<T> responseExtractor, Object... urlVariables)
    也有三种url参数调用，不列了。
    调用示例，看源码：
@Override
public <T> ResponseEntity<T> exchange(URI url, HttpMethod method, HttpEntity<?> requestEntity,
		Class<T> responseType) throws RestClientException {

	RequestCallback requestCallback = httpEntityCallback(requestEntity, responseType);
	ResponseExtractor<ResponseEntity<T>> responseExtractor = responseEntityExtractor(responseType);
	return execute(url, method, requestCallback, responseExtractor);
}

7. 获取调用失败的返回体

restTemplate默认调用失败时抛出异常 RestClientException，因此正常是无法获取到调用失败时的返回信息，会直接抛出异常。
在这里插入图片描述
比如postman测试调用失败时会返回 ：

{
    "error": {
        "message": "Tenant [6d16e50f0cf142b398cbb643cb78be51] token is expired. ",
        "code": "Common.0013"
    }
}

想获取内容需要设置一下 restTemplate类的errorHandler。
在这里插入图片描述
具体操作：之前注入bean时新增如下：

import java.io.IOException;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.web.client.ResponseErrorHandler;
import org.springframework.web.client.RestTemplate;

@Configuration
public class WebConfiguration {

	@Bean
	public RestTemplate restTemplate() {
		RestTemplate restTemplate = new RestTemplate();
		restTemplate.setErrorHandler(new getErrorBodyHandler());
		return restTemplate;
	}
	
	public static class getErrorBodyHandler implements ResponseErrorHandler{
		@Override
		public boolean hasError(ClientHttpResponse response) throws IOException {
			return false;
		}
		@Override
		public void handleError(ClientHttpResponse response) throws IOException {
		}
	}
}

调用示例：

ResponseEntity<Object> responeEntity =  restTemplate.postForEntity(url, requestEntity, Object.class);
HttpStatus httpStatus = responeEntity.getStatusCode();
			
if (HttpStatus.OK.equals(httpStatus) || HttpStatus.CREATED.equals(httpStatus)) {
	HttpHeaders responseHeaders =  responeEntity.getHeaders();
	String token = responseHeaders.get("X-Subject-Token").get(0);
				
	if (!StringUtils.isBlank(token)) {
			tokenString = token;
			return tokenString;
		}
	} else {
	// 调用失败
		LinkedHashMap<String, String> errorHashMap =  (LinkedHashMap<String, String>)requestEntity.getBody().get("error");
		logger.error(errorHashMap.get("message")+","+errorHashMap.get("code"));
	}
星星也会数人类嘛
关注
Java调用RESTful接口的几种方式
JipForth的博客
09-16 850
可以通过Maven或Gradle将HttpClient库添加到Java项目中。RestTemplate是Spring框架提供的一个强大的RESTful客户端，可以简化RESTful接口的调用过程。在Java中，我们可以通过多种方式来调用RESTful接口，下面将介绍几种常用的方式，并提供相应的源代码示例。以上是Java调用RESTful接口的几种常用方式，你可以根据自己的需求和项目环境选择合适的方式来进行接口调用。无论使用哪种方式，重要的是要了解接口的URL、请求方法和参数，并处理好请求和响应的数据。
RestTemplate调用rest接口
kehan666的博客
06-08 888
RestTemplate调用rest接口 应用层：HTTP 传输层：TCP（传输控制协议） 保证通信数据有序可靠 端口号：80 网络层：IP地址 DNS域名服务器解析域名 数据链路层&物理层：完成数据传输 一次http请求的过程： 1，域名解析为ip地址 2，向服务器ip+端口号建立TCP连接 连接成功 3，发送http请求，并得到响应 4，浏览器渲染并展示HTML URL的组成http://www.example.com/ http: schema协议 可以省略（浏览器默认的） 域名后面可以跟
使用Java实现RESTful API：设计原则与实现技巧
最新发布
省赚客开发者博客
09-03 656
RESTful API是一种基于HTTP协议的网络服务接口，它使用标准的HTTP方法来实现资源的创建、检索、更新和删除。GET用于获取资源，POST用于创建资源，PUT用于更新资源，DELETE用于删除资源。大家好，我是微赚淘客返利系统3.0的小编，是个冬天不穿秋裤，天冷也要风度的程序猿！URI应该简洁、直观，使用名词而非动词，并且能够反映出资源之间的关系。编写清晰的API文档，并遵循RESTful API设计的最佳实践。请求和响应体应该使用JSON或XML格式，遵循一定的结构。
三种方法实现java调用Restful接口
热门推荐
来啊快活啊的博客
04-19 7万+
1,基本介绍Restful接口的调用，前端一般使用ajax调用，后端可以使用的方法比较多，　　本次介绍三种：　　　　1.HttpURLConnection实现　　　　2.HttpClient实现　　　　3.Spring的RestTemplate 　　　　2，HttpURLConnection实现@Controller public class RestfulAction { @Autowir
Java 调用Restful API接口的几种方式(HTTPS)
08-28
主要介绍了Java 调用Restful API接口的几种方式(HTTPS)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
java调用restful接口_Java访问restful接口
weixin_42422285的博客
02-12 384
其实java访问restful接口和访问一般的接口一样的，案例如下：private Map getIpMap(Map map, String today) {//json模板String request_tpl = "{\"type-a\" : {\"properties\" : { \"value\" : {\"type\":\"long\"} }}}";String targetURL = "...
浅谈java调用Restful API接口的方式
08-28
本文将详细介绍Java调用Restful API接口的方式，包括使用HttpURLConnection、HttpClient和Spring的RestTemplate等方式，并对每种方式进行详细的分析和比较。 首先，介绍了使用HttpURLConnection实现Restful接口的...
java调用restful接口_Java调用RESTful接口的几种方式
weixin_33940031的博客
02-12 2043
前端一般通过Ajax来调用，后端调用的方式还是挺多的，比如HttpURLConnection，HttpClient，Spring的RestTemplate服务端代码如下：服务端接口请求的URL：http://localhost:8080/rest/user/getUser/xiaoming/18，设定请求方式为GETpackage com.demo.restful.service.impl;imp...
java调用restful类型接口
yu1354579的博客
06-30 298
java调用restful类型的接口工具类 public class RestfulUtils { //代理地址IP private final static String ip="10.197.1.123"; //代理地址端口 private final static int port = 1180; //get方法这里设置将所有参数放在url中 public static JSONObject doGet(String url){
java对接第三方接口resful_Java调用RESTful接口的几种方式
weixin_39894473的博客
02-27 721
前端一般通过Ajax来调用，后端调用的方式还是挺多的，比如HttpURLConnection，HttpClient，Spring的RestTemplate服务端代码如下：package com.demo.restful.service.impl;import com.demo.restful.model.User;import com.demo.restful.service.UserServic...
Java调用Restful接口
weixin_43980049的博客
03-16 247
POST请求记录： 依赖jar <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.13</version> </dependency> <de
Java 调用Http Rest接口 例子说明
07-07
Java 调用Http Rest接口 例子说明
Java 调用Http Rest接口 例子说明2
07-09
Java 调用Http Rest接口 例子说明2
java调用rest接口服务_java调用rest接口
weixin_31848413的博客
02-28 666
package com.boco.gaia.service.mockalarm.util;import java.io.IOException;import java.text.MessageFormat;import java.util.ArrayList;import java.util.List;import java.util.concurrent.TimeUnit;import org....
SpringBoot入门教程：RestTemplate
人不风流枉少年
11-09 1003
一：简介 通常在Java代码中调用其它http 接口的话会使用HttpClient，不过这个使用起来有些繁琐，Spring中推出了一个简单的RestTemplate用来调用rest api，使用起来非常简单。 二：基础示例 @RestController @RequestMapping("/user") public class UserController { @PostMapping("/regist") public User regist(@RequestBody CreateUs
java调用rest接口
月光疾风的博客
11-21 1万+
package com.boco.gaia.service.mockalarm.util; import java.io.IOException; import java.text.MessageFormat; import java.util.ArrayList; import java.util.List; import java.util.concurrent.TimeUnit; im...
Java调用REST接口（get，post请求方法）
瑶少的博客
06-30 1万+
网上的调用方法实例千奇百怪，以下为本人自己整理的Java调用rest接口方法实例，包含get请求和post请求，可创建工具类方便调用，其中post请求解决了入出参中文乱码问题。 get方式请求 //get方式请求 public String restCallerGet(String path, String param) { //path 接口路径 xxx/xxx/xxx //param 入参 ?xxx=x&xxx=x&xxx=x //接口ip String http
Java中实现RESTful API
weixin_46372265的博客
07-16 797
RESTful API作为现代Web服务的核心，已经广泛应用于各大系统和平台之间的数据交换。然而，对于很多开发者来说，如何在Java中实现一个高效、可靠的RESTful API仍然是一个难题。今天，我们将通过详细的步骤和实战代码，带你从零开始，一步步掌握这项关键技术。REST（Representational State Transfer）是一种架构风格，常用于Web服务开发。RESTful API则是遵循REST架构风格的一种应用程序接口（API）。
java调用restful接口_Java调用RESTful接口的几种方式-Go语言中文社区
weixin_35289035的博客
02-12 317
前端一般通过Ajax来调用，后端调用的方式还是挺多的，比如HttpURLConnection，HttpClient，Spring的RestTemplate服务端代码如下：package com.demo.restful.service.impl;import com.demo.restful.model.User;import com.demo.restful.service.UserServic...
python调用restful api接口的几种方式_Java调用RESTful接口的几种方式
06-03
对于 Python 调用 RESTful API 接口，常见的方式有以下几种： 1. 使用 requests 库发送 HTTP 请求，获取返回结果。requests 库是 Python 中使用最广泛的 HTTP 客户端库之一，具有简单易用、功能强大的特点。 2. 使用 httplib 或者 urllib2 库发送 HTTP 请求，获取返回结果。这两个库是 Python 标准库中的模块，也可以用来发送 HTTP 请求。 3. 使用第三方库，如 http.client、httplib2、treq、aiohttp 等。 对于 Java 调用 RESTful 接口，常见的方式有以下几种： 1. 使用 HttpURLConnection 类发送 HTTP 请求，获取返回结果。HttpURLConnection 是 Java 标准库中的类，可以用来发送 HTTP 请求。 2. 使用 Apache HttpClient 库发送 HTTP 请求，获取返回结果。Apache HttpClient 是 Apache 软件基金会开发的一个 Java HTTP 客户端库，可以用来发送 HTTP 请求。 3. 使用第三方库，如 OkHttp、RestTemplate、Feign、Retrofit 等。这些库都是基于 HttpClient 或者 HttpURLConnection 实现的，提供了更加方便的接口和更加强大的功能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值