Restful API实践（三）RestTemplate使用详解

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/ONROAD0612/article/details/82258193

1 概述

通过上一篇文章（Restful API实践（二）SpringBoot项目接口设计示例）我们对SpringBoot项目Restful API接口的定义进行了详细地总结，这里我们就需要来看一看如果使用RestTemplate来消费这些接口。

2 创建RestTemplate

在项目中我们通常在项目启动的时候就在Spring容器中创建一个RestTemplate的bean，在需要的时候我们直接注入就行了。

@Configuration
public class RestTemplateConfig {

    @Value("${restTemplate.connectionRequestTimeout}")
    private int connectionRequestTimeout; //连接请求超时时间

    @Value("${restTemplate.connectionTimeout}")
    private int connectionTimeout;        //连接超时时间

    @Value("${restTemplate.readTimeout}")
    private int readTimeout;              //读取超时时间

    @Bean
    @Primary
    public RestTemplate customRestTemplate(){
        HttpComponentsClientHttpRequestFactory httpRequestFactory = new HttpComponentsClientHttpRequestFactory();
        httpRequestFactory.setConnectionRequestTimeout(connectionRequestTimeout);
        httpRequestFactory.setConnectTimeout(connectionTimeout);
        httpRequestFactory.setReadTimeout(readTimeout);
        return new RestTemplate(httpRequestFactory);
    }

}

这里我们需要在配置文件中添加相应的配置参数：

restTemplate.connectionRequestTimeout = 300000
restTemplate.connectionTimeout = 300000
restTemplate.readTimeout = 300000

3 RestTemplate使用

3.1 RestTemplate之get请求

(1) public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables)

     throws RestClientException

参数意义：

• url：url地址
• responseType：响应实体类型。
• uriVariables：url地址参数，如果没有url参数的时候直接传空Map(new HashMap())。

示例：

    @Test
    public void testGetForObject_one(){
        String url = HOST +"/api-demo/user";
        Map<String,Object> paramMap = new HashMap<>();
        paramMap.put("name","rose");
        paramMap.put("age",22);
        User user = restTemplate.getForObject(url+"?name={name}&age={age}",User.class,paramMap);
        logger.debug("user:"+user);
    }

(2) public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables)
     throws RestClientException

参数意义：

• url：url地址
• responseType：响应实体类型。
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填。

示例：

    @Test
    public void testGetForObject_two(){
        String url = HOST +"/api-demo/user";
        Object[] arr = new Object[]{"rose", 22};

        //注意这种调用方式针对URL中没有参数的情况可以不传入最后的一个参数
        User user = restTemplate.getForObject(url+"?name={name}&age={age}",User.class,arr);
        logger.debug("user:"+user);
    }

(3) public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Map<String, ?> uriVariables)
     throws RestClientException

此方法与（1）方法的使用相同，不同的是这个方法的返回结果为ResponseEntity，可以从返回结果获取响应状态及响应体等信息。

处理响应体的代码如下：

    /**
     * 处理响应responseEntity
     * @param responseEntity
     */
    private void disposeResponseEntity(ResponseEntity<User> responseEntity) {
        //获取响应状态code
        int code = responseEntity.getStatusCodeValue();
        logger.debug("httpstatus code:"+code);

        //获取响应头相关信息
        if(code > 1000){
            String errorMessage = String.valueOf(responseEntity.getHeaders().get("Error-Message"));
            logger.debug("Error-Message:"+errorMessage);
        }

        //获取响应体
        User user = responseEntity.getBody();
        logger.debug("user:"+user);
    }

示例：

    @Test
    public void testGetFoEntity_one(){
        String url = HOST +"/api-demo/user";
        Map<String,Object> paramMap = new HashMap<>();
        paramMap.put("name","rose");
        paramMap.put("age",22);
        ResponseEntity<User> responseEntity = restTemplate.getForEntity(url+"?name={name}&age={age}",User.class,paramMap);
        disposeResponseEntity(responseEntity);
    }

(4) public <T> ResponseEntity<T> getForEntity(String url, Class<T> responseType, Object... uriVariables)
     throws RestClientException

此方法与（2）方法的使用相同，不同的是这个方法的返回结果为ResponseEntity，可以从返回结果获取响应状态及响应体等信息。

示例：

    @Test
    public void testGetFoEntity_two(){
        String url = HOST +"/api-demo/user";
        Object[] arr = new Object[]{"rose", -10};
        ResponseEntity<User> responseEntity = restTemplate.getForEntity(url+"?name={name}&age={age}",User.class,arr);
        disposeResponseEntity(responseEntity);
    }

(5) public <T> ResponseEntity<T> getForEntity(URI url, Class<T> responseType)
     throws RestClientException

参数意义：

• url：url为URI对象URI uri = new URI("http://localhost:8080/api/demo?name=zhangsan")，如果有url参数需要拼接在地址后面。
• responseType：响应实体类型。

示例：

    @Test
    public void testGetFoEntity_three(){
        String url = HOST +"/api-demo/user";
        url = url+"?name=rose&age=22";
        URI uri = null;
        try {
            uri = new URI(url);
        } catch (URISyntaxException e) {
            e.printStackTrace();
        }
        ResponseEntity<User> responseEntity = restTemplate.getForEntity(uri,User.class);

        disposeResponseEntity(responseEntity);
    }

3.2 RestTemplate之post请求

(1) public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType,
     Object... uriVariables) throws RestClientException

参数意义：

• url：url地址
• request：请求实体对象
• responseType：响应类型
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填，的使用和 public <T> T getForObject(String url,
• Class<T> responseType,Object... uriVariables)相同。

类似方法1：public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException
方法和(1)基本相同，使用也相同，不同的是此方法最后一个url参数的传值使用的是Map,因此如果没有url参数的时候直接传空Map(new HashMap())。

类似方法2：public <T> T postForObject(URI url, @Nullable Object request, Class<T> responseType) throws RestClientException
方法和(1)基本相同，使用也相同，不同的事此方法的url参数是一个URI对象，并且没有最后一个参数，因此如果url有参数的时候， 需要我们直接拼接在url后面。例如：URI uri = new URI("http://localhost:8080/api/demo?name=zhangsan")。

示例：

    @Test
    public void testPostForObject_one(){
        String url = HOST +"/api-demo/json/user?dept={dept}";
        Object[] arr = new Object[]{"finance"};
        int result = restTemplate.postForObject(url,new User("liutao",12,"liutao123"),int.class,arr);
        logger.debug("result:"+result);
    }

(2) public <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request,Class<T> responseType,
     Object... uriVariables) throws RestClientException

参数意义：

• url：url地址
• request：请求实体对象
• responseType：响应类型
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填，的使用和 public <T> T postForObject(String url, @Nullable Object request, Class<T> responseType,Object... uriVariables) throws RestClientException相同。同样，当url中没有参数的时候，最后一个参数uriVariables可以不填。

类似方法1：public <T> ResponseEntity<T> postForEntity(String url, @Nullable Object request,Class<T> responseType,
Map<String, ?> uriVariables) throws RestClientException
方法和(2)基本相同，使用也相同，不同的是此方法最后一个url参数的传值使用的是Map,因此如果没有url参数的时候直接传空Map(new HashMap())。

类似方法2：public <T> ResponseEntity<T> postForEntity(URI url, @Nullable Object request, Class<T> responseType)throws
                    RestClientException，
仅仅需要将第一个参数换作URI即可。例如第一个参数为：URI uri = new URI("http://localhost:8080/api/demo");

示例：

    @Test
    public void testPostForEntity(){
        String url = HOST +"/api-demo/json/user?dept={dept}";
        Object[] arr = new Object[]{"finance"};
        ResponseEntity<Integer> responseEntity = restTemplate.postForEntity(url,new User("liutao",12,
                        "liutao123"),
                Integer.class,arr);
        logger.debug("responseEntity:"+responseEntity);
    }

（3）演示数据传递以form表单的格式进行

    @Test
    public void testPostForm(){
        String url = HOST +"/api-demo/form/user";

        //设置请求数据的格式
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

        //封装参数
        MultiValueMap<String, String> params= new LinkedMultiValueMap<>();
        params.add("name", "liutao");
        params.add("age", "12");
        params.add("password", "liutao123");

        //封装请求内容
        HttpEntity<MultiValueMap<String, String>> requestEntity = new HttpEntity<>(params,headers);
        ResponseEntity<Integer> responseEntity = restTemplate.postForEntity(url,requestEntity,Integer.class);
        logger.debug("responseEntity:"+responseEntity);
    }

3.3 RestTemplate之put请求

(1) public void put(String url, @Nullable Object request, Object... uriVariables)
     throws RestClientException

参数意义：

• url：url地址
• request：请求实体对象
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填，的使用和 public <T> T getForObject(String url,
• Class<T> responseType,Object... uriVariables)相同。

RestTemplate 的其余两个put请求方法和前面的get和post的对应方法使用类似，我们可以查看源码和参考前面的get、post方法的相应方法进行学习使用。
注意：这里的put方法没有获取任何响应，那么如果我们要获取响应咋个办呢？那就只有直用exchange方法来实现put请求。

示例：

    @Test
    public void testPut(){
        String url = HOST +"/api-demo/user";
        User user = new User("liutao",12,"liutao123");
        restTemplate.put(url,user);
    }

3.4 RestTemplate之patch请求

(1) public <T> T patchForObject(String url, @Nullable Object request, Class<T> responseType,
     Object... uriVariables) throws RestClientException

参数意义：

• url：url地址
• request：请求实体对象
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填，的使用和 public <T> T getForObject(String url,Class<T> responseType,Object... uriVariables)相同。

     
类似方法1：public <T> T patchForObject(String url, @Nullable Object request, Class<T> responseType,
                    Map<String, ?> uriVariables) throws RestClientException
方法和“演示方法”基本相同，使用也相同，不同的是此方法最后一个url参数的传值使用的是Map,因此如果没有url参数的时候直接传空Map(new HashMap())。

类似方法2：public <T> T patchForObject(URI url, @Nullable Object request, Class<T> responseType)
                    throws RestClientException
这个方法和“演示方法”使用基本相同，不同的是url。例如第一个参数为：URI uri = new URI("http://localhost:8080/api/demo");

示例：

    @Test
    public void testPatch(){
        String url = HOST +"/api-demo/user/1212?name={name}";
        Object[] arr = new Object[]{"rose"};
        Integer result = restTemplate.patchForObject(url,null,Integer.class,arr);
        logger.debug("result:"+result);
    }

3.5 RestTemplate之DELETE请求

(1) public void delete(String url, Object... uriVariables)

参数意义：

• url：url地址
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填，uriVariables的传递和get、post的类似方法相同。

RestTemplate的其余两个delete请求方法和前面的get和post的对应方法使用类似，我们可以查看源码和前面的get、post方法的相应方法进行学习使用。

注意：这里的delete方法没有获取任何响应，那么如果我们要获取响应咋个办呢？那就只有直用exchange方法来实现delete请求。

示例：

    @Test
    public void testDelete(){
        String url = HOST +"/api-demo/user?name={name}&age={age}";
        Object[] arr = new Object[]{"rose", 10};
        restTemplate.delete(url,arr);
    }

3.5 RestTemplate之EXCHANGE请求

(1) public <T> ResponseEntity<T> exchange(String url, HttpMethod method, @Nullable HttpEntity<?> requestEntity, Class<T> responseType, Object... uriVariables) throws RestClientException

参数意义：

• url：url地址
• method：http请求方法，通过HttpMethod枚举类获取
• requestEntity：请求实体，可以包含请求头和请求体的信息
• responseType：响应类型
• uriVariables：url地址参数，如果url地址上没有参数的，这个参数可以不填

此方法可以从返回结果ResponseEntity中获取到响应状态码以及响应头和响应体等信息。
类似方法1：public <T> ResponseEntity<T> exchange(String url, HttpMethod method,@Nullable HttpEntity<?> requestEntity,                         Class<T> responseType, Map<String, ?> uriVariables)throws RestClientException
 方法和(1)基本相同，使用也相同，不同的是此方法最后一个url参数的传值使用的是Map,因此如果没有url参数的时候直接传空Map(new HashMap())。
类似方法2：public <T> ResponseEntity<T> exchange(URI url, HttpMethod method, @Nullable HttpEntity<?> requestEntity,
                    Class<T> responseType) throws RestClientException
方法和(1)基本相同，使用也相同，不同的事此方法的url参数是一个URI对象，并且没有最后一个参数，因此如果url有参数的时候，需要我们直接拼接在url后面。例如：URI uri = new URI("http://localhost:8080/api/demo?name=zhangsan")

示例：

    @Test
    public void testExchange_one(){

        //封装请求头
        MultiValueMap<String,String> headers = new LinkedMultiValueMap<String,String>();
        headers.add("Accept","application/json");
        headers.add("Content-Type","application/json");

        //封装请求内容
        User user = new User("dasf",12,"liutao123");
        HttpEntity<User> requestEntity = new HttpEntity(user,headers);

        String url = HOST +"/api-demo/user";
        ResponseEntity<Integer> responseEntity = restTemplate.exchange(url,
                HttpMethod.PUT,requestEntity,Integer.class);
        logger.debug("responseEntity:"+responseEntity);
    }

(2)演示将token放置再请求头中传递至后台进行验证,通过exchange方法提交get请求，并在参数中通过指定requestHeaders来设置请求头参数

示例：

    @Test
    public void howToSendToken(){
        String url = HOST +"/api-demo/finance/user?name={name}";
        Map<String,Object> paramMap = new HashMap<>();
        paramMap.put("name","rose");
        //设置请求头数据
        HttpHeaders requestHeaders = new HttpHeaders();
        requestHeaders.set("token",UUID.randomUUID().toString());
        HttpEntity<String> requestEntity = new HttpEntity<>(null, requestHeaders);
        ResponseEntity<User> responseEntity = restTemplate.exchange(url,
                HttpMethod.GET,requestEntity,User.class,paramMap);
        logger.debug(responseEntity.getBody().toString());
    }

源码地址：SpringBoot--Restful API设计示例，在源码工程里，我们可以在单元测试里面看见对应的使用示例。