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

于 2024-09-03 08:27:08 发布
阅读量60 收藏
点赞数
文章标签： http 网络协议 网络
原文链接：https://mp.weixin.qq.com/s/Y7K-8VlGGBCttqCNOpb1dQ
版权

程序员蜗牛g 2024年09月02日 12:03 江苏

本文要介绍的这个工具类，是基于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)
    @Bean
    public 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);


    @Autowired
    private 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;
}

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

竹林幽深
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
RestTemplate 出现401错误
qq_36741679的博客
07-12 9301
以下面post请求为栗子 使用RestTemplate 请求需要TOKEN认证的接口： //请求参数 MultiValueMap<String, String> requestBody = new LinkedMultiValueMap<>(); requestBody.add("param1","dsdd"); requestBody.add("param2","34...
spring组件 RestTemplate + @ResponseBody 使用心得
SwordSnapLiu的博客
02-27 1050
刚刚给公司两个系统写了一个中间件，用于同步一些数据，用了 RestTemplate 这个家伙，确实相当友好，也简化了 http 请求，但是我也走了很多弯路，也被网上的那些各种不完整的博客坑惨了，下面说重点： 一. RestTemplate 简单配置 @Configuration public class RestTemplateConfig { @Bean @Conditi...
Http 请求的4种方式
Tong_zhi的博客
08-09 1717
1. RestTemplate RestTemplate： 是 Spring 提供的用于访问Rest服务的客户端， RestTemplate 提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率。 SpringBoot中先注册bean @Bean public RestTemplate restTemplate(){ return new RestTemplate(); } // 或者 @Bean public RestTe
RestTemplate使用HttpClient连接池
C.
03-03 3892
为什么要用连接池？ 因为使用它可以有效降低延迟和系统开销。如果不采用连接池，每当我们发起http请求时，都需要重新发起Tcp三次握手建立链接，请求结束时还需要四次挥手释放链接。而Tcp链接的建立和释放是有时间和系统开销的。另外每次发起请求时，需要分配一个端口号，请求完毕后在进行回收。使用链接池则可以复用已经建立好的链接，一定程度的避免了建立和释放链接的时间开销。
java中使用restTemplate发送http请求
11-10
在Java开发中，进行HTTP请求是一项常见的任务，`RestTemplate`是Spring框架提供的一种便捷工具，用于发送HTTP请求并处理响应。本篇文章将详细讲解如何使用`RestTemplate`实现POST和GET请求，以及如何设计一个单例...
Spring中使用RestTemplate发送Http请求
2401_83915450的博客
05-03 651
无论是哪家公司，都很重视高并发高可用的技术，重视基础，重视JVM。面试是一个双向选择的过程，不要抱着畏惧的心态去面试，不利于自己的发挥。同时看中的应该不止薪资，还要看你是不是真的喜欢这家公司，是不是能真的得到锻炼。其实我写了这么多，只是我自己的总结，并不一定适用于所有人，相信经过一些面试，大家都会有这些感触。最后我整理了一些面试真题资料，技术知识点剖析教程，还有和广大同仁一起交流学习共同进步，还有一些职业经验的分享。《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门。
RestTemplate发送HTTP请求
热门推荐
钢铁意志
12-27 1万+
Spring 中的 RestTemplate 可以很方便的发送HTTP请求，来看看如何使用 RestTemplate 发送 GET 请求RestAPI - 通过@RequestParam接收参数的GET接口@RequestMapping(value = "accounts/filter", method = RequestMethod.GET) public Account filter(@Requ
http请求使用 RestTemplate 发送 post 请求传递参数
zhulaosan的博客
03-27 2973
http使用 RestTemplate 发送 post 请求传递参数 代码参考如下 import com.wondersgroup.yilian.interface_monitor_portallogin.entity.ResponseEntity; import com.alibaba.fastjson.JSONObject; import com.wondersgroup.yilian.int...
使用restTemplate发送http请求完成远程调用
05-13
是的，可以使用 Spring 提供的 RestTemplate 类来发送 HTTP 请求，实现远程调用。以下是一个简单的示例： ```java RestTemplate restTemplate = new RestTemplate(); String url = ...
Nginx负载均衡中实现HTTP/2：配置指南与最佳实践
2401_85743969的博客
08-29 669
HTTP/2是HTTP协议的第二个主要版本，旨在通过减少延迟和提高传输效率来改进Web性能。Nginx支持HTTP/2，并且可以配置为在负载均衡器中使用它，从而为终端用户提供更快的页面加载时间和更好的用户体验。本文将详细介绍如何在Nginx负载均衡中实现HTTP/2，包括配置步骤、性能优化和安全性考虑。
HTTP 之 Web Sockets 安全策略（十）
qq_35876316的博客
08-30 560
使用 Sec-WebSocket-Protocol 指定子协议，确保客户端和服务器使用相同的通信协议。使用内容安全策略（Content Security Policy）限制可以执行的脚本，减少 XSS 攻击的风险。限制每个客户端可以建立的 WebSocket 连接数量，以防止资源耗尽攻击。对客户端的消息发送频率进行限制，防止服务器被恶意客户端的高频率请求所淹没。使用专用的代理服务器来管理 WebSocket 连接，提供额外的安全层。确保只有经过身份验证和授权的用户才能建立 WebSocket 连接。
HTTP“请求”和“响应”的报头及正文详解
m0_60462557的博客
09-02 1199
本篇介绍有关http请求和响应的报头、正文以及响应状态码。
HTTP和HTTPS的区别
2401_86544677的博客
08-23 1282
总的来说，HTTPS提供了比HTTP更高的安全性和隐私保护，因此在现代互联网中，HTTPS已成为标准做法，尤其是对于需要保护用户数据的网站和应用。
SOAP HTTP Binding
wjs2024的博客
08-31 737
【代码】SOAP HTTP Binding。
Python 的http.server库详细介绍
小仙女的博客
08-30 1195
http.server 是一个非常有用的工具，可以快速搭建一个基本的 HTTP 服务器
使用HTTP代理注意的点
2301_80761287的博客
08-30 488
在选择代理时，可以参考其他用户的评价或进行小范围的测试，以评估其在实际使用中的表现。为了确保安全、高效地使用HTTP代理，我们需要选择可靠的服务商、验证其安全性和隐私保护能力、考虑速度和稳定性、注意身份验证和授权、了解监控和日志记录政策。只有这样，我们才能充分发挥HTTP代理的优势，同时避免潜在的风险和问题。确保所选服务商有良好的口碑、稳定的服务器网络、明确的隐私政策和合理的价格。同时，了解服务商的隐私政策，确认其是否严格保护用户数据，不会将用户信息泄露给第三方。因此选择一个可信赖、安全的代理非常重要。
应用层协议（下）Https加密Http的秘密（含逻辑图解 简单易学 通俗易懂！）
溟洵的博客
08-30 862
Https是干什么的并且去底层的学习Http的原理，将会讲到Https的加密、解密过程
HTTPie CLI：重塑命令行HTTP交互的现代工具
最新发布
孔乙己大叔的博客
09-02 627
在快速发展的数字时代，API（应用程序编程接口）已成为连接不同服务和应用的桥梁。无论是开发者还是系统管理员，与HTTP服务进行有效且高效的交互都是日常工作的核心部分。然而，传统的命令行HTTP客户端往往因其复杂的语法和有限的功能而令人望而却步。正是在这样的背景下，HTTPie CLI应运而生，它以其简洁明了的语法、丰富的功能集以及出色的用户体验，迅速成为了命令行HTTP客户端领域的佼佼者。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值