Java中RestTemplate调用API的几种常用写法

 更新时间:2025年10月09日 09:55:17   作者:咖啡Beans  
本文介绍了RestTemplate调用http的几种写法,包括post+get,及传递参数的方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

摘要

本文介绍了RestTemplate调用http的几种写法,包括post+get,及传递参数的方式,让我们拿下它。

可选配置

依赖坐标pom.xml

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

<!-- 统一使用依赖注入 private final RestTemplate restTemplate; -->

自定义配置

package org.coffeebeans.resttemplate;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.client.RestTemplate;

/**
 * <li>ClassName: RestTemplateConfig </li>
 * <li>Author: OakWang </li>
 */
@Configuration
publicclassRestTemplateConfig {
    @Bean
    public RestTemplate restTemplate() {
        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
        factory.setConnectTimeout(30000); // 连接超时时间(毫秒)
        factory.setReadTimeout(30000); // 读取超时时间(毫秒)
        RestTemplate restTemplate = new RestTemplate(factory);
        MappingJackson2HttpMessageConverterjsonConverter = new MappingJackson2HttpMessageConverter();
        restTemplate.getMessageConverters().add(jsonConverter);// 添加JSON消息转换器
        return restTemplate;
    }
}

实现get请求

  • GET+空参
String requestUrl = "https://jsonplaceholder.typicode.com/posts/1";
ResponseEntity<String> response = restTemplate.getForEntity(requestUrl, String.class);
if (Objects.equals(HttpStatus.OK, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}
  • GET+单参
String requestUrl = "https://jsonplaceholder.typicode.com/posts/{id}";
ResponseEntity<String> response = restTemplate.getForEntity(requestUrl, String.class, 1); // 参数值为 1
if (Objects.equals(HttpStatus.OK, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}
  • GET+多参-方式1
String requestUrl = "https://jsonplaceholder.typicode.com/comments?id={id}&email={email}";
Map<String, Object> params = new HashMap<>();
params.put("id", 1);
params.put("email", "Eliseo@gardner.biz");
ResponseEntity<String> response = restTemplate.getForEntity(requestUrl, String.class, params);
if (Objects.equals(HttpStatus.OK, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}
  • GET+多参-方式2
String requestUrl = UriComponentsBuilder.fromHttpUrl("https://jsonplaceholder.typicode.com/posts/1/comments")
        .queryParam("id", "3")
        .queryParam("email", "Nikita@garfield.biz")
        .toUriString();
ResponseEntity<String> response = restTemplate.getForEntity(requestUrl, String.class);
if (Objects.equals(HttpStatus.OK, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}

实现post请求

  • POST+空参
String requestUrl = "https://jsonplaceholder.typicode.com/posts";
ResponseEntity<Object> response = restTemplate.postForEntity(requestUrl, null, Object.class);
if (Objects.equals(HttpStatus.CREATED, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}
  • POST+JSON 实体对象参数
String requestUrl="https://jsonplaceholder.typicode.com/posts";

List<MyEntity> entityList = new ArrayList<>(); //对象参数
entityList.add(MyEntity.builder().title("foo").body("bar").userId("1").build());
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);
headers.set("Authorization", "");
HttpEntity<Object> requestEntity = new HttpEntity<>(entityList, headers);

ResponseEntity<Object> response = restTemplate.postForEntity(requestUrl, requestEntity, Object.class);
if (Objects.equals(HttpStatus.CREATED, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}
  • POST+JSON 对象参数
String requestUrl="https://jsonplaceholder.typicode.com/posts";

Map<String, String> params = new HashMap<>();
params.put("title", "foo");
params.put("body", "bar");
params.put("userId", "1");
MultiValueMap<String, String> form = new LinkedMultiValueMap<>();
for (Map.Entry<String, String> entry : params.entrySet()) {
    form.add(entry.getKey(), entry.getValue());
}
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(form, headers);
ResponseEntity<Object> response = restTemplate.postForEntity(requestUrl, requestEntity, Object.class);
if (Objects.equals(HttpStatus.CREATED, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}
  • POST+表单提交
String requestUrl="https://";
// 1. 初始化参数
Map<String, String> params = new HashMap<>();
params.put("title", "foo");
// 2. 构造 MultiValueMap
MultiValueMap<String, String> form = new LinkedMultiValueMap<>();
for (Map.Entry<String, String> entry : params.entrySet()) {
    form.add(entry.getKey(), entry.getValue());
}
// 3. 设置请求头
HttpHeaders headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
// 4. 发送请求 返回Object或者指定类型
HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(form, headers);
ResponseEntity<Object> response = restTemplate.postForEntity(requestUrl, requestEntity, Object.class);
//5.处理结果
if (Objects.equals(HttpStatus.OK, response.getStatusCode())) {
    log.info("请求响应结果: {}, {}", requestUrl, response.getBody());
    // 解析...
}

总结

以上我们整理了RestTemplate调用接口的几种用法,包括post+get,空参、单参、多参的使用场景。

到此这篇关于Java中RestTemplate调用API的几种常用写法的文章就介绍到这了,更多相关Java RestTemplate调用API内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • mybatis 新增返回id的实现

    mybatis 新增返回id的实现

    Mybatis插入数据时,可以通过两种方式返回生成的ID,两种方式都需要在实体类中提供userId的getter和setter方法,本文就详细的介绍一下这两种方法,感兴趣的可以了解一下
    2024-09-09
  • idea如何自定义代码模板

    idea如何自定义代码模板

    这篇文章主要介绍了idea如何自定义代码模板问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • MyBatisPlus超详细分析条件查询

    MyBatisPlus超详细分析条件查询

    这篇文章主要介绍了MyBatisPlus条件查询的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08
  • Java缺失区间的查找方法

    Java缺失区间的查找方法

    在 Java 的算法世界里,有许多有趣又具有挑战性的问题等待我们去探索,今天,跟着小编一起来深入研究缺失区间的查找秘籍,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2025-02-02
  • 教你用Java在个人电脑上实现微信扫码支付

    教你用Java在个人电脑上实现微信扫码支付

    今天给大家带来的是Java实战的相关知识,文章围绕着Java在个人电脑上实现微信扫码支付展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • Java实战之制作在线音乐网站

    Java实战之制作在线音乐网站

    这篇文章主要介绍了如何通过Java实现一个精美风的在线音乐网站,文章采用到了JSP、JQuery、Ajax等技术,感兴趣的小伙伴可以了解一下
    2022-02-02
  • java随机数生产算法实例

    java随机数生产算法实例

    下面小编就为大家带来一篇java随机数生产算法实例。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • 基于Spring@Autowired注解与自动装配详谈

    基于Spring@Autowired注解与自动装配详谈

    下面小编就为大家带来一篇基于Spring@Autowired注解与自动装配详谈。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • Java学习笔记之异常处理

    Java学习笔记之异常处理

    这篇文章主要为大家详细介绍了Java学习笔记之异常处理,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-10-10
  • Java获取文件夹下所有文件名称的方法示例

    Java获取文件夹下所有文件名称的方法示例

    这篇文章主要介绍了Java获取文件夹下所有文件名称的方法,涉及java针对文件与目录相关操作技巧,需要的朋友可以参考下
    2017-06-06

最新评论