当前位置: 开发笔记 > 前端 > 正文

SpringBootRestTemplateGETPOST请求的实例讲解

作者：云中之锦书 | 来源：互联网 | 2022-03-15 06:12

这篇文章主要介绍了SpringBootRestTemplateGETPOST请求的实例讲解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧

一）RestTemplate简介

RestTemplate是HTTP客户端库提供了一个更高水平的API。主要用于Rest服务调用。

RestTemplate方法：

方法组	描述
getForObject	通过GET检索表示形式。
getForEntity	ResponseEntity通过使用GET 检索（即状态，标头和正文）。
headForHeaders	通过使用HEAD检索资源的所有标头。
postForLocation	通过使用POST创建新资源，并Location从响应中返回标头。
postForObject	通过使用POST创建新资源，并从响应中返回表示形式。
postForEntity	通过使用POST创建新资源，并从响应中返回表示形式。
put	通过使用PUT创建或更新资源。
patchForObject	通过使用PATCH更新资源，并从响应中返回表示形式。请注意，JDK HttpURLConnection不支持PATCH，但是Apache HttpComponents和其他支持。
delete	使用DELETE删除指定URI处的资源。
optionsForAllow	通过使用ALLOW检索资源的允许的HTTP方法。
exchange	前述方法的通用性强（且意见少的版本），在需要时提供了额外的灵活性。它接受RequestEntity（包括HTTP方法，URL，标头和正文作为输入）并返回ResponseEntity。这些方法允许使用ParameterizedTypeReference而不是Class使用泛型来指定响应类型。
execute	执行请求的最通用方法，完全控制通过回调接口进行的请求准备和响应提取。

二）RestTemplate案例

第一步：创建一个maven项目，在pom.xml引入一个springboot的版本

pom.xml内容：


  4.0.0
  com.oysept
  spring_resttemplate
  0.0.1-SNAPSHOT
  jar
 
  
    org.springframework.boot
    spring-boot-starter-parent
    2.1.4.RELEASE
    
  
 
  
    
      org.springframework.boot
      spring-boot-starter-web
    
  
  
  
    
      
        org.springframework.boot
        spring-boot-maven-plugin
        
          com.oysept.RestTemplateApplication
        
      
      
        org.apache.tomcat.maven
        tomcat7-maven-plugin

application.yml配置：该配置就一个默认端口

server:

port: 8080

创建一个springboot启动类RestTemplateApplication

package com.oysept;
 
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
 
@SpringBootApplication
public class RestTemplateApplication {
 
  public static void main(String[] args) {
    new SpringApplicationBuilder(RestTemplateApplication.class).run(args);
  }
}

到此步骤时，可以先运行RestTemplateApplication中的main方法，检验springboot启动是否正常。

第二步：创建一个RestTemplate配置类并注入，因为在使用时，不提前注入ResttTemplate，在通过@Autowired使用会报RestTemplate找不到

package com.oysept.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;
 
/**
 * 注册一个RestTemplate Bean, 否则直接通过@Autowired使用会报RestTemplate找不到
 * @author ouyangjun
 */
@Configuration
public class RestTemplateConfig {
 
  /**
   * 方式一: 默认是使用JDK原生java.net.HttpURLConnection请求
   * @return
   */
  @Bean(name = "restTemplate")
  public RestTemplate restTemplate() {
    return new RestTemplate();
  }
 
  /**
   * 方式二: 使用apache http内置请求, 需要在pom.xml中引入相应的apache jar
   * 可以使用HttpClient，设置一些http连接池等信息
   * @return
   *
  @Bean(name = "restTemplate")
  public RestTemplate restTemplate() {
    return new RestTemplate(new HttpComponentsClientHttpRequestFactory());
  }
   */
 
  /**
   * 方式三: 使用OkHttp内置请求, 需要在pom.xml中引入相应的OkHttp3 jar
   * 可以使用OkHttpClient，设置一些http连接池信息
   * @return
   *
  @Bean(name = "restTemplate")
  public RestTemplate restTemplate() {
    return new RestTemplate(new OkHttp3ClientHttpRequestFactory());
  }
  */
}

第三步：创建一个VO类，用于测试入参和出参

package com.oysept.vo; 
public class MsgVO { 
  private String msgKey;
  private String msgValue;
 
  public String getMsgKey() {return msgKey;}
  public void setMsgKey(String msgKey) {this.msgKey = msgKey;}
 
  public String getMsgValue() {return msgValue;}
  public void setMsgValue(String msgValue) {this.msgValue = msgValue;}
 
  public String toString() {
    return "MsgVO [msgKey: "+this.msgKey+", msgValue: "+this.msgValue+"]";
  }
}

第四步：创建一个服务端接口，用于测试

package com.oysept.controller;
 
import java.util.ArrayList;
import java.util.List; 
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.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
import com.oysept.vo.MsgVO;
 
/**
 * 服务端, 提供接口被调用
 * @author ouyangjun
 */
@RestController
public class ServerController {
 
  // 无参GET请求: http://localhost:8080/server/get
  @RequestMapping(value = "/server/get", method = RequestMethod.GET)
  public String get() {
    return "/server/get";
  }
 
  // 带参GET请求: http://localhost:8080/server/get/param&＃63;param=111222333444
  @RequestMapping(value = "/server/get/param", method = RequestMethod.GET)
  public String getParam(@RequestParam(value = "param") String param) {
    return "/server/get/param," + param;
  }
 
  // 路径中带参GET请求: http://localhost:8080/server/get/url/AAAA/BBBB
  @RequestMapping(value = "/server/get/url/{one}/{two}", method = RequestMethod.GET)
  public String getUrl(@PathVariable("one") String one, @PathVariable("two") String two) {
    return "/get/url/{one}/{two}," + one + "," + two;
  }
 
  // 无参GET请求, 返回List: http://localhost:8080/server/get/list
  @RequestMapping(value = "/server/get/list", method = RequestMethod.GET)
  public List getList() {
    List list = new ArrayList();
    list.add(11);
    list.add("AA");
    return list;
  }
 
  // 无参GET请求, 返回对象: http://localhost:8080/server/get/MsgVO
  @RequestMapping(value = "/server/get/MsgVO", method = RequestMethod.GET)
  public MsgVO getMsgVO() {
    MsgVO vo = new MsgVO();
    vo.setMsgKey("keyAAA");
    vo.setMsgValue("valueBBB");
    return vo;
  }
 
  // POST请求, 表单参数, application/x-www-form-urlencoded
  @RequestMapping(value = "/server/post/form", method = RequestMethod.POST, 
    cOnsumes= MediaType.APPLICATION_FORM_URLENCODED_VALUE)
  public MsgVO postForm(MsgVO msgVO) {
    System.out.println("msgKey: " + msgVO.getMsgKey() + ", msgValue: " + msgVO.getMsgValue());
    return msgVO;
  }
 
  // POST请求, JSON参数, application/json
  @RequestMapping(value = "/server/post/json", method = RequestMethod.POST, 
      cOnsumes= MediaType.APPLICATION_JSON_UTF8_VALUE,
      produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
  public MsgVO postJson(@RequestBody MsgVO msgVO) {
    System.out.println("msgKey: " + msgVO.getMsgKey() + ", msgValue: " + msgVO.getMsgValue());
    return msgVO;
  }
}

第五步：创建一个测试服务端接口的API

import的类和注入的RestTemplate：

package com.oysept.controller; 
import java.net.URI;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
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 org.springframework.web.util.UriComponentsBuilder;
 
import com.oysept.vo.MsgVO;
 
/**
 * 客户端, 调用服务端提供的接口
 * @author ouyangjun
 */
@RestController
public class ClientController {
 
  // 使用默认请求方式
  @Autowired
  @Qualifier(value = "restTemplate")
  private RestTemplate restTemplate;
 
  // 在此处添加客户端测试代码
}

1、GET请求

// 直接在浏览中输入访问地址: http://localhost:8080/client/get
@RequestMapping(value = "/client/get", method = RequestMethod.GET)
public String get() {
  // 无参GET请求
  String get = restTemplate.getForObject("http://localhost:8080/server/get", String.class);
  System.out.println("==>/server/get return: " + get);
 
  // 带参GET请求
  String getParam = restTemplate.getForObject("http://localhost:8080/server/get/param&＃63;param=111222333444", String.class);
  System.out.println("==>/server/get/param return: " + getParam);
 
  // 带参GET url请求
  String getUrlParam = restTemplate.getForObject("http://localhost:8080/server/get/url/{one}/{two}", String.class, "AAAA", "BBBB");
  System.out.println("==>/server/get/url/{one}/{two} return: " + getUrlParam);
 
  // 带参GET url请求
  Map vars = new HashMap();
  vars.put("one", "HHHH");
  vars.put("two", "EEEE");
  String getUrlVars = restTemplate.getForObject("http://localhost:8080/server/get/url/{one}/{two}", String.class, vars);
  System.out.println("==>/server/get/url/{one}/{two} return: " + getUrlVars);
 
  // 无参GET请求, 返回List
  @SuppressWarnings("unchecked")
  List getList = restTemplate.getForObject("http://localhost:8080/server/get/list", List.class);
  System.out.println("==>/server/get/list return: " + getList);
 
  // GET请求, 返回对象
  ResponseEntity entity = restTemplate.getForEntity("http://localhost:8080/server/get/MsgVO", MsgVO.class);
  System.out.println("==>/server/get/list return: " + entity.getBody());
  return "GET SUCCESS";
}

2、GET url中传参请求

// 直接在浏览中输入访问地址: http://localhost:8080/client/get/request
// GET请求, url参数, 在表头中添加参数
@RequestMapping(value = "/client/get/request", method = RequestMethod.GET)
public String getRequest() {
  // url中参数
  Map vars = new HashMap();
  vars.put("one", "HHHH");
  vars.put("two", "EEEE");
 
  // 请求地址
  String uriTemplate = "http://localhost:8080/server/get/url/{one}/{two}";
  // 给URL地址encode转码
  URI uri = UriComponentsBuilder.fromUriString(uriTemplate).buildAndExpand(vars).toUri();
  // GET请求参数
  RequestEntity requestEntity = 
        RequestEntity.get(uri)
        .header("MyHeader", "aaabbbcccddd")
        .build();
  // 响应
  ResponseEntity respOnse= restTemplate.exchange(requestEntity, String.class);
  // 结果
  System.out.println("==>/get/request header: " + response.getHeaders().getFirst("MyHeader"));
  System.out.println("==>/get/request body: " + response.getBody());
  return "POST SUCCESS";
}

3、POST application/x-www-form-urlencoded表单传参请求

// 直接在浏览中输入访问地址: http://localhost:8080/client/postForm
// POST请求, form表单入参
@RequestMapping(value = "/client/postForm", method = RequestMethod.GET)
public String postForm() {
  // uri
  String uriTemplate = "http://localhost:8080/server/post/form";
 
  // 设置请求头为form形式: application/x-www-form-urlencoded
  HttpHeaders headers = new HttpHeaders();
  headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
 
  // 设置参数, 和MsgVO中变量名对应
  MultiValueMap map = new LinkedMultiValueMap();
  map.add("msgKey", "1234");
  map.add("msgValue", "TestTest");
 
  // 封装请求参数
  HttpEntity> requestb = new HttpEntity>(map,
  headers);
  ResponseEntity respOnse= restTemplate.postForEntity(uriTemplate, requestb, String.class);
  System.out.println("==>/server/post/form return: " + response.getBody());
  return "POST SUCCESS";
}

4、POST application/json JSON传参请求

// 直接在浏览中输入访问地址: http://localhost:8080/client/postJson
// POST请求, JSON入参
@RequestMapping(value = "/client/postJson", method = RequestMethod.GET)
public String postJson() {
  // json入参
  MsgVO vo = new MsgVO();
  vo.setMsgKey("TTT");
  vo.setMsgValue("KKK");
 
  String uriTemplate = "http://localhost:8080/server/post/json";
  URI uri = UriComponentsBuilder.fromUriString(uriTemplate).buildAndExpand().toUri();
 
  RequestEntity requestEntity = 
      RequestEntity.post(uri)
      .header("Content-Type", "application/json; charset=UTF-8")
      .body(vo);
  
  ResponseEntity respOnse= restTemplate.exchange(requestEntity, MsgVO.class);
  System.out.println("==>/server/post/json return: " + response.getBody());
  return "POST SUCCESS";
}

项目结构图：

以上这篇SpringBoot RestTemplate GET POST请求的实例讲解就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持。

推荐阅读

build
Spring Boot Maven项目配置详解

本文详细介绍了如何在Spring Boot项目中配置Maven的pom.xml文件，包括项目的基本信息、依赖管理及构建插件的设置。 ... [详细]

蜡笔小新 2024-12-13 21:32:29
build
JSP服务器概述及搭建指南

本文详细介绍了JSP服务器的概念、主流服务器软件及其搭建步骤，旨在帮助开发者更好地理解和使用JSP技术。 ... [详细]

蜡笔小新 2024-12-13 14:42:46
js
Eclipse 中 Maven 的基础配置指南

本文详细介绍了如何在 Eclipse 环境中配置 Maven，包括环境变量的设置、Maven 插件的安装与配置等关键步骤，旨在帮助开发者顺利搭建开发环境。 ... [详细]

蜡笔小新 2024-12-12 18:18:29
js
深入解析Apache SkyWalking CVE-2020-9483 SQL注入漏洞

本文详细探讨了Apache SkyWalking中的SQL注入漏洞（CVE-2020-9483），特别是其影响范围、漏洞原因及修复方法。Apache SkyWalking是一款强大的应用性能管理工具，广泛应用于微服务架构中。然而，该漏洞使得未经授权的攻击者能够通过特定的GraphQL接口执行恶意SQL查询，从而获取敏感信息。 ... [详细]

蜡笔小新 2024-12-12 17:16:40
overflow
详解与示例：Apache Polygene中的AssociationDescriptor.qualifiedName()方法

本文深入探讨了在Java编程语言中，如何使用`org.apache.polygene.api.association.AssociationDescriptor.qualifiedName()`方法，并提供了多个实际应用的代码示例。这些示例源自GitHub、StackOverflow和Maven等知名平台，旨在帮助开发者更好地理解和应用这一方法。 ... [详细]

蜡笔小新 2024-12-11 09:02:53
overflow
Pikachu SQL注入实战解析

作为一名网络安全新手，本文旨在记录个人在SQL注入方面的学习过程与心得，以备后续复习之用。通过逐步深入的学习，力求掌握每个知识点后再向下一个挑战迈进。 ... [详细]

蜡笔小新 2024-12-13 18:53:02
overflow
局域网IP地址映射至公网的方法

本文介绍了如何在TP-LINK路由器上配置端口映射，将局域网内的设备通过特定端口暴露于互联网，包括设置虚拟服务器和调整Tomcat服务端口的具体步骤。 ... [详细]

蜡笔小新 2024-12-13 12:23:35
js
构建首个Spring MVC应用程序

本指南将指导您如何从零开始创建一个简单的Spring MVC应用，涵盖项目模块创建、依赖管理、核心配置及控制器开发等关键步骤。 ... [详细]

蜡笔小新 2024-12-13 12:15:41
js
Java Web资源重定向与请求转发详解

本文介绍了Java Web应用中的资源重定向和请求转发机制，包括默认欢迎资源文件的设置方法，以及多个Servlet之间的调用规则和数据共享方案。 ... [详细]

蜡笔小新 2024-12-13 10:32:06
jquery
C# 对象转 JSON 字符串的方法与应用

本文介绍如何在 C# 中使用一般处理程序（ASHX）将对象转换为 JSON 字符串，并通过设置响应类型为 application/json 来确保客户端能够正确解析返回的数据。同时，文章还提供了 HTML 页面中不依赖 jQuery 的 AJAX 方法来接收和处理这些 JSON 数据的具体实现。 ... [详细]

蜡笔小新 2024-12-12 11:43:02
cookies
深入探讨PHP中的输出缓冲技术（Output Buffering）

本文深入解析了PHP中输出缓冲（Output Buffering）的原理及其在Web开发中的应用，特别是如何通过输出缓冲技术有效管理HTTP头部信息，提高代码的灵活性与健壮性。 ... [详细]

蜡笔小新 2024-12-12 10:37:27
cookies
Struts2(六) 用Struts完成客户列表显示

Struts完成客户列表显示所用的基础知识在之前的随笔中已经讲过。这篇是介绍如何使用Struts完成客户列表显示。下面是完成的代码执行逻辑图：抽取项目部分代码相信大家 ... [详细]

蜡笔小新 2024-12-11 14:50:44
build
解决SpringBoot与MyBatis集成时出现的BuilderException错误

在尝试将SpringBoot与MyBatis框架进行集成时，遇到了一个常见的问题：org.apache.ibatis.builder.BuilderException。此错误通常指示XML配置文件中存在语法或结构上的问题。本文将探讨具体原因及解决方案。 ... [详细]

蜡笔小新 2024-12-11 11:27:11
build
SparkSQL 中 DataFrame 的构建方法

本文详细探讨了如何在 SparkSQL 中创建 DataFrame，涵盖了从基本概念到具体实践的各种方法。作为持续学习的一部分，本文将持续更新以提供最新信息。 ... [详细]

蜡笔小新 2024-12-10 18:55:21
build
构建Struts 2 Web应用程序指南

本文提供了一个详细的步骤指南，帮助开发者从零开始创建一个简单的Struts 2 Web应用程序，涵盖了从环境搭建到项目部署的全过程。 ... [详细]

蜡笔小新 2024-12-10 11:51:06

云中之锦书

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章