SpringBoot中RestTemplate的使用详解

更新时间：2023年10月02日 09:43:54 作者：Archie_java

这篇文章主要介绍了SpringBoot中RestTemplate的使用详解,RestTemplate是由Spring框架提供的一个可用于应用中调用rest服务的类它简化了与http服务的通信方式,统一了RESTFul的标准,封装了http连接,我们只需要传入url及其返回值类型即可,需要的朋友可以参考下

RestTemplate的使用

GET请求

在RestTemplate中，发送一个GET请求，我们可以通过如下两种方式：

第一种：

getForEntity getForEntity方法的返回值是一个 ResponseEntity ， ResponseEntity 是 Spring 对 HTTP 请求响应的封装，包括了几个重要的元素，如响应码、contentType、contentLength、响应消息体等。比如下面一个例子：

@RequestMapping("/gethello")
public String getHello() {
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/hello", String.class);
    String body = responseEntity.getBody();
    HttpStatus statusCode = responseEntity.getStatusCode();
    int statusCodeValue = responseEntity.getStatusCodeValue();
    HttpHeaders headers = responseEntity.getHeaders();
    StringBuffer result = new StringBuffer();
    result.append("responseEntity.getBody()：").append(body).append("<hr>")
            .append("responseEntity.getStatusCode()：").append(statusCode).append("<hr>")
            .append("responseEntity.getStatusCodeValue()：").append(statusCodeValue).append("<hr>")
            .append("responseEntity.getHeaders()：").append(headers).append("<hr>");
    return result.toString();
}

getForEntity 的第一个参数为要调用的服务的地址，这里调用了服务提供者提供的/hello接口，注意这里是通过服务名调用而不是服务地址，如果写成服务地址就没法实现客户端负载均衡了。

getForEntity 第二个参数String.class表示希望返回的body类型是String类型拿到返回结果之后，将返回结果遍历打印出来最终显示结果如下：

在这里插入图片描述

有时候我在调用服务提供者提供的接口时，可能需要传递参数，有两种不同的方式，如下：

@RequestMapping("/sayhello")
public String sayHello() {
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={1}", String.class, "张三");
    return responseEntity.getBody();
}

@RequestMapping("/sayhello2")
public String sayHello2() {
    Map<String, String> map = new HashMap<>();
    map.put("name", "李四");
    ResponseEntity<String> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/sayhello?name={name}", String.class, map);
    return responseEntity.getBody();
}

可以用一个数字做占位符，最后是一个可变长度的参数，来一一替换前面的占位符
也可以前面使用name={name}这种形式，最后一个参数是一个map，map的key即为前边占位符的名字，map的value为参数值

第一个调用地址也可以是一个URI而不是字符串，这个时候我们构建一个URI即可，参数都包含在URI中了，如下：

@RequestMapping("/sayhello3")
public String sayHello3() {
    UriComponents uriComponents = UriComponentsBuilder.fromUriString("http://HELLO-SERVICE/sayhello?name={name}").build().expand("王五").encode();
    URI uri = uriComponents.toUri();
    ResponseEntity<String> responseEntity = restTemplate.getForEntity(uri, String.class);
    return responseEntity.getBody();
}

通过Spring中提供的UriComponents来构建Uri即可。

当然，服务提供者不仅可以返回String，也可以返回一个自定义类型的对象，比如服务提供者中有如下方法：

@RequestMapping(value = "/getbook1", method = RequestMethod.GET)
public Book book1() {
    return new Book("三国演义", 90, "罗贯中", "花城出版社");
}

对于该方法可以在服务消费者中通过如下方式来调用

@RequestMapping("/book1")
public Book book1() {
    ResponseEntity<Book> responseEntity = restTemplate.getForEntity("http://HELLO-SERVICE/getbook1", Book.class);
    return responseEntity.getBody();
}

运行结果如下：

在这里插入图片描述

第二种：getForObject

getForObject函数实际上是对getForEntity函数的进一步封装，如果你只关注返回的消息体的内容，对其他信息都不关注，此时可以使用getForObject，举一个简单的例子，如下：

@RequestMapping("/book2")
public Book book2() {
    Book book = restTemplate.getForObject("http://HELLO-SERVICE/getbook1", Book.class);
    return book;
}

getForObject也有几个重载方法

在这里插入图片描述

POST请求

在RestTemplate中，POST请求可以通过如下三个方法来发起：

第一种：postForEntity 该方法和get请求中的getForEntity方法类似，如下例子：

@RequestMapping("/book3")
public Book book3() {
    Book book = new Book();
    book.setName("红楼梦");
    ResponseEntity<Book> responseEntity = restTemplate.postForEntity("http://HELLO-SERVICE/getbook2", book, Book.class);
    return responseEntity.getBody();
}

方法的第一参数表示要调用的服务的地址
方法的第二个参数表示上传的参数
方法的第三个参数表示返回的消息体的数据类型

创建了一个Book对象，这个Book对象只有name属性有值，将之传递到服务提供者那里去，服务提供者代码如下：

@RequestMapping(value = "/getbook2", method = RequestMethod.POST)
public Book book2(@RequestBody Book book) {
    System.out.println(book.getName());
    book.setPrice(33);
    book.setAuthor("曹雪芹");
    book.setPublisher("人民文学出版社");
    return book;
}

服务提供者接收到服务消费者传来的参数book，给其他属性设置上值再返回，调用结果如下：

在这里插入图片描述

第二种：postForObject 如果你只关注返回的消息体，可以直接使用postForObject。

用法和getForObject一致。

第三种：

postForLocation postForLocation也是提交新资源，提交成功之后，返回新资源的URI，postForLocation的参数和前面两种的参数基本一致，只不过该方法的返回值为Uri，这个只需要服务提供者返回一个Uri即可，该Uri表示新资源的位置。

PUT请求

在RestTemplate中，PUT请求可以通过put方法调用，put方法的参数和前面介绍的postForEntity方法的参数基本一致，只是put方法没有返回值而已。如下：

@RequestMapping("/put")
public void put() {
    Book book = new Book();
    book.setName("红楼梦");
    restTemplate.put("http://HELLO-SERVICE/getbook3/{1}", book, 99);
}

DELETE请求

delete请求我们可以通过delete方法调用来实现

@RequestMapping("/delete")
public void delete() {
    restTemplate.delete("http://HELLO-SERVICE/getbook4/{1}", 100);
}

到此这篇关于SpringBoot中RestTemplate的使用详解的文章就介绍到这了,更多相关RestTemplate的使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Scala可变参数列表，命名参数和参数缺省详解
这篇文章主要介绍了Scala可变参数列表，命名参数和参数缺省详解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-06-06
解读JVM的生命周期是怎么样的
JVM的生命周期包括启动、运行和终止三个阶段,启动阶段包括创建JVM实例、加载和初始化核心类库、加载main方法所在的类和初始化类,运行阶段包括执行main方法、类加载、字节码执行、内存管理、线程管理和异常处理,终止阶段包括正常终止、异常终止和外部终止
2025-03-03
Java字节流和字符流总结IO流!
下面小编就为大家带来一篇Java IO流字节流和字符流的实例讲解。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2021-07-07
Java中常见的编码集问题总结
这篇文章主要为大家整理了一些Java中常见的编码集问题，文中的示例代码讲解详细，对我们深入理解Java有一定的帮助，感兴趣的小伙伴可以了解一下
2023-02-02
Spring中的InitializingBean接口的使用
这篇文章主要介绍了Spring中的InitializingBean接口的使用,需要的朋友可以参考下
2018-04-04
thymeleaf实现前后端数据交换的示例详解
Thymeleaf 是一款用于渲染 XML/XHTML/HTML5 内容的模板引擎，当通过 Web 应用程序访问时，Thymeleaf 会动态地替换掉静态内容，使页面动态显示，这篇文章主要介绍了thymeleaf实现前后端数据交换,需要的朋友可以参考下
2022-07-07
阿里资深技术专家:在各阶段中3年经验的java程序员应该具备哪些技术能力
这篇文章主要介绍了阿里资深技术专家:在各阶段中3年经验的java程序员应该具备哪些技术能力,本文给大家列举了一些内容，大家可以根据自己需要有方法的掌握，感兴趣的朋友跟随小编一起看看吧
2020-07-07
java网络编程学习java聊天程序代码分享
java聊天程序代码分享,大家参考使用吧
2013-12-12
SpringAOP切点函数实现原理详解
这篇文章主要介绍了SpringAOP切点函数实现原理详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-05-05
Spring AI 入门学习指南
本文介绍了如何使用SpringAI和Ollama进行AI开发,包括如何配置和使用聊天、图像、语音转文字和文字转语音模型,以及如何在Java项目中集成Ollama模型,感兴趣的朋友一起看看吧
2024-11-11

SpringBoot中RestTemplate的使用详解

目录

RestTemplate的使用

GET请求

POST请求

PUT请求

DELETE请求

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具