Spring Boot 教程：Rest 模板

最新推荐文章于 2023-04-04 16:39:06 发布
最新推荐文章于 2023-04-04 16:39:06 发布
阅读量310 收藏
点赞数
分类专栏： 信码由缰
原文链接：https://www.tutorialspoint.com/spring_boot/spring_boot_rest_template.htm
版权

【注】本文译自： https://www.tutorialspoint.com/spring_boot/spring_boot_rest_template.htm

Rest 模板用于创建消费 RESTful Web 服务的应用。你可以使用 exchange() 方法来消费所有 HTTP 方法的 web 服务。下面的代码展示了如何创建 Rest 模板 Bean 来自动绑定 Rest 模板对象：

package com.tutorialspoint.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;

@SpringBootApplication
public class DemoApplication {
   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
   @Bean
   public RestTemplate getRestTemplate() {
      return new RestTemplate();
   }

GET

使用 RestTemplate - exchange() 方法消费 GET API

假设这个 URL http://localhost:8080/products 返回下面的 JSON ，我们要通过后面的代码使用 Rest 模板来消费这个 API 响应：

[
   {
      "id": "1",
      "name": "Honey"
   },
   {
      "id": "2",
      "name": "Almond"
   }
]

你要通过以下几点来消费 API：

  • 自动绑定 Rest 模板对象

  • 使用 HttpHeaders 设置请求头

  • 使用 HttpEntity 包装请求对象

  • 为 Exchange() 方法提供 URL、HttpMethod 和返回值类型

@RestController
public class ConsumeWebService {
   @Autowired
   RestTemplate restTemplate;

   @RequestMapping(value = "/template/products")
   public String getProductList() {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity <String> entity = new HttpEntity<String>(headers);
      
      return restTemplate.exchange("
         http://localhost:8080/products", HttpMethod.GET, entity, String.class).getBody();
   }
}

POST

使用 RestTemplate - exchange() 方法消费 POST API

假设 URL http://localhost:8080/products 返回如下响应，我们要使用 Rest 模板来消费这个 API 响应。

请求体代码如下：

{
    "id":"3",
    "name":"Ginger"
}

响应体代码如下：

Product is created successfully

你要通过以下几点来消费 API：

  • 自动绑定 Rest 模板对象

  • 使用 HttpHeaders 设置请求头

  • 使用 HttpEntity 包装请求对象，这里我们包装了产品对象发送给请求体

  • 为 Exchange() 方法提供 URL、HttpMethod 和返回值类型

@RestController
public class ConsumeWebService {
   @Autowired
   RestTemplate restTemplate;

   @RequestMapping(value = "/template/products", method = RequestMethod.POST)
   public String createProducts(@RequestBody Product product) {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products", HttpMethod.POST, entity, String.class).getBody();
   }
}

PUT

使用 RestTemplate - exchange() 方法消费 PUT API

假设 URL http://localhost:8080/products/3 返回下面的响应，我们要使用 Rest 模板来消费这个 API 响应。

请求体代码如下：

{
    "name": "Indian Ginger"
}

响应体代码如下：

Product is updated successfully

你要通过以下几点来消费 API：

  • 自动绑定 Rest 模板对象

  • 使用 HttpHeaders 设置请求头

  • 使用 HttpEntity 包装请求对象，这里我们包装了产品对象发送给请求体

  • 为 Exchange() 方法提供 URL、HttpMethod 和返回值类型

@RestController
public class ConsumeWebService {
   @Autowired
   RestTemplate restTemplate;

   @RequestMapping(value = "/template/products/{id}", method = RequestMethod.PUT)
   public String updateProduct(@PathVariable("id") String id, @RequestBody Product product) {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products/"+id, HttpMethod.PUT, entity, String.class).getBody();
   }
}

DELETE

使用 RestTemplate - exchange() 方法消费 DELETE API

假设 URL http://localhost:8080/products/3 返回下面的响应，我们要使用 Rest 模板来消费这个 API 响应。

响应体代码如下：

Product is deleted successfully

你要通过以下几点来消费 API：

  • 自动绑定 Rest 模板对象

  • 使用 HttpHeaders 设置请求头

  • 使用 HttpEntity 包装请求对象

  • 为 Exchange() 方法提供 URL、HttpMethod 和返回值类型

@RestController
public class ConsumeWebService {
   @Autowired
   RestTemplate restTemplate;

   @RequestMapping(value = "/template/products/{id}", method = RequestMethod.DELETE)
   public String deleteProduct(@PathVariable("id") String id) {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<Product> entity = new HttpEntity<Product>(headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products/"+id, HttpMethod.DELETE, entity, String.class).getBody();
   }
}

完整的 Rest 模板控制器类代码文件如下：

package com.tutorialspoint.demo.controller;

import java.util.Arrays;

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.MediaType;

import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

import com.tutorialspoint.demo.model.Product;

@RestController
public class ConsumeWebService {
   @Autowired
   RestTemplate restTemplate;

   @RequestMapping(value = "/template/products")
   public String getProductList() {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<String> entity = new HttpEntity<String>(headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products", HttpMethod.GET, entity, String.class).getBody();
   }
   @RequestMapping(value = "/template/products", method = RequestMethod.POST)
   public String createProducts(@RequestBody Product product) {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products", HttpMethod.POST, entity, String.class).getBody();
   }
   @RequestMapping(value = "/template/products/{id}", method = RequestMethod.PUT)
   public String updateProduct(@PathVariable("id") String id, @RequestBody Product product) {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<Product> entity = new HttpEntity<Product>(product,headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products/"+id, HttpMethod.PUT, entity, String.class).getBody();
   }
   @RequestMapping(value = "/template/products/{id}", method = RequestMethod.DELETE)
   public String deleteProduct(@PathVariable("id") String id) {
      HttpHeaders headers = new HttpHeaders();
      headers.setAccept(Arrays.asList(MediaType.APPLICATION_JSON));
      HttpEntity<Product> entity = new HttpEntity<Product>(headers);
      
      return restTemplate.exchange(
         "http://localhost:8080/products/"+id, HttpMethod.DELETE, entity, String.class).getBody();
   }
}

Spring Boot 应用类 – DemoApplication.java 如下所示：

package com.tutorialspoint.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
}

Maven build – pom.xml 如下：

<?xml version = "1.0" encoding = "UTF-8"?>
<project xmlns = "http://maven.apache.org/POM/4.0.0" 
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.tutorialspoint</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <name>demo</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.8.RELEASE</version>
      <relativePath/> 
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>

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

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

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
</project>

Gradle Build – build.gradle 如下：

buildscript {
    ext {
       springBootVersion = '1.5.8.RELEASE'
    }
    repositories {
       mavenCentral()
    }
    dependencies {
       classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
 }
 
 apply plugin: 'java'
 apply plugin: 'eclipse'
 apply plugin: 'org.springframework.boot'
 
 group = 'com.tutorialspoint'
 version = '0.0.1-SNAPSHOT'
 sourceCompatibility = 1.8
 
 repositories {
    mavenCentral()
 }
 dependencies {
    compile('org.springframework.boot:spring-boot-starter-web')
    testCompile('org.springframework.boot:spring-boot-starter-test')
 }

你可以使用 Maven 或 Graven 命令 创建可执行 JAR 文件，并运行 Spring Boot 应用：

Maven 可以使用以下命令：

mvn clean install

在 “BUILD SUCCESS” 之后 ，你可以在 target 目录下找到 JAR 文件：

对于 Gradle，可以使用以下命令：

gradle clean build

在 “BUILD SUCCESSFUL” 之后，你可以在 build/libs 目录下找到 JAR 文件：

使用以下命令运行 JAR 文件：

java –jar <JARFILE>

现在应用已经在 Tomcat 上以 8080 端口上启动了：

在 POSTMAN 应用中输入 URL 可以看到下面的输出：

使用 Rest 模板 GET 产品：http://localhost:8080/template/products

创建产品 POST：http://localhost:8080/template/products

更新产品 PUT：http://localhost:8080/template/products/3

删除产品：http://localhost:8080/template/products/3

 

 

信码由缰
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring boot restTemplate
xiao/du的博客
05-10 585
文章目录Spring boot jdbcTemplate上一节源码Spring boot jdbcTemplate下一节 Spring boot servlet,filter,Interceptor Spring boot jdbcTemplate 上一节 源码 Spring boot jdbcTemplate 下一节 Spring boot servlet,filter,Interceptor
spring-crud:使用Spring Boot实现的REST API的实现
05-24
【Spring CRUD：使用Spring Boot实现REST API的实现】 在现代Web开发中，Spring Boot框架以其高效、便捷的特点，成为构建RESTful API的首选工具。"spring-crud"项目是基于Spring Boot实现的一个基本的CRUD（创建、...
Spring Boot 中的 RestTemplate
CHENFU_ZKK的博客
05-05 703
文章目录RestTemplate 访问 Web 资源请求方式GET 请求POST 请求PUT 请求DELETE 请求RestTemplate 高阶用法构造 URI传递 HTTP Header类型转换解析泛型对象定制 Rest TemplateRest Teamplate 支持的 HTTP 库通用接口默认实现第三方实现优化底层请求策略连接管理超时设置SSL 校验自定义配置示例【使用 httpcomp...
Springboot 使用RestTemplate
热门推荐
醇醛酸酯 的博客
11-30 3万+
最近项目中springboot使用了RestTemplate，在此了解和学习了一下，有问题请指正 1、先学习最简单的使用 创建RestTemplate public static RestTemplate restTemplate() { SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory(); requestFactory.setConnectTime.
springboot使用RestTemplate
Happywzy~的博客
05-12 480
开发带参数的restful接口 @RequestParam // URL路径格式: /trigger?taskId=xxxxxxxxxx @GetMapping("/trigger") public String trigger(@RequestParam(value = "taskId") String taskId) { tableCompareService.compare(taskId); return "ok"; } @PathVariable // URL路径格式: /trig
Spring Boot 入门（三）拦截器、过滤器、Rest 模板
weixin_41750142的博客
02-08 419
文章目录一、Spring Boot 拦截器二、Spring Boot Servlet 过滤器三、Spring Boot Rest 模板（1）GET???? 补充：Java Web 中 拦截器和过滤器 一、Spring Boot 拦截器     在 Spring Boot 中使用拦截器（看到“拦截器”，可以想到 AOP 的思想????），可在以下情况下执行操作 ： preHandle() ：在将 请求 发送到 控制器 之前 —— 在 controller 之前。 po
spring-boot中文教程
最新发布
05-09
Spring Boot是一款基于Spring框架的快速开发框架，它提供了一系列的开箱即用的功能和组件，可以帮助用户快速搭建Web应用程序、REST服务、批处理任务等。Spring Boot还提供了一些高级特性，例如自动配置、Actuator、...
boot-spring-boot：“启动Spring Boot：스프링기”
01-29
1. **模板引擎** - Spring Boot 支持多种模板引擎，如 Thymeleaf、Freemarker 和 Groovy。Thymeleaf 是一种常用的 HTML 模板引擎，支持服务器端渲染。 2. **配置视图解析器** - 在 `application.properties` 中配置 ...
springboot-h2-mockmvc:Rest API Spring Boot嵌入式H2 Mockmvc测试
03-25
在本文中，我们将深入探讨如何使用Spring Boot与H2数据库以及MockMvc进行REST API的测试。Spring Boot简化了Java应用程序的开发，而H2是一个内存中的数据库，适用于快速的单元和集成测试。MockMvc则是Spring提供的一...
webshop-client：具有spring boot rest模板的webshop客户端
02-26
【标题】"webshop-client：具有spring boot rest模板的webshop客户端" 描述了一款基于Spring Boot技术构建的Web应用程序，其主要功能是作为网上商店的客户端，利用RESTful API与服务器进行通信。Spring Boot是一种...
详解SpringBoot中RestTemplate的几种实现
08-25
主要介绍了详解SpringBoot中RestTemplate的几种实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot - 集成RestTemplate模板(一) - 基本介绍
记录并分享
04-04 185
RESTTEMPLATE是SPRING提供的用于访问REST服务的客户端，提供了多种可以访问远程HTTP服务的方法，能够大大提高客户端的编写效率。
SOE编程：REST模板解析
knqiufan的博客
02-27 737
使用工具：Visual Studio 2010目标框架：.NET Framework 3.5 新建项目 -&gt; ArcGIS -&gt; Server Object Extensions -&gt; REST Template以下为REST模板的内容解析：using System; using System.Collections.Generic; using System.Linq; usi...
易筋SpringBoot 2.1 | 第三篇：RestTemplate请求HTTP(1)
AI架构师易筋
12-26 1595
说明 传统情况下在java代码里访问restful服务，一般使用Apache的HttpClient。不过此种方法使用起来太过繁琐。spring提供了一种简单便捷的模板类来进行操作，这就是RestTemplate。 使用estTemplate访问restful接口非常的简单粗暴无脑, 一句代码请求。(url, RequestMap, ResponseBean.class)这三个参数分别代表 请求地...
Springboot中使用RestTemplate（一种更为优雅的调用RESTful服务的方式）
我是你妹她哥的博客
08-06 1万+
背景 我们在开发java后端的时候，多多少少会遇到一些需要接受别人数据的时候，那通常这种情况，对面大多数情况下都会使用HTTP的方式来提供接口。按照之前的开发经验，大多数人会采用apache的HttpClient开发，或者使用OKHTTP开发。但这两种方式，都需要很长一段代码（或者我直接复制一个类过来），代码复杂、还要担心资源回收的问题。 RestTemplate是Spring用于同步clien...
02-Spring REST Template教程02
文思源想的技术空间
10-23 428
02-Spring REST Template教程02 说明：本文主要整理了spring-boot中rest template的使用方法，通过对 依赖、生产、主要方法的简要介绍，读者可以较快掌握Spring Boot Rest客户端的简单编码，文章也针对实际代码编写过程中的一些进阶要求，做了简要说明，这里包括：泛型对象转换、复杂对象序列化及反序列化定制、依赖其他库、链接复用、优化策略。 代码学习仓库如下所示： 1 gradle依赖 spring-boot-starter-web依赖中已经包含了REST Te
SpringCloud：Rest请求模板
酸奶牛的博客
05-04 89
RestTemplete请求模板类解读
Denial_learn的博客
09-08 330
当我们服务消费者去调用服务提供者提供的服务的时候，使用了一个极其方便的对象RestTemplate，我们通常使用RestTemplate中最简单的一个功能getForObject 发起了一个get请求去调用服务端的数据，同时，我们还通过配置@LoadBalanced注解开启客户端负载均衡，RestTemplate的功能非常强大， 接下来我们就来详细的看一下RestTemplate中几种常见请求方法的使用，在日常操作中，基于Rest的方式通常是四种情况，它们分别是： GET 请求 --查询数据 POST 请
RestTemplate
Myzoneliver的博客
06-30 500
get getForEntity 有三种形式 ResponseEntity getForEntity(URI url, Class responseType) ResponseEntity getForEntity(String url, Class responseType, Map<String,?> uriVariables) ResponseEntity getF...
基于Spring Boot旅游网站参考文献
05-04
以下是基于Spring Boot的旅游网站的参考文献： 1. Spring Boot官方文档：...以上参考文献可以帮助你了解如何使用Spring Boot构建一个功能完整的旅游网站，并提供了相关的教程和示例代码。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值