Spring RestTemplate 详解实践使用及拓展增强

RestTemplate 是什么？

RestTemplate 是Spring封装的一个Rest风格http请求框架，底层可以切换成HttpClient OkHttp 或者Netty实现，用户只需要关心RestTemplate怎么用而不需要关心底层框架如何操作，使用RestTemplate不需要关心如何手动转换返回的对象和到处都是的异常处理代码，可以让你的代码更简洁更优雅。

你可以在 spring-web 中找到它

主要类和接口

• RestOperations 定义Rest 操作的接口
• HttpAccessor 抽象http help 类
• InterceptingHttpAccessor HttpAccess 装饰类拓展了拦截器功能
• RestTemplate 具体实现类
• ClientHttpRequestInterceptor 拦截器接口 用于拦截http请求
• UriTemplateHandler uri模板处理器，后面拓展会用到

基础使用

put delete 等方法参考get post 的写法

Get获取对象或对象集合

获取 Employee 集合

RestTemplate restTemplate = new RestTemplate();
ResponseEntity> response = restTemplate.exchange("http://localhost:8080/employees/", HttpMethod.GET, null, new ParameterizedTypeReference>(){});
List employees = response.getBody();

返回对象list用exchange方法使用 ParameterizedTypeReference 指定返回类型 ，getForEntity 也可以使用 Object[].class 或 其他数组接收再转为List

获取单个对象

public class EmployeeList {
    private List employees;
 
    public EmployeeList() {
        employees = new ArrayList<>();
    }
 
    // getter/setter
}

EmployeeList response = restTemplate.getForObject("http://localhost:8080/employees",EmployeeList.class);
List employees = response.getEmployees();

Post 发送对象或集合

发送集合

List newEmployees = new ArrayList<>();
newEmployees.add(new Employee(3, "Intern"));
newEmployees.add(new Employee(4, "CEO"));
 
restTemplate.postForObject("http://localhost:8080/employees/", newEmployees, ResponseEntity.class);

发送对象

List newEmployees = new ArrayList<>();
newEmployees.add(new Employee(3, "Intern"));
newEmployees.add(new Employee(4, "CEO"));
 
restTemplate.postForObject("http://localhost:8080/employees", new EmployeeList(newEmployees), ResponseEntity.class);

上传文件

public void uploadFile(){
    HttpHeaders headers = new HttpHeaders();
    //设置Content-Type
    headers.setContentType(MediaType.MULTIPART_FORM_DATA);
    MultiValueMap body
      = new LinkedMultiValueMap<>();
    body.add("file", getTestFile());
    HttpEntity> requestEntity
     = new HttpEntity<>(body, headers);
     
    String serverUrl = "http://localhost:8082/spring-rest/fileserver/singlefileupload/";
     
    RestTemplate restTemplate = new RestTemplate();
    ResponseEntity response = restTemplate
      .postForEntity(serverUrl, requestEntity, String.class);
}

public FileSystemResource getTestFile(){
    return new FileSystemResource("./test.md")
}

FileSystemResource 是spring中的一个类 参考 https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/io/FileSystemResource.html

上传多个文件

在上传单个文件的基础上多加几个文件

MultiValueMap body = new LinkedMultiValueMap<>();
body.add("files", getTestFile());
body.add("files", getTestFile());
body.add("files", getTestFile());
     
HttpEntity> requestEntity
  = new HttpEntity<>(body, headers);
 
String serverUrl = "http://localhost:8082/spring-rest/fileserver/multiplefileupload/";
 
RestTemplate restTemplate = new RestTemplate();
ResponseEntity response = restTemplate
  .postForEntity(serverUrl, requestEntity, String.class);

Spring RestTemplate 拓展

• 解决restTemplate get* url参数必须写死的问题
• 解决get*方法不好添加header信息的问题

继承RestTemplate 拓展get方法

/**
* 继承RestTemplate 新加get* 方法 比原有的方法多了个 httpHeaders 参数
*/
public class CustomerRestTemplate extends RestTemplate {


    public  ResponseEntity getForEntity(String url, HttpHeaders httpHeaders, Class responseType, Object... uriVariables) throws RestClientException {
        HttpEntity