RestTemplate浅谈

前几天刚写了一篇，但是本人操作不当，给删除了，这不又重新抽时间写了一遍。难啊！！😒~~~~

RestTemplate是Spring提供的用于访问Rest服务的客户端的小玩意，主要是做跨服务调用，项目用到过很多次，RestTemplate提供了多种便捷访问远程Http服务的方法,能够大大提高客户端的编写效率。

最近做的项目中，下载附件要用到别人项目的接口来下载文件，就研究了一下这个rest服务，每次都要去查，所以就自己总结了一篇，分享给大家，有自己总结也有自己查资料的都附带上，整理在一起。

本文将记录了实现Spring生态内RestTemplate的Get请求和Post请求还有exchange指定请求类型的实践，看完基本就用了，跨服务调用的方式还真的很不错。

1.简述RestTemplate

是Spring用于同步client端的核心类，简化了与http服务的通信，并满足RestFul原则，程序代码可以给它提供URL，并提
取结果。默认情况下，RestTemplate默认依赖jdk的HTTP连接工具。当然你也可以 通过setRequestFactory属性切换到
不同的HTTP源，比如Apache HttpComponents、Netty和OkHttp。

RestTemplate能大幅简化了提交表单数据的难度，并且附带了自动转换JSON数据的功能，但只有理解了HttpEntity的组成结构（header与body），且理解了与uriVariables之间的差异，才能真正掌握其用法。这一点在Post请求更加突出，下面会介绍到。

该类的入口主要是根据HTTP的六个方法制定：

HTTP method	RestTemplate methods
DELETE	delete
GET	getFoeObject
GET	getFoeObject
GET	getFoeObject
HEAD	headForHeaders
OPTIONS	optionsForAllow
PSOT	postForLocation
POST	postForObject
PUT	put
any	exchange
any	execute

此外，exchange和excute可以通用上述方法。

在内部，RestTemplate默认使用HttpMessageConverter实例将HTTP消息转换成POJO或者从POJO转换成HTTP消息。默认情况下会注册主mime类型的转换器，但也可以通过setMessageConverters注册其他的转换器。

其实这点在使用的时候是察觉不到的，很多方法有一个responseType 参数，它让你传入一个响应体所映射成的对象，然后底层用HttpMessageConverter将其做映射

HttpMessageConverterExtractor<T> responseExtractor =
                new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);

HttpMessageConverter.java源码：

public interface HttpMessageConverter<T> {
        //指示此转换器是否可以读取给定的类。
    boolean canRead(Class<?> clazz, @Nullable MediaType mediaType);
 
        //指示此转换器是否可以写给定的类。
    boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType);
 
        //返回List<MediaType>
    List<MediaType> getSupportedMediaTypes();
 
        //读取一个inputMessage
    T read(Class<? extends T> clazz, HttpInputMessage inputMessage)
            throws IOException, HttpMessageNotReadableException;
 
        //往output message写一个Object
    void write(T t, @Nullable MediaType contentType, HttpOutputMessage outputMessage)
            throws IOException, HttpMessageNotWritableException;
 
}

在内部，RestTemplate默认使用SimpleClientHttpRequestFactory和DefaultResponseErrorHandler来分别处理HTTP的创建和错误，但也可以通过setRequestFactory和setErrorHandler来覆盖。

2.get请求实践

2.1 getForObject()方法

这个方法有三个重载的用法：

public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables){}
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)
public <T> T getForObject(URI url, Class<T> responseType)

方法的第一参数表示要调用的服务的地址
方法的第二个参数表示返回的消息体的数据类型
方法的第三个参数表示上传的参数

示例：
两个参数

JSONObject fileMap = restTemplate.getForObject("www.baidu.com", JSONObject.class);

三个参数

MultiValueMap map = (MultiValueMap) Maps.newHashMap();
map.put("name","百度");
JSONObject fileMap = restTemplate.getForObject("www.baidu.com", JSONObject.class,map);

根据自己需要的选择来定义选择哪几个参数的方法，
getForObject()其实比getForEntity()多包含了将HTTP转成POJO的功能，但是getForObject没有处理response的能力。因为它拿到手的就是成型的pojo。省略了很多response的信息。基本用法是一致的，我就不过多解释了，本人用到最多的就是getForObjec()方法，其他的后续用到再补充

3. post请求实践

同样的,post请求也有postForObject和postForEntity,POST请求可以通过如下三个方法来发起。

3.1 postForObject

public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Object... uriVariables)
            throws RestClientException {}
public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
            throws RestClientException {}
public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException {}

跟get方法用法不同的是参数顺序和请求方式不一样：

方法的第一参数表示要调用的服务的地址
方法的第二个参数表示上传的参数
方法的第三个参数表示返回的消息体的数据类型

两个参数

JSONObject fileMap = restTemplate.postForObject("www.baidu.com", JSONObject.class);

三个参数

MultiValueMap map = (MultiValueMap) Maps.newHashMap();
map.put("name","百度");
JSONObject fileMap = restTemplate.postForObject("www.baidu.com",map, JSONObject.class);

解释一下，为什么rest一定要用MultiValueMap这个作为传参，为什么不能用Map，网上是这样说的，反正我试过是不能用Map：
代码中，MultiValueMap是Map的一个子类，它的一个key可以存储多个value，简单的看下这个接口：

public interface MultiValueMap<K, V> extends Map<K, List<V>> {...}

为什么用MultiValueMap?因为HttpEntity接受的request类型是它。

public HttpEntity(@Nullable T body, @Nullable MultiValueMap<String, String> headers){}
//我这里只展示它的一个construct,从它可以看到我们传入的map是请求体，headers是请求头。
　　

为什么用HttpEntity是因为restTemplate.postForEntity方法虽然表面上接收的request是@Nullable Object request类型，但是你追踪下去会发现，这个request是用HttpEntity来解析。核心代码如下：

if (requestBody instanceof HttpEntity) {
    this.requestEntity = (HttpEntity<?>) requestBody;
}else if (requestBody != null) {
    this.requestEntity = new HttpEntity<>(requestBody);
}else {
    this.requestEntity = HttpEntity.EMPTY;
}

我曾尝试用map来传递参数，编译不会报错，但是执行不了，是无效的url request请求(400 ERROR)。其实这样的请求方式已经满足post请求了，cookie也是属于header的一部分。可以按需求设置请求头和请求体。其它方法与之类似。

3.2 postForEntity

用法和postForObject基本一致，但是区别就是，如果你只关注，返回的消息体，可以直接使用postForObject。如果关注消息体那么就用postForEntity。具体我只用到过postForObject方法，后续用到postForEntity再补充使用详情。

3.3 postForLocation

postForLocation也是提交新资源，提交成功之后，返回新资源的URI，postForLocation的参数和前面两种的参数基本一致，只不过该方法的返回值为Uri，这个只需要服务提供者返回一个Uri即可，该Uri表示新资源的位置。

4. put请求实践

在RestTemplate中，PUT请求可以通过put方法调用，put方法的参数和前面介绍的postForEntity方法的参数基本一致，只是put方法没有返回值而已。举一个简单的例子，如下：

    Student stu = new Student();
    stu.setName("张三");
    //stu对象是我要提交的参数，最后的1用来替换前面的占位符{1}
    restTemplate.put("http://stuService/getStudent/{1}", stu, 1);

5.使用exchange指定调用方式

exchange()方法跟上面的getForObject()、getForEntity()、postForObject()、postForEntity()等方法不同之处在于它可以指定请求的HTTP类型。

JSONObject fileMap = restTemplate.exchange("www.baidu.com",HttpMethod.GET,map,JSONObject.class);

当然，HttpMethod方法还有很多，用法类似。

6.excute()指定调用方式

excute()的用法与exchange()大同小异了，它同样可以指定不同的HttpMethod，不同的是它返回的对象是响应体所映射成的对象，而不是ResponseEntity。

需要强调的是，execute()方法是以上所有方法的底层调用。随便看一个：

@Override
    @Nullable
    public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables)
            throws RestClientException {
 
        RequestCallback requestCallback = httpEntityCallback(request, responseType);
        HttpMessageConverterExtractor<T> responseExtractor =
                new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
        return execute(url, HttpMethod.POST, requestCallback, responseExtractor, uriVariables);
    }

7.总结

以上就是我们对RestTemplate能够发送的请求的一个详细介绍，主要用法都是本人查资料的得出来的，主要是项目用到了这个小玩意，自己就做了一下笔记，方便以后查找，给自己长个记性，把自己认为有用的东西全部摘抄下来分享给大家，大佬勿喷，小白正在成长，写的不好，也没有什么新意，主要是交流和分享，欢迎大家评论区交流，谢谢观看。😊

参考链接：https://www.cnblogs.com/javazhiyin/p/9851775.html