HTTP 请求工具类-RestTemplate

小咪咪 2023-07-17 14:16 45阅读 0赞

### RestTemplate ###

<table> 
 <tbody> 
  <tr> 
   <td><font><b>什么是RestTemplate?</b></font></td> 
  </tr> 
 </tbody> 
</table>

> 传统情况下在java代码里访问restful服务，一般使用Apache的HttpClient。不过此种方法使用起来太过繁琐。spring提供了一种简单便捷的模板类来进行操作，这就是RestTemplate。

<table> 
 <tbody> 
  <tr> 
   <td><font><b>一个简单的例子</b></font></td> 
  </tr> 
 </tbody> 
</table>

定义一个简单的restful接口

@RestController
    public class TestController
    { 
        @RequestMapping(value = "testPost", method = RequestMethod.POST)
        public ResponseBean testPost(@RequestBody RequestBean requestBean)
        { 
            ResponseBean responseBean = new ResponseBean();
            responseBean.setRetCode("0000");
            responseBean.setRetMsg("succ");
    
            return responseBean;
        }
    }

使用RestTemplate访问该服务

//请求地址
            String url = "http://localhost:8080/testPost";
            //入参
            RequestBean requestBean = new RequestBean();
            requestBean.setTest1("1");
            requestBean.setTest2("2");
            requestBean.setTest3("3");
    
            RestTemplate restTemplate = new RestTemplate();
            ResponseBean responseBean = restTemplate.postForObject(url, requestBean, ResponseBean.class);

> 从这个例子可以看出，使用restTemplate访问restful接口非常的简单粗暴无脑。(url, requestMap,  
> ResponseBean.class)这三个参数分别代表 请求地址、请求参数、HTTP响应转换被转换成的对象类型。

> RestTemplate方法的名称遵循命名约定，第一部分指出正在调用什么HTTP方法，第二部分指示返回的内容。本例中调用了restTemplate.postForObject方法，post指调用了HTTP的post方法，Object指将HTTP响应转换为您选择的对象类型。还有其他很多类似的方法，有兴趣的同学可以参考官方api。

<table> 
 <tbody> 
  <tr> 
   <td><font><b>手动指定转换器(HttpMessageConverter)</b></font></td> 
  </tr> 
 </tbody> 
</table>

> 我们知道，调用reseful接口传递的数据内容是json格式的字符串，返回的响应也是json格式的字符串。然而restTemplate.postForObject方法的请求参数RequestBean和返回参数ResponseBean却都是java类。是RestTemplate通过HttpMessageConverter自动帮我们做了转换的操作。

> 默认情况下RestTemplate自动帮我们注册了一组HttpMessageConverter用来处理一些不同的contentType的请求。  
> 你可以在org.springframework.http.converter包下找到所有spring帮我们实现好的转换器。  
> 如果现有的转换器不能满足你的需求，你还可以实现org.springframework.http.converter.HttpMessageConverter接口自己写一个。详情参考官方api。

选好了HttpMessageConverter后怎么把它注册到我们的RestTemplate中呢。

RestTemplate restTemplate = new RestTemplate();
            //获取RestTemplate默认配置好的所有转换器
            List<HttpMessageConverter<?>> messageConverters = restTemplate.getMessageConverters();
            //默认的MappingJackson2HttpMessageConverter在第7个 先把它移除掉
            messageConverters.remove(6);
            //添加上GSON的转换器
            messageConverters.add(6, new GsonHttpMessageConverter());

这个简单的例子展示了如何使用GsonHttpMessageConverter替换掉默认用来处理application/json的MappingJackson2HttpMessageConverter。

出处：https://www.jianshu.com/p/90ec27b3b518