Spring中RestTemplate的使用方法

一、REST
在互联网中，我们会通过请求url来对网络上的资源做增删改查等动作，这里的请求包含两部分：
动词，主要包括增、删、改、查
名词，就是网络中的各种资源
传统的非REST风格的请求方式是把动词和名词全都放在url中。
例如，对设备的操作可能是这样的：
添加设备：http://test/device/add
删除设备：http://test/device/delete
修改设备：http://test/device/modify
查找设备：http://test/device/find
这样就存在一个规范的问题，例如，添加设备这个动作的单词应该是用add还是create？http方法是用GET还是用POST？等等
REST风格的请求方式是用http请求方法表示增删改查动作，而url中只保留名词，也就是对资源位置的描述，这样就避免了动作描述规范的问题。
还是以对设备的操作举例，REST风格的请求是这样的：
添加设备：http://test/device 请求方法是POST
删除设备：http://test/device 请求方法是DELETE
修改设备：http://test/device 请求方法是PUT
查找设备：http://test/device/:id 请求方法是GET

二、Spring中对REST请求的处理
Spring中可以使用RestTemplate来操作REST资源，主要包含以下几个方法：
getForEntity()，getForObject()，发送HTTP GET请求，getForEntity()返回的是ResponseEntity对象，里面包含响应实体对象及响应状态码，而getForObject()则直接返回响应实体对象
postForEntity()，postForObject()，发送HTTP POST请求，postForEntity()返回的是ResponseEntity对象，里面包含响应实体对象及响应状态码，而postForObject()则直接返回响应实体对象
put()，发送HTTP PUT请求
delete()，发送HTTP DELETE请求
exchange()，可以发送GET、POST、PUT和DELETE中的任意一种请求，同时还可以自定义请求头

下面举例说明几种方法的用法
首先创建一个实体类Device，后面的方法会用到这个实体类

public class Device {
  private String ip;
  private String mac;
}

创建一个用于测试的Controller类

@RestController
@RequestMapping(value = "/consumer")
public class ConsumerController {

  private RestTemplate restTemplate = new RestTemplate();

  private String urlPrefix = "http://localhost:8080/test/producer";

  // ...
}

1. GET请求
GET请求有两组重载方法：
1.1 getForEntity()
这个方法有多个重载方法
方法一：
getForEntity(String url, Class<T> responseType, Object... uriVariables)
其中，url就是请求的url，responseType是返回的实体类类型，uriVariables是uri或请求参数

代码示例如下：

  @RequestMapping(value = "/get1")
  public String testGetForEntity1() {
    String url = urlPrefix + "/get";
    ResponseEntity<Device> response = restTemplate.getForEntity(url, Device.class);
    System.out.println("Device: " + response.getBody() + ", code: " + response.getStatusCodeValue());
    return response.getBody().toString();
  }

返回的response中既包含返回的实体对象(通过response.getBody()获取)，又包含返回状态码(通过response.getStatusCodeValue()获取)
这里的url中没有任何参数，所以uriVariables为空。如果url中需要传一些参数，可以通过以下方式传递：

  @RequestMapping(value = "/get2")
  public String testGetForEntity3() {
    String url = urlPrefix + "/get?protocol={protocol}&operator={operator}";
    ResponseEntity<Device> response = restTemplate.getForEntity(url, Device.class, "NBIot", "ChinaMobile");
    System.out.println("Device: " + response.getBody() + ", code: " + response.getStatusCodeValue());
    return response.getBody().toString();
  }

这里传了两个参数protocol和operator

方法二：

getForEntity(String url, Class<T> responseType, Map<String,?> uriVariables)

这种方法是将uriVariables用Map方式传入，如果参数比较多的话，这种方式方便方法之间的参数传递
代码示例如下：

  @RequestMapping(value = "/get3")
  public String testGetForEntity2() {
    Map<String, String> classifyMap = new HashMap<>();
    classifyMap.put("protocol", "NBIot");
    classifyMap.put("operator", "ChinaMobile");
    String url = urlPrefix + "/get?protocol={protocol}&operator={operator}";
    ResponseEntity<Device> response = restTemplate.getForEntity(url, Device.class, classifyMap);
    System.out.println("Device: " + response.getBody() + ", code: " + response.getStatusCodeValue());
    return response.getBody().toString();
  }

方法三：

getForEntity(URI url, Class<T> responseType)

这种方法是把String类型的url替换成java.net.URI类型的url

2.2 getForObject()
这个方法和getForEntity()的3个重载方法请求参数是完全一样的，不同的是getForObject()直接返回的是实体对象，而没有返回状态码。如果不关注状态码，只关注返回内容，可以使用这个方法。
方法一：

getForObject(String url, Class<T> responseType, Object... uriVariables)

代码示例如下：
不包含请求参数的方法：

  @RequestMapping(value = "/get4")
  public String testGetForObject1() {
    String url = urlPrefix + "/get";
    Device device = restTemplate.getForObject(url, Device.class);
    System.out.println("Device: " + device);
    return device.toString();
  }

包含请求参数的方法：

  @RequestMapping(value = "/get5")
  public String testGetForObject2() {
    String url = urlPrefix + "/get?protocol={protocol}&operator={operator}";
    Device device = restTemplate.getForObject(url, Device.class, "NBIot", "ChinaMobile");
    System.out.println("Device: " + device);
    return device.toString();
  }

方法二：

getForObject(String url, Class<T> responseType, Map<String,?> uriVariables)

代码示例如下：

  @RequestMapping(value = "/get6")
  public String testGetForObject3() {
    Map<String, String> classifyMap = new HashMap<>();
    classifyMap.put("protocol", "NBIot");
    classifyMap.put("operator", "ChinaMobile");
    String url = urlPrefix + "/get?protocol={protocol}&operator={operator}";
    Device device = restTemplate.getForObject(url, Device.class, classifyMap);
    System.out.println("Device: " + device);
    return device.toString();
  }

方法三：

getForObject(URI url, Class<T> responseType)

　　

原文地址：https://www.cnblogs.com/lasdaybg/p/10180201.html

时间： 2024-10-08 10:49:35

Spring中RestTemplate的使用方法的相关文章

Spring中配置log4j的方法

Spring中使用log4j的方便之处 1. 动态的改变记录级别和策略,即修改log4j.properties,不需要重启Web应用,这需要在web.xml中设置一下.2. 把log文件定在 /WEB-INF/logs/ 而不需要写绝对路径.3. 可以把log4j.properties和其他properties一起放在/WEB-INF/ ,而不是Class-Path. web.xml中的设定 在web.xml中的详细设定如下: <context-param> <param-name>

Spring中@Async注解实现“方法”的异步调用

简单介绍: Spring为任务调度与异步方法执行提供了注解支持.通过在方法上设置@Async注解,可使得方法被异步调用.也就是说调用者会在调用时立即返回,而被调用方法的实际执行是交给Spring的TaskExecutor来完成. 开启@Async注解: <task:annotation-driven executor="annotationExecutor" /> <!-- 支持 @Async 注解 --> <task:executor id="

SSM-Spring-12：Spring中NameMatchMethodPointcutAdvisor名称匹配方法切入点顾问

------------吾亦无他,唯手熟尔,谦卑若愚,好学若饥------------- advice 是通知advisor 是顾问 顾问(Advisor) 通知Advice是Spring提供的一种切面(Aspect).但其功能过于简单,只能将切面织入到目标类的所有目标方法中,无法完成将切面织入到指定目标方法中. 顾问Advisor是Spring提供的另一种切面.其可以完成更为复杂的切面织入功能,能选择性的将增强切面中的部分方法. PointcutAdvisor是顾问的一种,可以指定具体的切入点

Spring 中使用redis缓存方法记录

背景 在平时项目中,可能会有某个条件的查询,会多次进到db里面去查,这样就会重复的查询相同的数据,但是我们的数据又不是需要更改及显示的,这时候就可以用到 方法的缓存了.例如在我们调用微信小程序时,需要获取access_token,并且其有效时间为7200秒,过期后再次获取,我们就可以把获取access_token的方法作为 缓存.以下为我实现的过程记录. 1.重写 RedisSerializer 中的 serialize 和 deserialize 1 public class GenericF

Spring中获取Session的方法汇总

Spring: web.xml <listener> <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class> </listener> 在普通bean中使用: @Autowired private HttpSession session; @Autowired private HttpServletRequest reques

spring 中StoredProcedure的使用方法

StoredProcedure是一个抽象类,必须写一个子类来继承它,这个类是用来简化JDBCTemplate运行存储过程操作的. 首先我们写一个实现类: package com.huaye.framework.dao; import java.sql.Types; import java.util.HashMap; import java.util.Map; import org.springframework.jdbc.core.RowMapper; import org.springfram

在&quot;Spring&quot;中配编码格式的方法.

在Web.xml中加入如下的代码即可. <filter>          <filter-name>encoding</filter-name>          <filter-class>              org.springframework.web.filter.CharacterEncodingFilter          </filter-class>          <init-param>       

【Spring】详解Spring中Bean的加载

之前写过bean的解析,这篇来讲讲bean的加载,加载要比bean的解析复杂些,该文之前在小编原文中有发表过,要看原文的可以直接点击原文查看,从之前的例子开始,Spring中加载一个bean的方式: TestBean bean = factory.getBean("testBean"); 来看看getBean(String name)方法源码, @Override public Object getBean(String name) throws BeansException { re

使用反射创建Bean、Spring中是如何根据类名配置创建Bean实例、Java提供了Class类获取类别的字段和方法，包括构造方法

Java提供了Class类,可以通过编程方式获取类别的字段和方法,包括构造方法 获取Class类实例的方法: 类名.class 实例名.getClass() Class.forName(className) public class RefTest { @Test public void testRef(){ //Class cls = RefTest.class; //Class.forName("com.jboa.service.RefTest"); //new RefTest()