使用RestTemplate调用外部Http接口

最新推荐文章于 2025-10-31 15:08:04 发布

原创最新推荐文章于 2025-10-31 15:08:04 发布 · 1.4w 阅读

10 ·

CC 4.0 BY-SA版权

文章标签：

#个人随笔

本文详细介绍如何使用Spring的RestTemplate来调用外部HTTP接口，包括实体类与JSON字符串的转换、请求报文的构建及远程调用过程，同时解决常见错误并提供响应报文的获取方法。

使用RestTemplate调用外部Http接口

我们使用RestTemplate调用外部接口，restTemplate可以自动转换实体类和json字符串，这样便于我们调用接口。

通常我们得到一个外部接口，会告诉我们请求报文和响应报文。例如：

在这里插入图片描述
我们需要将其转化成对应的java类，如果不会转化，可以百度：json字符串在线转java类。
注意：java的类一定要与json字符串格式对应。如上，我们需要定义一个大类，其中包含两个类。并且这两个类的类名需要与message_header与message_content对应上，否则会提示报文格式不对。若自定义了类名，可以使用注解@JsonProperty。例如：

在这里插入图片描述
这样在转换时，就会自动将companyReqHeader转换为message_header，与json字符串对应上。
接下来，我们就需要给实体类创造对象并且赋值，对于类中类的赋值，我们需要先给里面的类赋值，再里面的类作为属性赋给外面的类。例如：
CompanyReqHeader companyReqHeader=new CompanyReqHeader();
companyReqHeader.setSyscode(“SAIC_TJ_0002”);
companyReqHeader.setAuthcode(“c4b051f692eb4d0bbf15d9d008a727c0”);
companyReqHeader.setBusinesstype(“005”);
companyReqHeader.setSign(“TJ”);
companyReqHeader.setVersion(“版本1”);
CompanyReqContent companyReqContent=new CompanyReqContent();
companyReqContent.setQrid(randomDto.getQrid());
companyReqContent.setRettype(“1”);
companyReqContent.setOpertime("");

	CompanyReq companyReq=new CompanyReq();
	companyReq.setCompanyReqHeader(companyReqHeader);
	companyReq.setCompanyReqContent(companyReqContent);

（CompanyReq类中包含了两个类，CompanyReqHeader和CompanyReqContent）

创建好请求报文后，我们就可以使用RestTemplate调用外部接口：

ResponseEntity responseEntity=restTemplate.postForEntity(“http://117.184.199.39:8089/authenticationService/httpserver.do”,companyReq,CompanyRsp.class);
其中CompanyRsp为返回的响应报文的实体类，restTemplate为RestTemplate的对象，postForEntity方法有三个参数，分别为：外部接口地址、请求体的对象、返回的实体类。
如果单单这样写，你发现会报错，这时需要加上：

restTemplate.getMessageConverters().add(new WxMappingJackson2HttpMessageConverter());（写在调用接口前面）
注：WxMappingJackson2HttpMessageConverter是我们自己创建的，继承了MappingJackson2HttpMessageConverter。如：
public class WxMappingJackson2HttpMessageConverter extends MappingJackson2HttpMessageConverter {
public WxMappingJackson2HttpMessageConverter() {
List mediaTypes = new ArrayList<>();
mediaTypes.add(MediaType.TEXT_PLAIN);
mediaTypes.add(MediaType.TEXT_HTML); //加入text/html类型的支持
setSupportedMediaTypes(mediaTypes);// tag6
}
}
这样就完成了接口的调用，可以得到我们需要的响应报文。如果想获得响应的实体类：responseEntity.getBody();后端就获取到了调用接口返回的响应报文。
接下来，我们需要在前端展示出来：
因为后端和前端代码不在一个包里，所以我们需要远程调用，在前端这个包里获取到调用接口的响应报文，可以在controller层中写这个调用，但是这个调用函数需要用到随机码作为参数，而我的随机码是通过注解@RequestBody直接从页面获取的，但是@RequestBody和@GetMapping冲突，因此我们需要将random参数通过地址的形式传递过来，然后在展示页面的controller获取到，将其赋给类，再使用远程调用，就可以获取到响应报文了，接着用addObject（）申明，就可以在前端${}使用变量值了，进行展示。