RestTemplate:exchange()vs postForEntity()vs execute()

时间:2018-09-17 09:04:13

标签: java spring-boot resttemplate

我正在使用Spring Boot开发Rest API,并且必须访问应用程序的端点。我使用了RestTemplate。我能够使用2种方法来做到这一点,

  • postForEntity()

    responseEntity = 
        restTemplate.postForEntity(uri, httpEntity, ResponseClass.class);
    
  • exchange()

    responseEntity = 
        restTemplate.exchange(uri, HttpMethod.POST, httpEntity, ResponseClass.class);
    

我想知道这两种方法的用法和区别。

我还看到了另一种方法execute()。请阐明一下。如何以及何时使用它。

4 个答案:

答案 0 :(得分:9)

RestTemplate是一个用途广泛的对象。

让我们从 execute 开始,因为它是最通用的方法:

execute(String url, HttpMethod method, @Nullable RequestCallback requestCallback,
        @Nullable ResponseExtractor<T> responseExtractor, Object... uriVariables)

请注意,uriVariables也可以作为Map传递。

execute旨在适用于各种可能的情况:

  • 第一个和第二个参数允许URL和方法的任何有效组合。
  • 可以通过在发送请求之前传递自定义RequestCallback(只有一种方法@FunctionalInterface的自定义doWithRequest(ClientHttpRequest request)(一个ResponseExtractor)来以多种不同的方式修改请求。
  • 可以通过传递自定义exchange来以任何必要的方式反序列化从远程资源返回的响应。

将此与 exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) 进行比较:

HttpEntity

这里有两个主要区别:

  • 您现在可以直接传递RequestCallback,而之前需要使用Class进行手动设置。
  • 通过传递所需的响应类型getForEntity,即可提供反序列化机制。

如您所见,这对于日常使用来说更加方便。

postForEntity getForEntity(String url, Class<T> responseType, Object... uriVariables) postForEntity(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables) 之类的方法更短,更易于理解:

postForEntity

通知Object现在使您无需包装即可直接发布任何execute。使用它们来代替execute并不会带来性能上的好处或损害,因为它们在后台自己称为1st approach- pyinstaller.exe test.py -这只是为了方便。

答案 1 :(得分:2)

RestTemplate是用于执行HTTP请求的同步客户端。除了支持不常见情况的通用exchange(...)execute(...)方法之外,它还为每种HTTP方法的常见场景提供了模板。

Spring Integration documentation总结了每种方法的用法:

  

postForEntity

     

通过POST创建新资源,并从响应中返回表示形式。

  

exchange

     

上述方法的通用性强,观点少的版本,在需要时提供了额外的灵活性。它接受RequestEntity,包括HTTP方法,URL,标头和正文作为输入,并返回ResponseEntity

     

这些方法允许使用ParameterizedTypeReference而不是Class来指定具有泛型的响应类型。

  

execute

     

执行请求的最通用方法,完全控制通过回调接口进行的请求准备和响应提取。


最后,postForEntity(...)exchange(...)execute(...)方法都将调用受保护的doExecute(...)方法,该方法将执行实际的HTTP请求。您可以查看source code了解详情

答案 2 :(得分:0)

如果您同时查看postForEntity和exchange方法的实现,您会发现两者都在后面使用了execute方法。使用exchange方法将使您有更多的自由来调用不同的http方法。

答案 3 :(得分:0)

执行(..) 最原始的方法形式,用于进行REST调用。

Exchange(..) Execute方法的包装。

PostForEntity(..) 包装器方法,可进一步简化REST调用的使用。 您可以在方法名称本身(getForEntity,postForEntity)中指定请求类型,因此, 无需在参数中提及请求类型。 方法名称本身变得很容易解释。

Exchange和postForEntity 中,响应必须为 Json格式。 JSON-mapper库将此Json进一步转换为Model类。 在 Execute 中,当我们在Response Executor参数中传递反序列化器时,我们接受任何格式的响应。