Spring - RestTemplate 详解

RestTemplate简介

RestTemplate是Spring用于同步client端的核心模板类，在客户端上可以使用该类调用Web服务器端的服务。RestTemplate支持REST风格的URL，提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率，可以用GET方法来获取资源，或者用POST方法来创建资源。

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

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

HTTP method	RestTemplate methods
DELETE	delete
GET	getForObject
	getForEntity
HEAD	headForHeaders
OPTIONS	optionForAllow
POST	postForObject
	postForLocation
PUT	put
any	exchange
	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来覆盖。

GET请求实践

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

POST请求实践

1 postForObject方法详解

1.1 post - HttpEntity

postForObject本质上是将对象放入HttpEntity中，然后将对象POST给一个url，下面代码中所示的使用方法是最典型的一种：

ClientHttpRequestFactory requestFactory = getClientHttpRequestFactory();
RestTemplate restTemplate = new RestTemplate(requestFactory);
 
HttpEntity<Chen> request = new HttpEntity<>(new Chen("fan"));//将对象装入HttpEntity中
Chen chen = restTemplate.postForObject(fooResourceUrl, request, Chen.class);

1.2 post - JavaObject

实际上，如果不人为的将对象放入HttpEntity中，也可以直接使用RestTemplate去POST一个对象：

Chen chen = new Chen("fan");
Chen chen = restTemplate.postForObject(resourceUrl, chen, Chen.class);

可以这么做的原因是,在RestTemplate的代码中，专门有一部分进行了POST对象的类型检测和转换 ：

public HttpEntityRequestCallback(@Nullable Object requestBody, @Nullable Type responseType) {
	super(responseType);
	if (requestBody instanceof HttpEntity) {
   		this.requestEntity = (HttpEntity<?>) requestBody;
	}
	else if (requestBody != null) {
       		 this.requestEntity = new HttpEntity<Object>(requestBody);
	}
	else {
        	 this.requestEntity = HttpEntity.EMPTY;
	}
}

1.3 post - JSON

如果需要post的对象是以JSON形式存储，则需要手动将JSON字符串转化成HttpEntity，具体做法如下：

String jsonString = "{\"id\":1001,\"name\":\"test\"}";
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.valueOf("application/json;UTF-8"));
HttpEntity<String> httpEntity = new HttpEntity<String>(jsonString,headers);

RestTemplate restTemplate = new RestTemplate();
Chen chen = restTemplate.postForObject(url, httpEntity,Chen.class);
System.out.println(chen);

2 URI编码注意事项

无论是GET还是POST，RestTemplate的方法的第一个参数是String URI或java.net.URI类型，需要注意的是：

2.1 编码（encode）

URI涉及到编码问题，是因为有些字符会引起歧义。比如参数中的key=value键值对，当value里含有= & ? 等，就会造成 URL 服务器的解析错误。所以必须将引起歧义的符号进行转义，也就是对其进行编码。

如果使用String URI，那么其默认是不编码的，例如：

restTemplate.getForObject("http://example.com/hotel list", String.class);

RestTemplate会将URI转化成http://example.com/hotel%20list，而如果画蛇添足的向RestTemplate方法中传入一个encode的String URI：

restTemplate.getForObject("http://example.com/hotel%20list", String.class);

那么该URI将会被加密两次，成为http://example.com/hotel%2520list，而java.net.URI默认是编码的，RestTemplate默认是不编码的。

2.2 java.net.URI的使用

因为java.net.URI提供了多种常用的URI加工方法，如果要多次使用同一个url，最好将其转化成java.net.URI。

使用exchange指定调用方式

excute()指定调用方式