org.springframework.web.client.RestTemplate详解

RestTemplate详解

• GET请求

第一种方式：getForEntity函数，返回对象是ResponseEntity，ResponseEntity是对响应体的封装，包含响应状态码HttpStatus，响应头及相应体。响应体可以是自定义对象，例如如果是User对象，则可以写成这样ResponseEntity。getForEntity重载的函数有3个，使用及说明分别如下：

1. getForEntity(URI url, Class responseType)，第一个参数是请求的URI，第二个参数是响应体的类型

UriComponents uriComponents = UriComponentsBuilder
		.fromUriString("http://localhost:8080/user/getByName?name={name}")
         .build()
         .expand("zhangsan")	// 设置参数值
         .encode();
URI uri = uriComponents.toUri();
RestTemplate restTemplate = new RestTemplate();
ResponseEntity<User> responseEntity = restTemplate.getForEntity(uri, User.class);
User user = responseEntity.getBody();	// 获取body体

2. getForEntity(String url, Class responseType, Map<String, ?> uriVariables)，第一个参数是请求的地址，第二个参数是响应体的返回类型，第三个参数提供url中的参数绑定，进行参数绑定时需要在占位符中指定Map中的key。例如请求的url为htttp://localhost:8080/user/getByName?name={name},则需要在Map中put一个key为name的值

String url = "http://localhost:8080/user/getByName?name={name}";
Map<String, String> params = new HashMap();
params.put("name", "zhangsan");
RestTemplate restTemplate = new RestTemplate();
ResponseEntity<User> responseEntity = restTemplate.getForEntity(url, User.class, params);
User user = responseEntity.getBody();

3. getForEntity(String url, Class responseType, Object… uriVariables)，第一个参数是请求的url，第二个参数是响应体的返回类型，第三个参数提供url中的参数绑定，绑定根据占位符的数字获取uriVariables数组中相应位置的值。例如请求的url为htttp://localhost:8080/user/getByCond?name={1}&age={2},则name的值为uriVariables数组中第一个值，age为uriVariables数组中第二个值。

String url = "http://localhost:8080/user/getByCond?name={1}&age={2}";
RestTemplate restTemplate = new RestTemplate();
ResponseEntity<User> responseEntity = restTemplate.getForEntity(url, User.class, "zhangsan", 12);
User user = responseEntity.getBody();

第二种方式：getForObject，返回对象是响应体的内容，如果不关心响应码、响应头信息可以使用此方法。同样提供了3个重载的方法。

1. getForObject(URI url, Class responseType)，参数同getForEntity(URI url, Class responseType)
2. getForObject(String url, Class responseType, Map<String, ?> uriVariables)，参数同getForEntity(String url, Class responseType, Map<String, ?> uriVariables)
3. getForObject(String url, Class responseType, Object… uriVariables)，参数同getForEntity(String url, Class responseType, Object… uriVariables)

• POST请求

第一种方式：postForEntity返回对象是ResponseEntity是对请求响应的封装，包含响应码HttpStatus、响应头及响应体信息，提供了3个重载的方法，与get请求对应的方法不同的地方是多了一个入参，用来传递请求头、请求体参数

1. postForEntity(URI url, @Nullable Object request, Class responseType)第一个参数是请求的URI资源，URI的构造具体可参考jdk的API，第二个参数可以是一个普通对象，也可以是一个HttpEntity对象，如果是一个普通对象RestTemplate会将请求对象装换为一个HttpEntity对象来处理，其中Object是request的类型，request内容会被视作完整的body来处理，而如果request是一个HttpEntity对象，则会被当作一个完整的HTTP请求对象来处理，这个request中不仅包含了body的内容还包含了header中的内容，第三个参数是响应体的返回类型。
2. postForEntity(String url, @Nullable Object request, Class responseType, Map<String, ?> uriVariables)第一个参数是请求的url，第二个参数封装请求体请求头信息，第三个参数是响应体的返回类型，第四个参数提供url中的参数绑定，url中的占位符即为Map中的key。
3. postForEntity(String url, @Nullable Object request, Class responseType, Object… uriVariables)第一个参数为请求的url，第二个参数封装请求体请求头信息，第三个参数为响应体的类型，第四个参数是一个不定参数，用于url中参数绑定，占位符的值即为数组的顺序位置的值。

第二种方式：postForObject返回值为响应体的类型，提供了3个重载的方法，参数的作用同postForEntity。

1. postForObject(URI url, @Nullable Object request, Class responseType)
2. postForObject(String url, @Nullable Object request, Class respon seType,Map<String, ?> uriVariables)
3. postForObject(String url, @Nullable Object request, Class responseType,
   Object… uriVariables)

第三种方式：postForLocation此种方式较少使用，该方式实现了以post请求提交资源，并返回新资源的URI，由于确定了方法的返回类型，此次较postForEntity和postForObject少一个参数，同样提供了3个重载的方法,参数作用同postForEntity。

1. postForLocation(URI url, @Nullable Object request)
2. postForLocation(String url, @Nullable Object request, Map<String, ?> uriVariables)
3. postForLocation(String url, @Nullable Object request, Object… uriVariables)

• PUT请求

put请求无返回值，提供了3个重载的方法。

1. put(URI url, @Nullable Object request)第一个参数是请求的URI资源，第二个参数同样是请求体请求头的封装，可以是一般对象，也可以是HttpEntity对象
2. put(String url, @Nullable Object request, Map<String, ?> uriVariables)第一个参数是请求的url，第二个参数是请求体请求头的封装，第三个参数提供url参数的绑定，url中占位符即为Map中的key
3. put(String url, @Nullable Object request, Object… uriVariables)第一个参数请求的url，第二个参数封装请求体请求头信息，第三个不定参数用于url参数绑定

• DELETE请求

delete请求无返回值，提供了3个重载的方法。

• delete(URI url)参数URI为请求的URI资源
• delete(String url, Map<String, ?> uriVariables)第一个参数是请求的url，第二个参数用于url参数的绑定
• delete(String url, Object… uriVariables)第一个参数是请求的url，第二个参数用于url参数的绑定