Springboot整合RestTemplate

最新推荐文章于 2024-04-24 13:56:44 发布
最新推荐文章于 2024-04-24 13:56:44 发布
阅读量2.1k 收藏 4
点赞数 1
文章标签： spring boot java okhttp
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Sunny_yaa/article/details/130190577
版权

RestTemplate简介

RestTemplate是由Spring框架提供的一个可用于应用中调用rest服务的类它简化了与http服务的通信方式，统一了RESTFul的标准，封装了http连接，我们只需要传入url及其返回值类型即可。
相较于之前常用的HttpClient，RestTemplate是一种更为优雅的调用RESTFul服务的方式。
在Spring应用程序中访问第三方REST服务与使用Spring RestTemplate类有关。RestTemplate类的设计原则与许多其他Spring的模板类(例如JdbcTemplate)相同，为执行复杂任务提供了一种具有默认行为的简化方法。

RestTemplate默认依赖JDK提供了http连接的能（HttpURLConnection），
如果有需要的话也可以通过setRequestFactory方法替换为
例如Apache、 HttpCompoent、Netty或OKHttp等其他Httplibaray。

考虑到了RestTemplate类是为了调用REST服务而设计的，
因此它的主要方法与REST的基础紧密相连就不足为奇了，
后者时HTTP协议的方法：HEAD、GET、POST、PUT、DELETE、OPTIONS
例如: RestTemplate类具有headForHeaders()、getForObject()、putForObject()，put()和delete()等方法。

创建RestTemplate

​ 因为RestTemplate是Spirng框架提供的所以只要是一个Springboot项目就不用考虑导包的问题，这些都是提供好的。
​ 但是Spring并没有将其加入SpringBean容器中，需要我们手动加入，
因为我们首先创建一个Springboot配置类，再在配置类中将我们的RestTemlate注册到Bean容器中。

/**
     * resttemplate自定义配置引入连接池
     * @return restTemplate
     */
    @Bean
    public RestTemplate restTemplate(){
        OkHttp3ClientHttpRequestFactory okhttp3 = new OkHttp3ClientHttpRequestFactory();
         //设置连接超时时间
        okhttp3.setConnectTimeout(15000);
         //设置读取超时时间
        okhttp3.setReadTimeout(15000);
        okhttp3.setWriteTimeout(15000);
        RestTemplate restTemplate = new RestTemplate(okhttp3);
        // 解决中文乱码
        List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters();
        messageConverters.add(new StringHttpMessageConverter(StandardCharsets.UTF_8));
        messageConverters.add(new TextHtmlJackson2HttpMessageConverter());
        // 自定义错误响应，返回详细的错误信息
        restTemplate.setErrorHandler(new ResponseErrorHandler() {
            @Override
            public boolean hasError(ClientHttpResponse clientHttpResponse) throws IOException {
                return true;
            }

            @Override
            public void handleError(ClientHttpResponse clientHttpResponse) throws IOException {

            }
        });
        return restTemplate;
    }

RestTemplate API使用

​ 在使用RestTemplate前先让我们看看RestTemplate有哪些API
在这里插入图片描述

GET请求

​

通过上图我们可以发现RestTemlate发送GET请求的方法有两种
public T getForObject(…)
public ResponseEntity getForEntity(…)

在这里插入图片描述
在这里插入图片描述

getForEntity()

​ 后缀带有Entity的方法都代表返回一个ResponseEntity，

ResponseEntity是Spring对HTTP请求响应的封装，包括了几个重要的元素，如响应码，contentType、contentLength、响应消息体等
​
通过它继承父类(HttpEntity)的getHeader()方法我们可以获取contentType、contentLength、响应消息体等。比如下面这个例子。

public void queryWeather() {
   ResponseEntity<Object> forEntity = restTemplate.getForEntity("https://restapi.amap.com/v3/weather/weatherInfo?city=510100&key=e7a5fa943f706602033b6b329c49fbc6", Object.class);
   System.out.println("状态码:"+forEntity.getStatusCode());
   System.out.println("状态码内容:"+forEntity.getStatusCodeValue());
   HttpHeaders headers = forEntity.getHeaders();
   System.out.println("响应头:"+headers);
   Object body = forEntity.getBody();
   System.out.println("响应内容:"+body);
}

在这里插入图片描述

该例子中getForEntity()方法
第一个参数为我要调用服务的URL，
第二个参数则为响应内容的类的类型（Java嘛万物皆对象
第三个参数为一个可变参数代表着调用服务时的传参(可以使用key-value的map来传入参数)
​ get请求也可通过向在url上添加查询参数来发送带有请求的参数

getForObject()

​ 相比于前者getForEntity()该方法则是，更偏向于直接获取响应内容的，
因为他直接返回响应实体的body（响应内容）。比如下面这个例子

public void queryWeather() {
     Object body = restTemplate.getForObject("https://restapi.amap.com/v3/weather/weatherInfo?city=510100&key=e7a5fa943f706602033b6b329c49fbc6", Object.class);
     System.out.println(body);
}

POST请求

public URI postForLocation(…)
public T postForObject(…)
public ResponseEntity postForEntity(…)

后两种用法与GET基本一致不做详细介绍，这里着重介绍postForLocation()

postForEntity()

必须用ResponseEntity对象接

该方法有三个参数， 第一个为调用服务的地址（URL） ​ 第二个参数表示上传的参数(json格式提交) ​
第三个表示返回响应内容的具体类型 ​ 第四个参数也用于指定参数（在URL中添加）
在这里插入图片描述

/**
     * 发送post json请求
     * @param paramMap 请求参数
     * @param url URL
     * @return 响应json中的data信息
     */
 public static JSONObject postJsonRequest(Map<String, Object> paramMap, String url) {
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        headers.add("Access-Token", redisUtils.get(RedisKeys.ACCESS_TOKEN));
        HttpEntity<Map<String, Object>> request = new HttpEntity<>(paramMap, headers);
        ResponseEntity<JSONObject> responseEntity = restTemplate.postForEntity(url, request, JSONObject.class);
        if (responseEntity.getStatusCodeValue() == HttpStatus.OK.value()) {
            JSONObject respJson = responseEntity.getBody();
            if (Integer.valueOf(0).equals(respJson.get("code"))) {
                return (JSONObject) JSON.toJSON(respJson.get("data"));
            } else {
                log.info("接口 {} 请求失败 {}", url, respJson);
                throw new QnmManageException("接口请求失败 " + respJson);
            }
        } else {
            throw new QnmManageException("接口请求错误");
        }
    }

postForObject()

​ 使用方法与getForObject类似只是多了一个传入对象参数（传入方式与postForEntity()相同）
在这里插入图片描述
在这里插入图片描述

postForLocation()

​ postForLocation传参用法与前两者一致，只不过返回从实体变成了一个URL，
因此它不需要指定返回响应内容的类型。

public void queryWeather() {
User user = new User();
user.setName("鲁大师");
URI uri = restTemplate.postForLocation("https://httpbin.org/post", user);
System.out.println(uri);
}

EXCHANGE方法

ResponseEntity exchange()

​ 该接口与其他接口不同 该方法允许用户指定请求的方法（get,post,put等）
可以在请求中增加body以及头信息，其内容通过参数HttpEntity<?> requestEntity描述

exchange支持’含参数的类型(即泛型)'作为返回类型

ParameterizedTypeReferenceresponseType 描述该方法支持五个参数 第一个是服务地址 第二个是请求方法
第三个是写入的请求实体 第四个是响应内容的类型 第五个是扩展模板的变量或包含URI模板变量的映射

@Test
void contextLoads() {
    //请求地址
    String url = "http://httpbin.org/post";
    User user = new User();
    user.setName("彭于晏");
    HttpHeaders httpHeaders = new HttpHeaders();
    httpHeaders.setContentType(MediaType.APPLICATION_JSON);
    HttpEntity<User> userHttpEntity = new HttpEntity<>(user, httpHeaders);
    ResponseEntity<Object> exchange = restTemplate.exchange(url, HttpMethod.POST, userHttpEntity, Object.class);
    System.out.println(exchange);
}

上述代码模拟了一个简单的POST请求 可以理解为可以动态的指定请求方法和请求实体的一个方法。
响应实体
在这里插入图片描述

/**
     * 发送get请求
     * @param paramMap 请求参数
     * @param url URL
     * @return 响应json中的data信息
     */
    public static JSONObject getRequest(Map<String, Object> paramMap, String url) {
        HttpHeaders headers = new HttpHeaders();
        headers.add("Access-Token", redisUtils.get(RedisKeys.ACCESS_TOKEN));
        HttpEntity<Map<String, Object>> request = new HttpEntity<>(null, headers);
        UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl(url);
        for (Map.Entry<String, Object> param : paramMap.entrySet()) {
            String key = param.getKey();
            String val =  param.getValue() instanceof String ? (String) param.getValue() : JSON.toJSONString(param.getValue());
            builder.queryParam(key,  val);
        }
        ResponseEntity<JSONObject> responseEntity = restTemplate.exchange(builder.build().toUri(), HttpMethod.GET, request, JSONObject.class);
        if (responseEntity.getStatusCodeValue() == HttpStatus.OK.value()) {
            JSONObject respJson = responseEntity.getBody();
            if (Integer.valueOf(0).equals(respJson.get("code"))) {
                return (JSONObject) JSON.toJSON(respJson.get("data"));
            } else {
                log.info("接口 {} 请求失败 {}", url, respJson);
                throw new QnmManageException("接口请求失败 " + respJson);
            }
        } else {
            throw new QnmManageException("接口请求错误");
        }
    }
Sunny_yaa
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot整合RestTemplate用法讲解（完整详细）
黄团团的个人博客
07-07 3269
本篇主要介绍了RestTemplate中的GET，POST，PUT，DELETE、文件上传和文件下载6大常用的功能，每一个方法和每一行代码都进行了详细的讲解，代码都是亲自测试过的，整篇博客写完以后自己也是受益匪浅，于是在这做个技术分享！
详解SpringBoot中RestTemplate的几种实现
08-25
主要介绍了详解SpringBoot中RestTemplate的几种实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot中对于RestTemplate的基本封装
女人爱钱，男人好色。
03-04 568
【代码】SpringBoot中对于RestTemplate的基本封装。
SpringBoot使用RestTemplate
培根芝士的专栏
05-19 6695
RestTemplate 是由 Spring 提供的一个 HTTP 请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST 请求、PUT 请求、DELETE 请求以及一些通用的请求执行方法 exchange 以及 execute。RestTemplate 继承自 InterceptingHttpAccessor 并且实现了 RestOperations 接口，其中 RestOperations 接口定义了基本的 RESTful 操作，这些操作在 RestTemplate 中都得到了实现
SpringBoot中RestTemplate和WebClient的使用区别及优缺点含完整代码
02-02
在Spring Boot中，RestTemplate和WebClient是两种常用的HTTP客户端，它们各自具有不同的特点和适用场景。本文将介绍这两种客户端的基本概念、工作原理和使用方法，并通过对比分析，帮助读者更好地理解它们的差异。文章首先介绍了RestTemplate和WebClient的基本概念和原理，然后详细介绍了它们的配置和使用方法。通过实例演示了如何使用这两种客户端发送HTTP请求和接收响应。最后，文章对RestTemplate和WebClient的优缺点进行了对比分析，并给出了在Spring Boot项目中如何选择合适的HTTP客户端的建议。
SpringBoot RestTemplate详解
热门推荐
白羊座的橙子
09-24 1万+
RestTemplate是Spring提供的进行远程调用客户端RestTemplate提供了很多远程调用的方法，能够大大提高客户端的编写效率。调用RestTemplate的默认构造函数，RestTemplate对象在底层通过使用java.net包下的实现创建HTTP 请求可以通过使用ClientHttpRequestFactory指定不同的HTTP请求方式ClientHttpRequestFactory接口主要提供了三种实现方式。
SpringBoot-RestTemplate
weixin_45203607的博客
09-22 3140
SpringBoot-RestTemplate 需要的Maven RestTemplate是spring的一个rest客户端，在spring-web这个包下，spring boot的依赖如下： <!-- web服务--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spr
SpringBoot 整合 RestTemplate
给自己一个smile
04-29 2108
目录 一、概述 二、整合 RestTemplate 1. RestTemplateConfig 配置类 2. 工具类 3. RestTemplate 方法 4. getForEntity 方法 4. exchange 方法 5. postForEntity 方法 三、测试案例 1. RestTemplateController 2. 测试开始 一、概述 当我们业务需求上，需要调用第三方外部接口数据，使用 RestTemplate 调用是一个不错的选择，调用起来比较灵活。 ..
Spring之RestTemplate详解
上善若泪
03-08 1万+
文章目录1 RestTemplate1.1 引言1.2 环境配置1.2.1 非Spring环境下使用RestTemplate1.2.2 Spring 环境下使用 RestTemplate1.3 API 实践1.3.1 GET请求1.3.1.1 不带参请求1.3.1.2 带参的get请求(使用占位符号传参)1.3.1.3 带参的get请求(restful风格)1.3.1.4 getForEntity使用示例1.3.2 POST请求1.3.2.1 模拟表单请求1.3.2.2 模拟表单请求(传递对象)1.3.2.
springboot整合Sentinel
02-21
springboot整合Sentinel
详解SpringBoot通过restTemplate实现消费服务
08-28
本篇文章主要介绍了详解使用RestTemplate消费spring boot的Restful服务，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
Springboot集成restTemplate过程详解
08-19
主要介绍了Springboot集成restTemplate过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
基于 Spring Boot 博客系统开发（三）
呆萌很的博客
04-23 1277
在Thymeleaf中，如果你想要抽取公共页面（例如，头部、底部、导航栏等），可以通过定义和使用片段（fragments）和包含（includes）来实现。首页head部分的公共代码抽取成碎片，使用 thymeleaf 的标签 th:fragment 和 th:include。然后，在你的主页面（比如index.html）中，使用Thymeleaf的th:include来复用这段代码。将需要抽取的代码放到include fragment中，需要用到这些代码的地方使用th:include引用。
Spring Boot 中Mybatis使用Like的使用方式和注意点
程序人生
04-19 966
使用Springboot简单配置一下Mybatis，然后进行说明。Springboot集成Mybatis这里就不做介绍了，这里我们主要介绍一下在mybatis配置文件中怎么使用模糊查询。
Spring Boot 实现定时任务
wenxuankeji的博客
04-16 1469
Spring Boot 实现定时任务
Spring Boot后端+Vue前端：打造高效二手车交易系统
Yaml4的博客
04-18 1153
如今社会上各行各业，都喜欢用自己行业的专属软件工作，互联网发展到这个时候，人们已经发现离不开了互联网。新技术的产生，往往能解决一些老技术的弊端问题。因为传统二手车交易信息管理难度大，容错率低，管理人员处理数据费工费时，所以专门为解决这个难题开发了一个二手车交易系统，可以解决许多问题。随着我国互联网技术的不断发展，电子商务受到了广大年轻人的欢迎。在二手汽车行业中也是如此，由于疫情防控等原因，线上二手车销售额逐年增加，但我国目前还没有一套高效、稳定的二手汽车交易网站，满足人民群众的销售、过户、签合同需求。
Spring Boot 如何进行多环境配置
最新发布
三心二逸的博客
04-24 449
在SpringBoot中管理不同环境的配置确实是一个常见且重要的实践。通过使用不同的配置文件，你可以轻松地在开发、测试和生产环境之间切换，而无需手动更改配置信息。这不仅提高了开发效率，还减少了因配置错误导致的潜在问题。通过以上步骤，你可以轻松地管理和切换不同环境的配置，而无需手动更改配置文件。这是SpringBoot提供的一个非常实用的功能，可以大大提高开发和部署的效率。要实现这一点，你需要创建专门的配置文件用于不同的环境，并通过SpringBoot的。这样，当你运行应用时，SpringBoot会合并。
springboot集成resttemplate
03-16
Spring Boot集成RestTemplate是一种常见的方式，可以用于在应用程序中进行HTTP通信。RestTemplate是Spring框架中的一个类，它提供了一种简单的方式来发送HTTP请求和处理响应。在Spring Boot中，可以通过添加依赖项来轻松地集成RestTemplate。然后，可以使用RestTemplate来发送GET、POST、PUT和DELETE请求，并处理响应。这使得在应用程序中进行HTTP通信变得非常容易。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值