使用 RestTemplate 发送http请求的正确姿势原来是这样的！

2024-09-02 01:52
文章标签 使用 http 请求 正确 发送 原来 姿势 resttemplate

本文主要是介绍使用 RestTemplate 发送http请求的正确姿势原来是这样的！，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

本文要介绍的这个工具类，是基于RestTemplate做了一层代码封装!!非常好用哦！

  • 第一步添加httpclient依赖包

<dependency><groupId>org.apache.httpcomponents</groupId><artifactId>httpclient</artifactId><version>4.5.6</version>
</dependency>

  • 然后创建一个配置，初始化RestTemplate

@Configuration
public class HttpConfiguration {/*** 初始化RestTemplate* @return*/@ConditionalOnMissingBean(RestTemplate.class)@Beanpublic RestTemplate restTemplate(){RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());return restTemplate;}/*** 使用HttpClient作为底层客户端* @return*/private ClientHttpRequestFactory getClientHttpRequestFactory() {int timeout = 5000;RequestConfig config = RequestConfig.custom().setConnectTimeout(timeout).setConnectionRequestTimeout(timeout).setSocketTimeout(timeout).build();CloseableHttpClient client = HttpClientBuilder.create().setDefaultRequestConfig(config).build();return new HttpComponentsClientHttpRequestFactory(client);}
}

  • 接着 创建一个HttpTemplate类，交给Spring管理

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.*;
import org.springframework.stereotype.Component;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RequestCallback;
import org.springframework.web.client.ResponseExtractor;
import org.springframework.web.client.RestTemplate;import java.net.URI;
import java.util.Arrays;
import java.util.Map;
import java.util.Objects;@Component
public class HttpTemplate {private static final Logger log = LoggerFactory.getLogger(HttpTemplate.class);@Autowiredprivate RestTemplate restTemplate;/*** get请求，返回响应实体（响应业务对象不支持范型）* 支持restful风格* @param url* @param headers* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T get(String url, Map<String, String> headers, Class<T> responseType, Object... uriVariables){ResponseEntity<T> rsp = commonExchange(url, HttpMethod.GET, new HttpEntity<>(createHeaders(headers)), responseType, uriVariables);return buildResponse(rsp);}/*** get请求，返回响应实体（响应业务对象支持范型）* 支持restful风格* @param url* @param headers* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T get(String url, Map<String, String> headers, ParameterizedTypeReference<T> responseType, Object... uriVariables){ResponseEntity<T> rsp = commonExchange(url, HttpMethod.GET, new HttpEntity<>(createHeaders(headers)), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，form表单提交（响应业务对象不支持范型）* 支持restful风格* @param url* @param headers* @param paramMap* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T postByFrom(String url, Map<String, String> headers, Map<String, Object> paramMap, Class<T> responseType, Object... uriVariables){//指定请求头为表单类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_FORM_URLENCODED);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.POST, new HttpEntity<>(createBody(paramMap), httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，form表单提交（响应业务对象支持范型）* 支持restful风格* @param url* @param headers* @param paramMap* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T postByFrom(String url, Map<String, String> headers, Map<String, Object> paramMap, ParameterizedTypeReference<T> responseType, Object... uriVariables){//指定请求头为表单类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_FORM_URLENCODED);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.POST, new HttpEntity<>(createBody(paramMap), httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，json提交（响应业务对象不支持范型）* 支持restful风格* @param url* @param headers* @param request* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T postByJson(String url, Map<String, String> headers, Object request, Class<T> responseType, Object... uriVariables){//指定请求头为json类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.POST, new HttpEntity<>(request, httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，json提交（响应业务对象支持范型）* 支持restful风格* @param url* @param headers* @param request* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T postByJson(String url, Map<String, String> headers, Object request, ParameterizedTypeReference<T> responseType, Object... uriVariables){//指定请求头为json类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.POST, new HttpEntity<>(request, httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，json提交，重定项* 支持restful风格* @param url* @param headers* @param request* @param uriVariables* @return*/public String postForLocation(String url, Map<String, String> headers, Object request, Object... uriVariables){//指定请求头为json类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);URI uri = restTemplate.postForLocation(url, new HttpEntity<>(request, httpHeaders), uriVariables);if(Objects.nonNull(uri)){return uri.toString();}return null;}/*** put请求，json提交（响应业务对象不支持范型）* @param url* @param headers* @param request* @param uriVariables*/public <T> T put(String url, Map<String, String> headers, Object request, Class<T> responseType, Object... uriVariables){//指定请求头为json类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.PUT, new HttpEntity<>(request, httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** put请求，json提交（响应业务对象支持范型）* @param url* @param headers* @param request* @param uriVariables*/public <T> T put(String url, Map<String, String> headers, Object request, ParameterizedTypeReference<T> responseType, Object... uriVariables){//指定请求头为json类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.PUT, new HttpEntity<>(request, httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** delete请求（响应业务对象不支持范型）* @param url* @param headers* @param uriVariables* @return*/public <T> T delete(String url, Map<String, String> headers, Class<T> responseType, Object... uriVariables){ResponseEntity<T> rsp = commonExchange(url, HttpMethod.DELETE, new HttpEntity<>(createHeaders(headers)), responseType, uriVariables);return buildResponse(rsp);}/*** delete请求（响应业务对象支持范型）* @param url* @param headers* @param uriVariables* @return*/public <T> T delete(String url, Map<String, String> headers, ParameterizedTypeReference<T> responseType, Object... uriVariables){ResponseEntity<T> rsp = commonExchange(url, HttpMethod.DELETE, new HttpEntity<>(createHeaders(headers)), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，文件表单上传提交（响应业务对象不支持范型）* 支持restful风格* @param url* @param headers* @param paramMap* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T uploadFile(String url, Map<String, String> headers, MultiValueMap<String, Object> paramMap, Class<T> responseType, Object... uriVariables){//指定请求头为文件&表单类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.MULTIPART_FORM_DATA);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.POST, new HttpEntity<>(paramMap, httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** post请求，文件表单上传提交（响应业务对象支持范型）* 支持restful风格* @param url* @param headers* @param paramMap* @param responseType* @param uriVariables* @param <T>* @return*/public <T> T uploadFile(String url, Map<String, String> headers, MultiValueMap<String, Object> paramMap, ParameterizedTypeReference<T> responseType, Object... uriVariables){//指定请求头为文件&表单类型HttpHeaders httpHeaders = createHeaders(headers);httpHeaders.setContentType(MediaType.MULTIPART_FORM_DATA);ResponseEntity<T> rsp = commonExchange(url, HttpMethod.POST, new HttpEntity<>(paramMap, httpHeaders), responseType, uriVariables);return buildResponse(rsp);}/*** 下载文件* @param url* @param headers* @param uriVariables* @return*/public byte[] downloadFile(String url, Map<String, String> headers, Object... uriVariables){ResponseEntity<byte[]> rsp = commonExchange(url, HttpMethod.GET, new HttpEntity<>(createHeaders(headers)), byte[].class, uriVariables);return buildResponse(rsp);}/*** 下载大文件* @param url* @param headers* @param responseExtractor* @param uriVariables*/public void downloadBigFile(String url, Map<String, String> headers, ResponseExtractor responseExtractor, Object... uriVariables){RequestCallback requestCallback = request -> {//指定请求头信息request.getHeaders().addAll(createHeaders(headers));//定义请求头的接收类型request.getHeaders().setAccept(Arrays.asList(MediaType.APPLICATION_OCTET_STREAM, MediaType.ALL));};restTemplate.execute(url, HttpMethod.GET, requestCallback,responseExtractor, uriVariables);}/*** 公共http请求方法（响应业务对象不支持范型）* @param url* @param method* @param requestEntity* @param responseType* @param uriVariables* @param <T>* @return*/public <T> ResponseEntity<T> commonExchange(String url, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables){return restTemplate.exchange(url, method, requestEntity, responseType, uriVariables);}/*** 公共http请求方法（响应业务对象支持范型）* @param url* @param method* @param requestEntity* @param responseType* @param uriVariables* @param <T>* @return*/public <T> ResponseEntity<T> commonExchange(String url, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Object... uriVariables){return restTemplate.exchange(url, method, requestEntity, responseType, uriVariables);}/*** 封装头部参数* @param headers* @return*/private HttpHeaders createHeaders(Map<String, String> headers){return new HttpHeaders(){{if(headers != null && !headers.isEmpty()){headers.entrySet().forEach(item -> {set(item.getKey(), item.getValue());});}}};}/*** 封装请求体* @param paramMap* @return*/private MultiValueMap<String, Object> createBody(Map<String, Object> paramMap){MultiValueMap<String, Object> valueMap = new LinkedMultiValueMap<>();if(paramMap != null && !paramMap.isEmpty()){paramMap.entrySet().forEach(item -> {valueMap.add(item.getKey(), item.getValue());});}return valueMap;}/*** 返回响应对象* @param rsp* @param <T>* @return*/private <T> T buildResponse(ResponseEntity<T> rsp){if(!rsp.getStatusCode().is2xxSuccessful()){throw new RuntimeException(rsp.getStatusCode().getReasonPhrase());}return rsp.getBody();}
}

当遇到返回的对象是范型类型的时候，我们可以这样操作！

以下面这个/testPostByJsonObj接口为例！

/*** 模拟JSON请求，post方法测试* @param request* @return*/
@RequestMapping(value = "testPostByJsonObj", method = RequestMethod.POST)
public ResponseBeanObj<ResponseBean> testPostByJsonObj(@RequestBody RequestBean requestBean,HttpServletRequest request){HttpServletRequestLog.systemLog(request);//范型测试ResponseBean responseBean = new ResponseBean();responseBean.setCode("200000");responseBean.setMsg("responseBean");//范型测试ResponseBeanObj<ResponseBean> result = new ResponseBeanObj<>();result.setCode("200");result.setMsg("请求成功，方法：testPostByJsonObj，请求参数：" + JSON.toJSONString(requestBean));result.setObj(responseBean);System.out.println(JSON.toJSONString(result));return result;
}

使用RestTemplate工具发起网络请求，代码如下！

//将返回的范型对象包装到ParameterizedTypeReference对象里面
ParameterizedTypeReference<ResponseBeanObj<ResponseBean>> typeRef = new ParameterizedTypeReference<ResponseBeanObj<ResponseBean>>() {};//使用restTemplate发起网络请求
ResponseBeanObj<ResponseBean> responseBean = restTemplate.exchange(url, HttpMethod.POST, request, typeRef);

采用restTemplate.exchange()方法，即可实现返回对象范型类型的反序列化！

如果使用上面封装的HttpTemplate工具进行操作，也更简单，代码如下：

/*** 模拟JSON提交，post请求，范型返回对象测试*/
@Test
public void testPostByJsonObj(){//请求地址String url = "http://localhost:8080/testPostByJsonObj";//入参RequestBean request = new RequestBean();request.setUserName("唐三藏");request.setUserPwd("123456789");//发送post请求ParameterizedTypeReference<ResponseBeanObj<ResponseBean>> typeRef = new ParameterizedTypeReference<ResponseBeanObj<ResponseBean>>() {};//范型测试ResponseBeanObj<ResponseBean> responseBean = httpTemplate.postByJson(url, createHeader("testPostByJsonObj"), request, typeRef);System.out.println(JSON.toJSONString(responseBean));
}

在某些场景下，当你使用restTemplate发起网络请求时，所有的请求头部需要带上统一的参数，例如Authorization鉴权码，what can I do？

那我们可以在RestTemplate初始化之后，添加一个拦截器，然后在拦截器的请求头部统一注入鉴权码，就可以轻松实现全局加入某个参数，方式如下！

/*** 初始化RestTemplate* @return*/
@Bean
public RestTemplate restTemplate(){RestTemplate restTemplate = new RestTemplate(getClientHttpRequestFactory());// 添加一个拦截器，在请求头部添加 Authorization 鉴权码restTemplate.getInterceptors().add((request, body, execution) -> {request.getHeaders().add("Authorization", "xxxxxXXXXX");return execution.execute(request, body);});return restTemplate;
}

最后说一句(求关注!别白嫖！)

如果这篇文章对您有所帮助，或者有所启发的话，求一键三连：点赞、转发、在看。

关注公众号：woniuxgg，在公众号中回复：笔记  就可以获得蜗牛为你精心准备的java实战语雀笔记，回复面试、开发手册、有超赞的粉丝福利！

这篇关于使用 RestTemplate 发送http请求的正确姿势原来是这样的！的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1128667。

相关文章

Java中流式并行操作parallelStream的原理和使用方法

Java中流式并行操作parallelStream的原理和使用方法

《Java中流式并行操作parallelStream的原理和使用方法》本文详细介绍了Java中的并行流（parallelStream）的原理、正确使用方法以及在实际业务中的应用案例,并指出在使用并行流... 目录Java中流式并行操作parallelStream0. 问题的产生1. 什么是parallelS
阅读更多...
Linux join命令的使用及说明

Linux join命令的使用及说明

《Linuxjoin命令的使用及说明》`join`命令用于在Linux中按字段将两个文件进行连接,类似于SQL的JOIN,它需要两个文件按用于匹配的字段排序,并且第一个文件的换行符必须是LF,`jo... 目录一. 基本语法二. 数据准备三. 指定文件的连接key四.-a输出指定文件的所有行五.-o指定输出
阅读更多...
Linux jq命令的使用解读

Linux jq命令的使用解读

《Linuxjq命令的使用解读》jq是一个强大的命令行工具,用于处理JSON数据,它可以用来查看、过滤、修改、格式化JSON数据,通过使用各种选项和过滤器,可以实现复杂的JSON处理任务... 目录一. 简介二. 选项2.1.2.2-c2.3-r2.4-R三. 字段提取3.1 普通字段3.2 数组字段四.
阅读更多...
Linux kill正在执行的后台任务 kill进程组使用详解

Linux kill正在执行的后台任务 kill进程组使用详解

《Linuxkill正在执行的后台任务kill进程组使用详解》文章介绍了两个脚本的功能和区别,以及执行这些脚本时遇到的进程管理问题,通过查看进程树、使用`kill`命令和`lsof`命令,分析了子... 目录零. 用到的命令一. 待执行的脚本二. 执行含子进程的脚本，并kill2.1 进程查看2.2 遇到的
阅读更多...
详解SpringBoot+Ehcache使用示例

详解SpringBoot+Ehcache使用示例

《详解SpringBoot+Ehcache使用示例》本文介绍了SpringBoot中配置Ehcache、自定义get/set方式,并实际使用缓存的过程,文中通过示例代码介绍的非常详细,对大家的学习或者... 目录摘要概念内存与磁盘持久化存储：配置灵活性：编码示例引入依赖：配置ehcache.XML文件：配置
阅读更多...
Java 虚拟线程的创建与使用深度解析

Java 虚拟线程的创建与使用深度解析

《Java虚拟线程的创建与使用深度解析》虚拟线程是Java19中以预览特性形式引入,Java21起正式发布的轻量级线程,本文给大家介绍Java虚拟线程的创建与使用,感兴趣的朋友一起看看吧... 目录一、虚拟线程简介1.1 什么是虚拟线程？1.2 为什么需要虚拟线程？二、虚拟线程与平台线程对比代码对比示例：三
阅读更多...
k8s按需创建PV和使用PVC详解

k8s按需创建PV和使用PVC详解

《k8s按需创建PV和使用PVC详解》Kubernetes中,PV和PVC用于管理持久存储,StorageClass实现动态PV分配,PVC声明存储需求并绑定PV,通过kubectl验证状态,注意回收... 目录1.按需创建 PV（使用 StorageClass）创建 StorageClass2.创建 PV
阅读更多...
Redis 基本数据类型和使用详解

Redis 基本数据类型和使用详解

《Redis基本数据类型和使用详解》String是Redis最基本的数据类型,一个键对应一个值,它的功能十分强大,可以存储字符串、整数、浮点数等多种数据格式,本文给大家介绍Redis基本数据类型和... 目录一、Redis 入门介绍二、Redis 的五大基本数据类型2.1 String 类型2.2 Hash
阅读更多...
Redis中Hash从使用过程到原理说明

Redis中Hash从使用过程到原理说明

《Redis中Hash从使用过程到原理说明》RedisHash结构用于存储字段-值对,适合对象数据,支持HSET、HGET等命令,采用ziplist或hashtable编码,通过渐进式rehash优化... 目录一、开篇：Hash就像超市的货架二、Hash的基本使用1. 常用命令示例2. Java操作示例三
阅读更多...
Linux创建服务使用systemctl管理详解

Linux创建服务使用systemctl管理详解

《Linux创建服务使用systemctl管理详解》文章指导在Linux中创建systemd服务,设置文件权限为所有者读写、其他只读,重新加载配置,启动服务并检查状态,确保服务正常运行,关键步骤包括权... 目录创建服务 /usr/lib/systemd/system/设置服务文件权限：所有者读写js，其他
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2