RestTemplate使用
1. 简单介绍
RestTemplate
是 Spring 框架
中的一个工具类,它能让发送 HTTP 消息和处理响应变得简单。RestTemplate
类提供了许多功能,非常适合编写简单的 HTTP 客户端:
- 支持所有标准 HTTP 方法(GET、POST 等)。
- 能够处理所有标准 MIME Type(JSON、XML、表单等)。
- 高级 API 允许我们使用 Java 代码进行配置,并避免复杂的序列化问题。
- 可使用
ClientHttpRequestInitializer
和ClientHttpRequestInterceptor
接口进行自定义。
从 Spring Framework 5 开始,除了 WebFlux,Spring 还引入了一个名为 WebClient
的新 HTTP 客户端。 WebClient
是一种替代 RestTemplate
的现代 HTTP 客户端。它不仅提供传统的同步 API,还支持高效的非阻塞和异步方法。
2. GET方法
getForEntity
相比较于getForObject
可以访问完整的 HTTP 响应。一般情况下我们使用getForObject
即可。
@GetMapping("/{id}")
@Operation(summary = "根据ID查询订单信息")
public ResponseResult getOrderById(@PathVariable Integer id){
return restTemplate.getForObject(PRE_SERVER + "/pay/" + id, ResponseResult.class, id);
}
第一个参数为要访问的URL,第二个参数为返回值的类型,第三个路径参数值
3. POST方法
@Operation(summary = "新增支付订单信息")
@PostMapping
public ResponseResult saveOrder(@RequestBody PayDTO payDTO){
return restTemplate.postForObject(PRE_SERVER+"/pay",payDTO,ResponseResult.class);
}
第二个参数是我们通过Http访问方法的参数,第三个是返回值类型
4.PUT方法
@PutMapping
@Operation(summary = "更新订单信息")
public ResponseResult updateOrderById(@RequestBody PayDTO payDTO){
restTemplate.put(PRE_SERVER + "/pay", payDTO);
return ResponseResult.success();
}
第二个参数是我们要更新的数据
5.DELETE方法
@DeleteMapping("/{id}")
@Operation(summary = "删除订单信息")
public ResponseResult deleteOrderById(@PathVariable Integer id){
restTemplate.delete(PRE_SERVER+"/pay/" +id);
return ResponseResult.success();
}
路径变量也可以作为方法的第二个参数。
6.完整代码
@RestController
@RequestMapping("/consumer/pay")
@Tag(name = "订单模块", description = "订单相关接口")
public class ConsumerController {
@Resource
private RestTemplate restTemplate;
private static final String PRE_SERVER = "http://localhost:8001";
@Operation(summary = "新增支付订单信息")
@PostMapping
public ResponseResult saveOrder(@RequestBody PayDTO payDTO){
return restTemplate.postForObject(PRE_SERVER+"/pay",payDTO,ResponseResult.class);
}
@GetMapping("/{id}")
@Operation(summary = "根据ID查询订单信息")
public ResponseResult getOrderById(@PathVariable Integer id){
return restTemplate.getForObject(PRE_SERVER + "/pay/" + id, ResponseResult.class, id);
}
@DeleteMapping("/{id}")
@Operation(summary = "删除订单信息")
public ResponseResult deleteOrderById(@PathVariable Integer id){
restTemplate.delete(PRE_SERVER+"/pay/" +id);
return ResponseResult.success();
}
@PutMapping
@Operation(summary = "更新订单信息")
public ResponseResult updateOrderById(@RequestBody PayDTO payDTO){
restTemplate.put(PRE_SERVER + "/pay", payDTO);
return ResponseResult.success();
}
}
需要增加配置类:
@Configuration
public class RestConfig {
@Bean
public RestTemplate restTemplate(){
return new RestTemplate();
}
}
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· AI技术革命,工作效率10个最佳AI工具