RestTemplate用法说明

RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端库。它提供了一套接口，然后分别用三种 Java 最常用 Http 连接的库来分别实现这套接口：

JDK 自带的 HttpURLConnection
Apache 的 HttpClient
OKHttp3

1. 环境准备

如果在Springboot项目里使用，包含 start-web 即可

implementation 'org.springframework.boot:spring-boot-starter-web'

在普通Java项目里使用，需要包含 spring-web ：

compile group: 'org.springframework', name: 'spring-web', version: '5.0.8.RELEASE'

初始化有三种情况，随便选一种就可以：

RestTemplate restTemplate = new RestTemplate();
RestTemplate restTemplate = new RestTemplate(new HttpComponentsClientHttpRequestFactory());
RestTemplate restTemplate = new RestTemplate(new OkHttp3ClientHttpRequestFactory());

如果选了下面二种，则需要引入相应的 jar 包

compile group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.3'
compile('com.squareup.okhttp3:okhttp:3.11.0')

假设我们加载一个错误的网址：

restTemplate.getForObject("http://www.baiduxxx.com", String.class);

就会从错误信息里看出最终是由 HttpURLConnection、HttpClient 还是OkHttp来实现Http请求的：

image.png

2. 使用方法

早期的 HttpURLConnection 使用非常繁琐，得写很多代码实现一个简单的请求，而 HttpClient 简单很多，OkHttp 更为简洁。
RestTemplate 进一步简化，它可以像OkHttp那样的写法，但是常见的请求基本一句代码就可以搞定，以下是常见的 GET，POST,PUT,DELETE 的用法：

//1. 简单Get请求
String result = restTemplate.getForObject(rootUrl + "get1?para=my", String.class);
System.out.println("简单Get请求:" + result);

//2. 简单带路径变量参数Get请求
result = restTemplate.getForObject(rootUrl + "get2/{1}", String.class, 239);
System.out.println("简单带路径变量参数Get请求:" + result);

//3. 返回对象Get请求（注意需包含compile group: 'com.google.code.gson', name: 'gson', version: '2.8.5'）
ResponseEntity<Test1> responseEntity = restTemplate.getForEntity(rootUrl + "get3/339", Test1.class);
System.out.println("返回:" + responseEntity);
System.out.println("返回对象Get请求:" + responseEntity.getBody());

//4. 设置header的Get请求
HttpHeaders headers = new HttpHeaders();
headers.add("token", "123");
ResponseEntity<String> response = restTemplate.exchange(rootUrl + "get4", HttpMethod.GET, new HttpEntity<String>(headers), String.class);
System.out.println("设置header的Get请求:" + response.getBody());

//5. Post对象
Test1 test1 = new Test1();
test1.name = "buter";
test1.sex = 1;
result = restTemplate.postForObject(rootUrl + "post1", test1, String.class);
System.out.println("Post对象:" + result);

//6. 带header的Post数据请求
response = restTemplate.postForEntity(rootUrl + "post2", new HttpEntity<Test1>(test1, headers), String.class);
System.out.println("带header的Post数据请求:" + response.getBody());

//7. 带header的Put数据请求
//无返回值
restTemplate.put(rootUrl + "put1", new HttpEntity<Test1>(test1, headers));
//带返回值
response = restTemplate.exchange(rootUrl + "put1", HttpMethod.PUT, new HttpEntity<Test1>(test1, headers), String.class);
System.out.println("带header的Put数据请求:" + response.getBody());

//8. del请求
//无返回值
restTemplate.delete(rootUrl + "del1/{1}", 332);
//带返回值
response = restTemplate.exchange(rootUrl + "del1/332", HttpMethod.DELETE, null, String.class);
System.out.println("del数据请求:" + response.getBody());

还有对应的服务端代码就不列出来了，统一在git上。

3. 碰到的问题

3.1 服务端返回对象的时候的错误

 Could not extract response: no suitable HttpMessageConverter found for response type [class Test1] and content type [application/json;charset=UTF-8]

这个问题的解决是添加 Gson 的引用

compile group: 'com.google.code.gson', name: 'gson', version: '2.8.5'

原因是RestTemplate构造的时候会缺省加载很多消息转换器，如下图，缺省的json转换是 google 的 gson，所以需要引用它。不过在一个 springboot 项目里基本就不需要了，很多 spring 的库都依赖了 gson
假设我们不想用 gson，想用 fastjson ，也可以通过方式把 fastjson 添加到 messageConverters 里。

image.png

3.2 post 支持带 header 的简单写法，get 不支持，需要使用 exchange或 execute 方法，这二个方法需要非常全的参数

3.3 缺省的 put 和 delete 都不带返回值，需要返回值也需要用 exchange 替代

所有的源码都存在Git
后面还会介绍 Spring 的 Feign
，这个是基于 RestTemplate 的 RPC 。