Spring RestTemplate使用总结和源代码分析

1、http的请求方式

（1）GET：通过请求URI得到资源
（2）POST：用于添加新的内容
（3）PUT：用于修改某个内容，若不存在则添加
（4）DELETE：删除某个内容
（5）OPTIONS ：询问可以执行哪些方法
（6）HEAD ：类似于GET, 但是不返回body信息，用于检查对象是否存在，以及得到对象的元数据
（7）CONNECT ：用于代理进行传输，如使用SSL
（8）TRACE：用于远程诊断服务器

2、Spring RestTemplate 的使用方式

   RestTemplate是Spring提供的用于访问Rest服务的客户端，RestTemplate提供了多种便捷访问远程Http服务的方法，能够大大提高客户端的编写效率。

   （1）restTemplate.getForEntity() 和 restTemplate.getForObject();  

           restTemplate实现了RestOperations接口的getForObject请求方法如下

 T getForObject(URI url, Class responseType) throws RestClientException;

 T getForObject(String url, Class responseType, Object... uriVariables) throws RestClientException;

 T getForObject(String url, Class responseType, Map uriVariables) throws RestClientException;

 使用上面三个接口方法，分别实现发送请求

            // 使用方法一，不带参数
            String url = "http://114.67.70.75:8090/test/test1?id=00975";
            String res = restTemplate.getForObject(url, String.class);
            System.out.println(res);

            // 使用方法二，传参替换
            url = "http://114.67.70.75:8090/test/test1?id={?}";
            res = restTemplate.getForObject(url, String.class, "00975");
            System.out.println(res);

            // 使用方法二，map传参
            url = "http://114.67.70.75:8090/test/test1?id={id}&name={name}";
            Map params = new HashMap<>();
            params.put("id", "00975");
            params.put("name","紫光");
            res = restTemplate.getForObject(url, String.class, params);
            System.out.println(res);

 

           restTemplate.getForEntity()的使用形式与restTemplate.getForObject相同, restTemplate.getForEntity()的响应结果多了

          http状态码和responseHeader；

          ResponseEntity res2 = restTemplate.getForEntity(url,String.class);

           

     (2)   restTemplate.postForObject() 和 restTemplate.postForEntity();

             restTemplate实现了RestOperations接口的postForObject请求方法如下

 T postForObject(URI url, @Nullable Object request, Class responseType) throws RestClientException;

 T postForObject(String url, @Nullable Object request, Class responseType,
			Object... uriVariables) throws RestClientException;

 T postForObject(String url, @Nullable Object request, Class responseType,
			Map uriVariables) throws RestClientException;

 使用上面三个接口方法，分别实现发送请求

MultiValueMap request = new LinkedMultiValueMap<>();
        request.add("name", name);
        request.add("age", age);

Map param = new HashMap();
        param.put("name",name);
        param.put("age",age);

//使用方法一
String result = restTemplate.postForObject(url, request, String.class);
System.out.println(result);

//使用方法二，表单参数和url相结合
request.clear();
request.add("name", name);
result = restTemplate.postForObject(url + "?age={?}", request, String.class, age);
System.out.println(result);


// 使用方法三，以集合形式传递参数
Map params = new HashMap<>();
params.put("weight", "65kg");
result= restTemplate.postForObject(url + "?weight={weight}", request, String.class, params);
System.out.println(result);

 同样postForEntity()方法比postForObject()方法增加了http状态和httpheaders返回

 

     (3)   restTemplate.exchange()

 ResponseEntity exchange(URI url, HttpMethod method, @Nullable HttpEntity requestEntity,
			Class responseType) throws RestClientException;

 ResponseEntity exchange(String url, HttpMethod method, @Nullable HttpEntity requestEntity,
			Class responseType, Object... uriVariables) throws RestClientException;


 ResponseEntity exchange(String url, HttpMethod method, @Nullable HttpEntity requestEntity,
			Class responseType, Map uriVariables) throws RestClientException;

  exchange 的使用方法和get 、post 的方法基本相同，只不过多了一个HttpMethod参数，来指定需要发送的请求类型

   （4）如何优雅的使用get方法发送参数

 

3、发送方法内参数的作用

       1、方法参数是什么意义

                 url:表示要调用的服务的地址

                 method:表示调用请求的方式

                 httpEntity:表示要传递的参数

                 responseType：表示返回消息体的数据类型

                 uriVarables:表示需要格式化到url的参数

                 注意：HttpEntity用于传递具体的参数值，而uriVariables则用于格式化Http地址。

         2、httpEntity参数设置

             

        //第一种，传入MultiValueMap
        HttpHeaders headers = new HttpHeaders();
        headers.set("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
        MultiValueMap params = new LinkedMultiValueMap();
        params.add("id","00975");
        params.add("name","tomcat");
        HttpEntity httpEntity = new HttpEntity(params, headers);

        ans = restTemplate.postForObject(url, httpEntity, String.class);

        日志如下：

      

     

        headers.set("Content-Type", "application/json;charset=utf-8");
        Map param = new HashMap();
        param.put("id","00975");
        param.put("name","tomcat");
        httpEntity = new HttpEntity(param, headers);
        ans = restTemplate.postForObject(url, httpEntity, String.class);

 日志如下：

 

HttpHeaders设置了Content-Type，httpEntity的传入参数需要与之对应，不然可能会出现错误。

在调用restTemplate的发送方法时，httpEntity也可以传入object, 下面的代码会将其转换为httpEntity对象

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<>(requestBody);
			}
			else {
				this.requestEntity = HttpEntity.EMPTY;
			}
		}

        3、httpEntity传入MultiValueMap和object类型的区别

else {
				Class requestBodyClass = requestBody.getClass();
				Type requestBodyType = (this.requestEntity instanceof RequestEntity ?
						((RequestEntity)this.requestEntity).getType() : requestBodyClass);
				HttpHeaders httpHeaders = httpRequest.getHeaders();
				HttpHeaders requestHeaders = this.requestEntity.getHeaders();
				MediaType requestContentType = requestHeaders.getContentType();
				for (HttpMessageConverter messageConverter : getMessageConverters()) {
					if (messageConverter instanceof GenericHttpMessageConverter) {
						GenericHttpMessageConverter