使用 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。

相关文章

C++ Sort函数使用场景分析

C++ Sort函数使用场景分析

《C++Sort函数使用场景分析》sort函数是algorithm库下的一个函数,sort函数是不稳定的,即大小相同的元素在排序后相对顺序可能发生改变,如果某些场景需要保持相同元素间的相对顺序,可使... 目录C++ Sort函数详解一、sort函数调用的两种方式二、sort函数使用场景三、sort函数排序
阅读更多...
Java String字符串的常用使用方法

Java String字符串的常用使用方法

《JavaString字符串的常用使用方法》String是JDK提供的一个类,是引用类型,并不是基本的数据类型,String用于字符串操作,在之前学习c语言的时候,对于一些字符串,会初始化字符数组表... 目录一、什么是String二、如何定义一个String1. 用双引号定义2. 通过构造函数定义三、St
阅读更多...
springboot filter实现请求响应全链路拦截

springboot filter实现请求响应全链路拦截

《springbootfilter实现请求响应全链路拦截》这篇文章主要为大家详细介绍了SpringBoot如何结合Filter同时拦截请求和响应,从而实现​​日志采集自动化,感兴趣的小伙伴可以跟随小... 目录一、为什么你需要这个过滤器？​​​二、核心实现：一个Filter搞定双向数据流​​​​三、完整代码
阅读更多...
Pydantic中Optional 和Union类型的使用

Pydantic中Optional 和Union类型的使用

《Pydantic中Optional和Union类型的使用》本文主要介绍了Pydantic中Optional和Union类型的使用,这两者在处理可选字段和多类型字段时尤为重要,文中通过示例代码介绍的... 目录简介Optional 类型Union 类型Optional 和 Union 的组合总结简介Pyd
阅读更多...
Nginx中配置HTTP/2协议的详细指南

Nginx中配置HTTP/2协议的详细指南

《Nginx中配置HTTP/2协议的详细指南》HTTP/2是HTTP协议的下一代版本,旨在提高性能、减少延迟并优化现代网络环境中的通信效率,本文将为大家介绍Nginx配置HTTP/2协议想详细步骤,需... 目录一、HTTP/2 协议概述1.HTTP/22. HTTP/2 的核心特性3. HTTP/2 的优
阅读更多...
Vue3使用router,params传参为空问题

Vue3使用router,params传参为空问题

《Vue3使用router,params传参为空问题》：本文主要介绍Vue3使用router,params传参为空问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录vue3使用China编程router,params传参为空1.使用query方式传参2.使用 Histo
阅读更多...
AJAX请求上传下载进度监控实现方式

AJAX请求上传下载进度监控实现方式

《AJAX请求上传下载进度监控实现方式》在日常Web开发中,AJAX（AsynchronousJavaScriptandXML）被广泛用于异步请求数据,而无需刷新整个页面,：本文主要介绍AJAX请... 目录1. 前言2. 基于XMLHttpRequest的进度监控2.1 基础版文件上传监控2.2 增强版多
阅读更多...
使用Python自建轻量级的HTTP调试工具

使用Python自建轻量级的HTTP调试工具

《使用Python自建轻量级的HTTP调试工具》这篇文章主要为大家详细介绍了如何使用Python自建一个轻量级的HTTP调试工具,文中的示例代码讲解详细,感兴趣的小伙伴可以参考一下... 目录一、为什么需要自建工具二、核心功能设计三、技术选型四、分步实现五、进阶优化技巧六、使用示例七、性能对比八、扩展方向建
阅读更多...
使用Python实现一键隐藏屏幕并锁定输入

使用Python实现一键隐藏屏幕并锁定输入

《使用Python实现一键隐藏屏幕并锁定输入》本文主要介绍了使用Python编写一个一键隐藏屏幕并锁定输入的黑科技程序,能够在指定热键触发后立即遮挡屏幕,并禁止一切键盘鼠标输入,这样就再也不用担心自己... 目录1. 概述2. 功能亮点3.代码实现4.使用方法5. 展示效果6. 代码优化与拓展7. 总结1.
阅读更多...
使用Python开发一个简单的本地图片服务器

使用Python开发一个简单的本地图片服务器

《使用Python开发一个简单的本地图片服务器》本文介绍了如何结合wxPython构建的图形用户界面GUI和Python内建的Web服务器功能,在本地网络中搭建一个私人的,即开即用的网页相册,文中的示... 目录项目目标核心技术栈代码深度解析完整代码工作流程主要功能与优势潜在改进与思考运行结果总结你是否曾经
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2