Spring Boot 整合 RestTemplate：详解与实战

已于 2024-08-06 15:01:04 修改
阅读量388 收藏 9
点赞数 14
分类专栏： spring框架相关 文章标签： spring boot 后端 java
于 2024-08-06 15:00:16 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_42564451/article/details/140955688
版权

Spring Boot 整合 RestTemplate：详解与实战指南

本文将深入讲解如何在 Spring Boot 应用中整合 RestTemplate，包括依赖添加、实例创建、请求发送、响应处理以及一些高级用法。通过本文的学习，将能够熟练地在 Spring Boot 应用中调用远程 RESTful 服务。

一、引言

企业使用 RESTful API 来实现前后端分离。Spring Boot 提供了便捷的方式来整合 RestTemplate，使能够轻松地调用远程 RESTful 服务。本文将详细讲解 Spring Boot 整合 RestTemplate 的方法。

二、依赖添加

在开始之前，需要确保项目中包含了 RestTemplate 的依赖。以下是使用 Maven 和 Gradle 添加依赖的示例：

Maven 示例：

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

Gradle 示例：

    dependencies {
        implementation 'org.springframework.boot:spring-boot-starter-web'
    }

三、创建 RestTemplate 实例

在 Spring Boot 应用中，可以通过以下方式创建 RestTemplate 实例：

    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpEntity;
    import org.springframework.http.HttpMethod;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.client.RestTemplate;
    
    public class MyService {
    
        @Autowired
        private RestTemplate restTemplate;
    
        public String callRemoteService(String url) {
            HttpEntity<String> entity = new HttpEntity<>("parameters", null);
            ResponseEntity<String> response = restTemplate.exchange(
                url,
                HttpMethod.GET,
                entity,
                String.class
            );
            return response.getBody();
        }
    }

四、使用 RestTemplate 发起请求

在 callRemoteService 方法中，RestTemplate 的 exchange 方法发起 HTTP 请求。exchange 方法接收以下参数：

  • HttpMethod：请求方法（GET, POST, PUT, DELETE 等）。
  • HttpEntity：包含请求头和请求体的实体对象。
  • Class<T>：期望的响应类型。

五、处理响应

exchange 方法返回一个 ResponseEntity 对象，它包含了响应的状态码、头信息和响应体。你可以根据需要处理这些信息：

  public class MyService {
    
        // ...
    
        public ResponseEntity<String> callRemoteServiceWithResponse(String url) {
            HttpEntity<String> entity = new HttpEntity<>("parameters", null);
            ResponseEntity<String> response = restTemplate.exchange(
                url,
                HttpMethod.GET,
                entity,
                String.class
            );
            return response;
        }
    }

六、高级用法

1. 自定义 RestTemplate 实例

在某些情况下，可能需要自定义 RestTemplate 实例，例如添加拦截器、设置连接超时等。以下是一个自定义 RestTemplate 实例的示例：

    import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
    import org.springframework.web.client.RestTemplate;
    
    public RestTemplate createCustomRestTemplate() {
        HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory();
        requestFactory.setConnectTimeout(5000); // 设置连接超时时间
        requestFactory.setReadTimeout(5000); // 设置读取超时时间
    
        return new RestTemplate(requestFactory);
    }

2. 文件上传、下载以及常见的 HTTP 请求

2.1. 配置 RestTemplate

首先，需要在 Spring Boot 项目中配置 RestTemplate。在 application.properties 文件中添加以下配置：

# application.properties
spring.resttemplate.connect-timeout=5000
spring.resttemplate.read-timeout=5000

然后在配置类中创建一个 RestTemplate Bean：

    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.client.RestTemplate;
    
    @Configuration
    public class AppConfig {
    
        @Bean
        public RestTemplate restTemplate() {
            return new RestTemplate();
        }
    }
2.2. 实现文件上传

文件上传是一个常见的需求，特别是在处理用户上传的图片、文档等资源时。以下是一个使用 RestTemplate 实现文件上传的示例：

    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.core.io.FileSystemResource;
    import org.springframework.http.HttpEntity;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.MediaType;
    import org.springframework.util.LinkedMultiValueMap;
    import org.springframework.util.MultiValueMap;
    import org.springframework.web.client.RestTemplate;
    
    public class FileService {
    
        @Autowired
        private RestTemplate restTemplate;
    
        public void uploadFile(String url, String filePath) {
            FileSystemResource file = new FileSystemResource(filePath);
            MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();
            body.add("file", file);
    
            HttpHeaders headers = new HttpHeaders();
            headers.setContentType(MediaType.MULTIPART_FORM_DATA);
    
            HttpEntity<MultiValueMap<String, Object>> requestEntity = new HttpEntity<>(body, headers);
    
            restTemplate.postForObject(url, requestEntity, String.class);
        }
    }

在这个示例中，首先创建了一个 FileSystemResource 对象来表示要上传的文件，然后将其添加到 MultiValueMap 中。接着，设置了请求头的 Content-Type 为 multipart/form-data，最后通过 RestTemplate 发送 POST 请求。

2.3. 实现文件下载

文件下载同样是一个常见的需求，特别是在提供资源给用户时。以下是一个使用 RestTemplate 实现文件下载的示例：

    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpEntity;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.HttpMethod;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.client.RestTemplate;
    
    import java.io.File;
    import java.util.Arrays;
    
    public class FileService {
    
        @Autowired
        private RestTemplate restTemplate;
    
        public void downloadFile(String url, String savePath) {
            HttpHeaders headers = new HttpHeaders();
            headers.setAccept(Arrays.asList(MediaType.APPLICATION_OCTET_STREAM));
    
            HttpEntity<String> requestEntity = new HttpEntity<>(headers);
    
            ResponseEntity<byte[]> response = restTemplate.exchange(url, HttpMethod.GET, requestEntity, byte[].class);
    
            if (response.getStatusCode().is2xxSuccessful()) {
                byte[] fileBytes = response.getBody();
                // 将文件字节数组保存到指定路径
                FileUtils.writeByteArrayToFile(new File(savePath), fileBytes);
            }
        }
    }

在这个示例中，设置了请求头的 Accept 为 application/octet-stream，以接收二进制文件数据。然后通过 RestTemplate 发送 GET 请求，并将响应的文件字节数组保存到指定路径。

2.4. 实现 GET、PUT 和 DELETE 请求

除了文件上传和下载，还需要处理常见的 HTTP 请求，如 GET、PUT 和 DELETE。以下是这些请求的实现示例：

GET 请求
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpEntity;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.HttpMethod;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.client.RestTemplate;
    
    import java.util.Arrays;
    
    public class FileService {
    
        @Autowired
        private RestTemplate restTemplate;
    
        public String getRequest(String url) {
            HttpHeaders headers = new HttpHeaders();
            headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
    
            HttpEntity<String> requestEntity = new HttpEntity<>(headers);
    
            ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.GET, requestEntity, String.class);
    
            if (response.getStatusCode().is2xxSuccessful()) {
                return response.getBody();
            } else {
                return null;
            }
        }
    }
PUT 请求
    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.web.client.RestTemplate;
    
    public class FileService {
    
        @Autowired
        private RestTemplate restTemplate;
    
        public void putRequest(String url, String requestBody) {
            HttpHeaders headers = new HttpHeaders();
            headers.setContentType(MediaType.APPLICATION_JSON);
    
            HttpEntity<String> requestEntity = new HttpEntity<>(requestBody, headers);
    
            restTemplate.put(url, requestEntity);
        }
    }
DELETE 请求
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpEntity;
    import org.springframework.http.HttpHeaders;
    import org.springframework.web.client.RestTemplate;
    
    public class FileService {
    
        @Autowired
        private RestTemplate restTemplate;
    
        public void deleteRequest(String url) {
            HttpHeaders headers = new HttpHeaders();
    
            HttpEntity<String> requestEntity = new HttpEntity<>(headers);
    
            restTemplate.delete(url, requestEntity);
        }
    }

七、总结

本文详细讲解了 Spring Boot 整合 RestTemplate 的方法，包括依赖添加、实例创建、请求发送、响应处理以及一些高级用法。

DebugDiver代码深处潜水员
关注
  • 14
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot进阶(71)：Spring Boot与RestTemplate：轻松实现RESTful API调用！
**My Coding Family**
09-08 1724
本文将从以下几个方面介绍Spring Boot与RestTemplate的应用： 1. 介绍Spring Boot和RestTemplate的基本概念和使用； 2. 用代码演示如何使用RestTemplate发起HTTP请求； 3. 介绍RestTemplate的常用方法和配置； 4. 编写测试用例进行测试。
Spring Boot进阶(96)：轻松上手：实战Spring Boot整合Docker
**My Coding Family**
10-30 3093
轻松上手：实战Spring Boot整合Docker。
Spring HTTP 客户端神器 RestTemplate 详解
大鹏的博客
03-02 1575
目前 Spring MVC 基本上已经成为了 Java Web 开发的首选框架，而 Web 开发除了要提供接口供客户端调用，我们的服务还经常作为其他服务的客户端。RestTemplate 作为 Spring 内置的 Http 客户端，由于和 Spring 框架整合程度较高，并且设计优秀，成为 Spring 开发首推的 HTTP 客户端。
《滚雪球学Spring Boot》教程导航帖（更新于2024.06.20）
热门推荐
**My Coding Family**
06-29 4万+
《滚雪球学Spring Boot》是由CSDN博主bug菌创作的全面Spring Boot教程。作者是全栈开发专家，在多个技术社区如CSDN、掘金、InfoQ、51CTO等担任博客专家，并拥有超过30万的全网粉丝。该教程分为入门篇和进阶篇，每篇包含详细的教学步骤，涵盖Spring Boot的基础和高级主题。
Spring Boot进阶(76)：使用Spring Boot和Jersey打造高效 RESTful API
**My Coding Family**
06-28 1250
本文将会介绍如何使用Spring Boot和Jersey来构建高效的RESTful API。首先，我们将会了解RESTful API的概念和特点。接着，我们将介绍如何配置Jersey和Spring Boot，以及如何使用Jersey提供RESTful服务。最后，我们将提供完整的代码和测试用例，并进行总结和展望。
Spring Cloud Alibaba 整合Nacos实战
congge_study的博客
03-05 7043
Spring Cloud Alibaba 整合Nacos
java实战2：利用Spring boot开发Restful 接口
weixin_43930865的博客
05-11 1万+
利用Spring boot开发Restful 接口 1：Spring boot 1.1：SpringBoot框架 SpringBoot框架一般分为View层、Controller层、Service层、Mapper层、pojo层。 View层：视图层，根据接到的数据展示页面给用户 Controller层：响应用户需求，决定用什么视图，需要准备什么数据来显示。Controller层负责前后端交互，接收前端请求，调用Service层，接收Service层返回的数据，最后返回具体的数据和页面到客户端 Service
Spring Boot进阶(93)：体验式教程：手把手教你整合Spring Boot和Zipkin
**My Coding Family**
10-28 4414
体验式教程：手把手教你整合Spring Boot和Zipkin。
【推荐图书】深入浅出Spring Boot 3.x
瑞新の博客：bennyrhys
07-06 1026
这部SpringBoot3.x经典之作，时隔六年迎来重磅升级！ 适合java开发相关读者
【Spring底层原理高级进阶】【SpringCloud整合Spring Security OAuth2】深入了解 Spring Security OAuth2：底层解析＋使用方法+实战
终于等到你啦~欢迎来到我的知识空间 这里是苏泽的成神之路
02-24 7866
OAuth2（Open Authorization 2.0）是一种用于授权的开放标准协议，用于通过第三方应用程序访问用户在某个服务提供商上存储的资源，而无需共享用户的凭证（例如用户名和密码）。它允许用户授权给第三方应用程序访问受保护的资源，同时确保用户的凭证信息不被直接暴露给第三方应用程序。OAuth2协议的设计目标是简化授权流程和提高安全性，通过委托授权的方式和使用令牌来实现用户和第三方应用程序之间的安全通信。它已成为许多互联网服务提供商和开发者在构建应用程序时常用的授权标准。
Spring Boot整合RabbitMQ开发实战详解
08-28
Spring Boot 整合 RabbitMQ 开发实战详解 首先，需要了解 RabbitMQ 中的一些基本概念，包括交换器（Exchange）、队列（Queue）和绑定（Binding）。交换器就像路由器，把消息发到交换器，然后交换器再根据路由键...
spring boot整合CAS配置详解
08-30
Spring Boot 整合 CAS 配置详解 Spring Boot 是一个基于 Java 的框架，提供了许多便捷的功能来快速开发 Web 应用程序。CAS（Central Authentication Service）是一种流行的身份验证协议，用于实现单点登录和单点...
Spring Boot 2 实战：自定义启动运行逻辑实例详解
08-19
"Spring Boot 2 自定义启动运行逻辑实战详解" 在 Spring Boot 2 中，自定义启动运行逻辑是非常重要的一部分。今天，我们将通过实战的方式，详细分析 Spring Boot 2 中自定义启动运行逻辑的详细操作技巧与注意事项。...
Spring Boot整合EhCache的步骤详解
08-25
在本文中，我们将深入探讨如何将EhCache与Spring Boot集成，以便在应用程序中实现高效的数据缓存。EhCache是一个流行的Java缓存框架，它以其高性能和轻量级特性而受到广泛使用，尤其在Hibernate中作为默认的...
关于Spring Boot WebSocket整合以及nginx配置详解
08-29
总结一下，整合Spring Boot与WebSocket的关键步骤包括： 1. 添加`spring-boot-starter-websocket`依赖。 2. 创建WebSocket处理类并实现`TextWebSocketHandler`。 3. 注册WebSocket处理类到Spring Boot应用配置中。 4...
Spring Boot
hai40587的博客
08-02 1105
在处理 Spring Boot 应用中的循环依赖问题时，重要的是要保持清晰的头脑和耐心。首先，要仔细分析问题的成因和上下文环境；其次，要尝试多种解决方案并评估其优缺点；最后，要关注应用的性能和稳定性，确保所采取的解决方案不会对应用产生负面影响。通过不断地学习和实践，我们可以逐渐掌握处理循环依赖的技巧和方法，为构建高性能、稳定的 Spring Boot 应用打下坚实的基础。
【Spring Boot】配置 Spring Security
最新发布
书山有路，学海无涯。记录成长，追逐梦想
08-02 895
Spring Security 提供了声明式的安全访问控制解决方案（仅支持基于 Spring 的应用程序），对访问权限进行认证和授权，它基于 Spring AOP 和 Servlet 过滤器，提供了安全性方面的全面解决方案。
基于Spring boot + Vue的灾难救援系统
NPCS_JQ的博客
08-02 414
以脚手架项目为基础完成的1.主页：echarts展示的图表2.系统管理：用户管理，角色管理，字典管理，菜单管理，日志管理3.文件管理：生成文件4.文章管理：集合富文本写文章5.公告管理：公告的管理6.轮播图管理：前台首页的轮播图7.灾难类型管理8.灾难记录9..资源调度10.预案管理11.科普信息。
Spring Boot项目实现调用腾讯云进行人脸识别
2301_76419561的博客
08-02 1374
​博客主页: 南来_北往系列专栏：Spring Boot实战随着科技的不断发展，人脸识别技术已经成为了一种日益重要的身份验证和安全监控手段。腾讯云人脸识别功能便是其中之一，而Java语言又是现在最为常用且高效的编程语言之一。本篇论文旨在探讨如何利用Java语言调用腾讯云的人脸识别功能。在本文中，我们介绍了腾讯云人脸识别的基本原理和实现方式以及Java语言的语法特性等相关知识。在此基础上，我们详细阐述了Java语言调用腾讯云人脸识别的步骤及程式代码。接着我们介绍了一些人脸识别的应用场景，如智能门禁、人
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值