SpringBoot发送Http请求-RestTemplate

最新推荐文章于 2024-09-22 21:20:44 发布
置顶 最新推荐文章于 2024-09-22 21:20:44 发布
阅读量6.4w 收藏 197
点赞数 49
分类专栏： springboot干货 一文读懂系列 开源项目 文章标签： java spring boot spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/youbitch1/article/details/106117173
版权

SpringBoot发送Http请求

[提前声明]
文章由作者:张耀峰 结合自己生产中的使用经验整理,最终形成简单易懂的文章
写作不易,转载请注明,谢谢!
大数据代码案例地址: https://github.com/Mydreamandreality/sparkResearch

前言

之前我写过一篇关于SpringBoot发送Http请求的文章、当时使用的是Apache,Http.client，
文章地址:图解springboot后端发送HttpGet和HttpPost请求
但是使用这个工具发送请求很繁琐、代码看起来也很复杂、而且大部分都是冗余的代码、而Spring给我们提供了一个发送Http请求的工具、所以我觉得有必要安利一下

RestTemplate

首先看下spring官方对RestTemplate的解释

在这里插入图片描述

RestTemplate是Spring用于同步client端的核心类，简化了与http服务的通信，并满足RestFul原则，程序代码可以给它提供URL，并提取结果。默认情况下，RestTemplate默认依赖jdk的HTTP连接工具。当然你也可以 通过setRequestFactory属性切换到不同的HTTP源，比如Apache HttpComponents、Netty和OkHttp

如何使用

经过简单了解后、我们不多bb、直接上代码、通过代码来说话

  • 1、pom配置

先声明下我的SpringBoot版本：<version>2.1.13.RELEASE</version>
在org.springframework.web中已经默认集成了RestTemplate

引用apache的httclient （不是用RestTemplate吗？为什么又引用了apache的client、别急 稍后解释

        <dependency>
            <groupId>org.apache.httpcomponents</groupId>
            <artifactId>httpclient</artifactId>
            <version>4.5.6</version>
        </dependency>
  • 2、RestTemplate配置

在Spring的官方文档中可以了解到、RestTemplate 采用同步方式执行 HTTP 请求的类，底层使用 JDK 原生 HttpURLConnection API ，或者 HttpComponents等其他 HTTP 客户端请求类库。还有一处强调的就是 RestTemplate 提供模板化的方法让开发者能更简单地发送 HTTP 请求

既然如此、那么我们底层依然使用apache的client给我们提供的http请求服务能力、上层的应用开发使用RestTemplate的模板

ClientHttpRequestFactory 接口有4个实现类，分别是：

  • AbstractClientHttpRequestFactoryWrapper 用来装配其他request factory的抽象类。
  • CommonsClientHttpRequestFactory 允许用户配置带有认证和http连接池的httpclient，已废弃，推荐用HttpComponentsClientHttpRequestFactory。
  • HttpComponentsClientHttpRequestFactory 同2.
  • SimpleClientHttpRequestFactory 接口的一个简单实现，可配置proxy，connectTimeout，readTimeout等参数。

我们使用的是HttpComponentsClientHttpRequestFactory来配置

  • 配置application.yml

首先我们自定义一些配置参数、后面会用到

http_pool:
  max_total: 200
  default_max_per_route: 100
  connect_timeout: 5000
  connection_request_timeout: 1000
  socket_timeout: 65000
  validate_after_inactivity: 2000
  • 新建ApplicationValues.java

这个是读取配置中的参数方法

import lombok.Getter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

/**
 * @author 孤
 * @version v1.0
 * @Developers 张耀烽
 * @serviceProvider 四叶草安全(SeClover)
 * @description 获取Application配置数据
 * @date
 */
@Getter
@Component
public class ApplicationValues {

    @Value("${http_pool.max_total}")
    private int maxTotal;

    @Value("${http_pool.default_max_per_route}")
    private int maxPerRoute;

    @Value("${http_pool.connect_timeout}")
    private int connTimeOut;

    @Value("${http_pool.connection_request_timeout}")
    private int connReqTimeOut;

    @Value("${http_pool.socket_timeout}")
    private int socketTimeout;

    @Value("${http_pool.validate_after_inactivity}")
    private int inactivity;
}
  • 新建RestTemplateConfig.java

这个是配置我们的底层http客户端（这里我们使用apache的client

如何配置：

Spring提供了HttpComponentsClientHttpRequestFactory可以通过该方法来配置我们的http客户端

import com.clover.api.consts.ApplicationValues;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.config.Registry;
import org.apache.http.config.RegistryBuilder;
import org.apache.http.conn.socket.ConnectionSocketFactory;
import org.apache.http.conn.socket.PlainConnectionSocketFactory;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.web.client.RestTemplate;

/**
 * @author 孤
 * @version v1.0
 * @Developers 张耀烽
 * @serviceProvider 四叶草安全(SeClover)
 * @description http工厂配置
 * @date
 */
@Configuration
public class RestTemplateConfig {

    @Autowired
    private ApplicationValues appValues;

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

    @Bean
    public ClientHttpRequestFactory httpRequestFactory() {
        return new HttpComponentsClientHttpRequestFactory(httpClient());
    }

    @Bean
    public HttpClient httpClient() {
        Registry<ConnectionSocketFactory> registry = RegistryBuilder.<ConnectionSocketFactory>create()
                .register("http", PlainConnectionSocketFactory.getSocketFactory())
                .register("https", SSLConnectionSocketFactory.getSocketFactory())
                .build();
        PoolingHttpClientConnectionManager connectionManager = new PoolingHttpClientConnectionManager(registry);
        connectionManager.setMaxTotal(appValues.getMaxTotal());
        connectionManager.setDefaultMaxPerRoute(appValues.getMaxPerRoute());
        connectionManager.setValidateAfterInactivity(appValues.getInactivity());
        RequestConfig requestConfig = RequestConfig.custom()
                //服务器返回数据(response)的时间，超过抛出read timeout
                .setSocketTimeout(appValues.getSocketTimeout())
                //连接上服务器(握手成功)的时间，超出抛出connect timeout
                .setConnectTimeout(appValues.getConnTimeOut())
                //从连接池中获取连接的超时时间，超时间未拿到可用连接，会抛出org.apache.http.conn.ConnectionPoolTimeoutException: Timeout waiting for connection from pool
                .setConnectionRequestTimeout(appValues.getConnReqTimeOut())
                .build();
        return HttpClientBuilder.create()
                .setDefaultRequestConfig(requestConfig)
                .setConnectionManager(connectionManager)
                .build();
    }
}
  • 发送请求

RestTemplate对于不同的请求方式提供了不同的函数、我把官方的图贴一下、下面我会把常用的跟大家说一下

在这里插入图片描述

发送Post请求、请求参数为json

一般的post请求都是从body中传递json参数、比如是这样的

{
    "name":"张耀烽",
    "sex":"男"
}
  • 首先我们构造我们的json请求参数
  • 其次发送请求

请求发送成功后、会返回 ResponseEntity对象、spring把response的所有结果集都封装在了这个对象中、我们可以按需使用、此处我只获取了请求成功后返回的body

    /**
     * 生成post请求的JSON请求参数
     * 请求示例:
     * {
     * "id":1,
     * "name":"张耀烽"
     * }
     *
     * @return
     */
    public HttpEntity<Map<String, String>> generatePostJson(Map<String, String> jsonMap) {

        //如果需要其它的请求头信息、都可以在这里追加
        HttpHeaders httpHeaders = new HttpHeaders();

        MediaType type = MediaType.parseMediaType("application/json;charset=UTF-8");

        httpHeaders.setContentType(type);

        HttpEntity<Map<String, String>> httpEntity = new HttpEntity<>(jsonMap, httpHeaders);

        return httpEntity;
    }
    
    
      /**
     * post请求、请求参数为json
     *
     * @return
     */
    public String sendPost() {
        String uri = "http://127.0.0.1:80";

        Map<String, String> jsonMap = new HashMap<>(6);
        jsonMap.put("name", "张耀烽");
        jsonMap.put("sex", "男");

        ResponseEntity<String> apiResponse = restTemplate.postForEntity
                (
                        uri,
                        generatePostJson(jsonMap),
                        String.class
                );
        return apiResponse.getBody();
    }

发送get请求、请求参数为uri参数

get的请求我们一般都是通过uri的方式来进行传参，比如：

http://127.0.0.1:80/?name=张耀烽&sex=男

  • 首先构造我们的get请求参数
  • 发送get请求、获取结果
 /**
     * 生成get参数请求url
     * 示例：https://0.0.0.0:80/api?u=u&o=o
     * 示例：https://0.0.0.0:80/api
     *
     * @param protocol 请求协议 示例: http 或者 https
     * @param uri      请求的uri 示例: 0.0.0.0:80
     * @param params   请求参数
     * @return
     */
    public String generateRequestParameters(String protocol, String uri, Map<String, String> params) {
        StringBuilder sb = new StringBuilder(protocol).append("://").append(uri);
        if (ToolUtil.isNotEmpty(params)) {
            sb.append("?");
            for (Map.Entry map : params.entrySet()) {
                sb.append(map.getKey())
                        .append("=")
                        .append(map.getValue())
                        .append("&");
            }
            uri = sb.substring(0, sb.length() - 1);
            return uri;
        }
        return sb.toString();
    }

    /**
     * get请求、请求参数为?拼接形式的
     * <p>
     * 最终请求的URI如下：
     * <p>
     * http://127.0.0.1:80/?name=张耀烽&sex=男
     *
     * @return
     */
    public String sendGet() {
        Map<String, String> uriMap = new HashMap<>(6);
        uriMap.put("name", "张耀烽");
        uriMap.put("sex", "男");

        ResponseEntity responseEntity = restTemplate.getForEntity
                (
                        generateRequestParameters("http", "127.0.0.1:80", uriMap),
                        String.class
                );
        return (String) responseEntity.getBody();
    }

总结

到此我们两种常用的请求就已经掌握了、其它的方法你们需要用的时候去看就可以了、都是一些重载的方法、大同小异。

完整代码：

import com.clover.api.utils.tools.ToolUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

import java.util.HashMap;
import java.util.Map;

/**
 * @author 孤
 * @version v1.0
 * @Developers 张耀烽
 * @serviceProvider 四叶草安全(SeClover)
 * @description 请简易描述定义
 * @date 2020/5/14
 */
@Component
public class RestMock<k, v> {

    @Autowired
    private RestTemplate restTemplate;

    /**
     * 生成post请求的JSON请求参数
     * 请求示例:
     * {
     * "id":1,
     * "name":"张耀烽"
     * }
     *
     * @return
     */
    public HttpEntity<Map<String, String>> generatePostJson(Map<String, String> jsonMap) {

        //如果需要其它的请求头信息、都可以在这里追加
        HttpHeaders httpHeaders = new HttpHeaders();

        MediaType type = MediaType.parseMediaType("application/json;charset=UTF-8");

        httpHeaders.setContentType(type);

        HttpEntity<Map<String, String>> httpEntity = new HttpEntity<>(jsonMap, httpHeaders);

        return httpEntity;
    }


    /**
     * 生成get参数请求url
     * 示例：https://0.0.0.0:80/api?u=u&o=o
     * 示例：https://0.0.0.0:80/api
     *
     * @param protocol 请求协议 示例: http 或者 https
     * @param uri      请求的uri 示例: 0.0.0.0:80
     * @param params   请求参数
     * @return
     */
    public String generateRequestParameters(String protocol, String uri, Map<String, String> params) {
        StringBuilder sb = new StringBuilder(protocol).append("://").append(uri);
        if (ToolUtil.isNotEmpty(params)) {
            sb.append("?");
            for (Map.Entry map : params.entrySet()) {
                sb.append(map.getKey())
                        .append("=")
                        .append(map.getValue())
                        .append("&");
            }
            uri = sb.substring(0, sb.length() - 1);
            return uri;
        }
        return sb.toString();
    }

    /**
     * get请求、请求参数为?拼接形式的
     * <p>
     * 最终请求的URI如下：
     * <p>
     * http://127.0.0.1:80/?name=张耀烽&sex=男
     *
     * @return
     */
    public String sendGet() {
        Map<String, String> uriMap = new HashMap<>(6);
        uriMap.put("name", "张耀烽");
        uriMap.put("sex", "男");

        ResponseEntity responseEntity = restTemplate.getForEntity
                (
                        generateRequestParameters("http", "127.0.0.1:80", uriMap),
                        String.class
                );
        return (String) responseEntity.getBody();
    }

    /**
     * post请求、请求参数为json
     *
     * @return
     */
    public String sendPost() {
        String uri = "http://127.0.0.1:80";

        Map<String, String> jsonMap = new HashMap<>(6);
        jsonMap.put("name", "张耀烽");
        jsonMap.put("sex", "男");

        ResponseEntity<String> apiResponse = restTemplate.postForEntity
                (
                        uri,
                        generatePostJson(jsonMap),
                        String.class
                );
        return apiResponse.getBody();
    }

}

更多完整代码可以去参考我的个人开源项目easy_boot、项目地址easy_boot开源项目

李时珍皮啊
关注
专栏目录
Springboot- RestTemplate发送请求并希望将返回的JSON数据转换为Map对象
兴趣是最好的老师
08-20 214
当你使用 RestTemplate 发送请求并希望将返回的 JSON 数据转换为 Map 对象时，你可以使用。如果 JSON 数据结构比较复杂，你可能需要创建更具体的类型映射，例如使用 TypeFactory 或者。如果服务器返回的是错误状态码，RestTemplate 会返回相应的状态码，你需要检查并处理这种情。使用 ObjectMapper 的 readValue 方法将 JSON 字符串转换为 Map。确保服务器返回的数据格式与你期望的一致，例如 JSON 格式。打印转换后的 Map 对象。
SpringBoot使用RestTemplate实现发送HTTP请求
最新发布
pan_junbiao的博客
10-19 1148
RestTemplate 是 Spring 框架提供的一个用于访问 RESTful 服务的客户端工具，它简化了与 RESTful 服务的交互，并提供了一系列方便的方法来发送 HTTP 请求、处理响应以及处理错误。RestTemplate 提供了一组简单易用的方法，使得发送HTTP请求变得非常简单和直观。RestTemplate 可以自动将请求和响应的 JSON/XML 数据转换为 Java 对象，简化了数据的处理过程。
Spring Boot之发送HTTP请求（RestTemplate详解）
诚的博客
11-19 2682
RestTemplate是Spring提供的用于访问Rest服务的客户端，RestTemplate提供了多种便捷访问远程Http服务的方法 1.简述RestTemplate RestTemplate能大幅简化了提交表单数据的难度，并且附带了自动转换JSON数据的功能 HTTP方式 RestTemplate方法 GET getForObject() getForEntity() POST postForLocation() postFor
SpringBoot实战（二十九）发送HTTP/HTTPS请求的五种实现方式【上篇】（HttpURLConnection、HttpClient）
ACGkaka的博客
07-04 1672
SpringBoot实战（二十九）发送HTTP/HTTPS请求的五种实现方式【上篇】（HttpURLConnection、HttpClient）
SpringBoot实战（三十）发送HTTP/HTTPS请求的五种实现方式【下篇】（Okhttp3、RestTemplate、Hutool）
ACGkaka的博客
09-22 1709
SpringBoot实战（三十）发送HTTP/HTTPS请求的五种实现方式【下篇】（Okhttp3、RestTemplate、Hutool）
SpringBoot使用RestTemplate发送http请求（实操版）
weixin_47316183的博客
08-03 1万+
RestTmplate是Spring框架提供的 ，可用于在应用中调用 rest 服务，它简化了与 http 服务的通信方式，统一了RESTful的标准，封装了 http 链接， 我们只需要传入url及返回值类型即可。相较于之前常用的 HttpClient，RestTemplate 是一种更优雅的调用 RESTful 服务的方式。怎么样，是不是特别的方便和简单~
Springboot整合RestTemplate发送http请求
程序三两行
10-17 7830
目录 一 概述 二 RestTemplate 1、简述RestTemplate 2、使用 3、自定义设置 手动指定转换器(HttpMessageConverter) 设置底层连接方式 设置拦截器(ClientHttpRequestInterceptor) 一 概述 通过向指定的第三方地址发送对应格式的数据以便换取所需数据这一需求是平时开发经常碰到的需求。可以同通过apache的HttpClient开发，但是代码复杂，还得操心资源回收等，冗余代码多。spring提供了一种简...
SpringBoot发送http请求
LifeBackwards的专栏
05-26 2348
此外，需要定义一个RestTemplate配置类。HttpUtils工具类如下。
Spring Boot发送http请求
a983677218的博客
08-27 534
有些网站会做反爬机制，所以在创建URL的时候，加上这句 connection.setRequestProperty("User-Agent","Mozilla/4.0 compatible;因为项目要调用第三方网站接口获取信息（类似python爬虫），所以在后端项目中需要前端axios一样去构建请求获取信息。下面用简单的获取IP地址为例。
SpringBoot - 网络请求模版类RestTemplate使用详解
鱼的博客
08-16 1883
SpringBoot - 网络请求模版类RestTemplate使用详解 一、基本介绍 1，什么是 RestTemplate? （1）RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种可以便捷访问远程 Http 服务的方法，能够大大提高客户端的编写效率。 RestTemplate 是 Spring 3 中引入的同步阻塞式 HTTP 客户端。根据 Spring 官方文档介绍，在将来的版本中它可能会被弃用，因为他们已在 Spring 5 中引
SpringBoot-RestTemplate
东京易冷
06-28 941
摘要 使用 1 获取对象 2 获取数组 3 GET请求带有参数 摘要 SpringBoot提供RestTemplate作为Rest请求访问的客户端 使用 1 获取对象 public User findById(Long id){ return restTemplate.getForObject(&quot;http://localhost:8080/&quot;+id,User...
Springboot 基础9 -- SpringBoot 调用接口 RestTemplate 实现
it_lxg123的博客
06-03 1012
RestTemplate 实现及状态码说明 介绍 RestTemplate 简化了与http 服务的通信方式，统一了RESTful 的标准，封装了http 链接。，我们只需传入 url 和获取返回值类型即可。类似于之前的 HttpClient。 RestTemplate 是spring 框架中自带的rest 客户端工具类，具有丰富的API , 并且在springcloud 中，标记@LocalBalanced 注解，可以实现客户端负载均衡的rest 调用。 RestTemplate 是从3.0 开始
Springboot发送http请求
wzluestc的博客
12-01 3439
Springboot发送http请求(使用RestTemplate) 零、关键类介绍 public class HttpEntity<T> { public static final HttpEntity<?> EMPTY = new HttpEntity(); private final HttpHeaders headers; @Nullable private final T body; protected HttpEntity() {
springboot发送HTTP请求
热门推荐
JFENG14的博客
03-17 1万+
1、添加依赖 使用RestTemplate进行发送请求，添加相关依赖 <!--发送请求的依赖--> <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> <version>4.5.5&
Springboot -- 用更优雅的方式发HTTP请求(RestTemplate详解)
BASK2312的博客
12-27 7563
是Spring提供的用于访问Rest服务的客户端，提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。我之前的HTTP开发是用apache的HttpClient开发，代码复杂，还得操心资源回收等。代码很复杂，冗余代码多，稍微截个图，这是我封装好的一个post请求工具：本教程将带领大家实现Spring生态内RestTemplate的Get请求和Post请求还有的实践和核心方法源码的分析，看完你就会用优雅的方式来发HTTP请求。
Springboot使用Feign客户端发送HTTP请求，代替​RestTemplate​远程调用
Xmi2599的博客
06-12 3130
在 Spring Boot 中，可以使用 Feign 来创建 HTTP 客户端，通过简单的注解方式即可实现服务间的远程调用。Feign是一种声明式、模板化的HTTP客户端，在往常的 HTTP 调用中，一直都是使用的官方提供的来进行远程调用，该调用方式将组装代码冗余到正常业务代码中，不够优雅，因此，可以考虑用Feign来替代。
vue+mapboxgl 运行轨迹循环
xm_w_xm的博客
12-11 1865
最终的样子 + mapboxgl 官网的例子 ：https://docs.mapbox.com/mapbox-gl-js/example/animate-a-line/ turf.js 官网：http://turfjs.org/ requestAnimationFrame 详解 我觉得写的很好：https://www.jianshu.com/p/fa5512dfb4f5 一、实现思路 1、绘制线 2、绘制一个点，将线的第一个点赋值给点 3、将geometry中线的每个节点值 ...
Springboot-发送HTTP请求两种方式
榔娃
10-28 8031
Spring生态内RestTemplate
springboot-resttemplate
03-16
Spring Boot RestTemplate是Spring框架中的一个HTTP客户端工具，它可以用来发送HTTP请求并接收响应。它提供了一种简单的方式来访问RESTful服务，可以轻松地与其他服务进行通信。RestTemplate可以使用不同的HTTP方法（如GET、POST、PUT、DELETE等）来发送请求，并且可以将响应映射到Java对象中。它还支持使用不同的消息转换器来处理请求和响应的内容。
评论 19
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值