RestUtils (myoss-starter-web 2.0.8.RELEASE API)

java.lang.Object
- app.myoss.cloud.web.utils.RestUtils

```
public class RestUtils
extends Object
```
Rest API工具类

Since:

2018年3月31日下午7:24:50

Author:

Jerry.Chen

Constructor Summary

Constructors
Constructor and Description

RestUtils()

Constructors
Constructor and Description
`RestUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> T`	`exchange(org.springframework.web.client.RestTemplate restTemplate, org.springframework.http.HttpHeaders httpHeaders, org.springframework.http.MediaType contentType, URI uri, org.springframework.http.HttpMethod method, Object requestBody, Class<T> responseType)` 自定义发送HTTP请求
`static <T> T`	`exchange(org.springframework.web.client.RestTemplate restTemplate, org.springframework.http.HttpHeaders httpHeaders, org.springframework.http.MediaType contentType, URI uri, org.springframework.http.HttpMethod method, Object requestBody, Class<T> responseType, RestRequestCallback restRequestCallback)` 自定义发送HTTP请求
`static <T> T`	`exchange(org.springframework.web.client.RestTemplate restTemplate, org.springframework.http.MediaType contentType, String url, org.springframework.http.HttpMethod method, Object requestBody, Class<T> responseType, Object... uriVariables)` 自定义发送HTTP请求
`static <T> T`	`exchange(org.springframework.web.client.RestTemplate restTemplate, org.springframework.http.MediaType contentType, URI uri, org.springframework.http.HttpMethod method, Object requestBody, Class<T> responseType)` 自定义发送HTTP请求
`static <T> T`	`getForObject(org.springframework.web.client.RestTemplate restTemplate, String url, org.springframework.util.LinkedMultiValueMap<String,String> parameterMap, Class<T> responseType, Object... uriVariables)` 以GET方法发送HTTP请求，并在请求的url中添加动态参数 `parameterMap`
`static <T> T`	`getForObject(org.springframework.web.client.RestTemplate restTemplate, String url, Map<String,String> parameterMap, Class<T> responseType, Object... uriVariables)` 以GET方法发送HTTP请求，并在请求的url中添加动态参数 `parameterMap`
`static String`	`getForString(org.springframework.web.client.RestTemplate restTemplate, String url, org.springframework.util.LinkedMultiValueMap<String,String> parameterMap, Object... uriVariables)` 以GET方法发送HTTP请求，并在请求的url中添加动态参数 `parameterMap`，返回的数据是字符串类型
`static String`	`getForString(org.springframework.web.client.RestTemplate restTemplate, String url, Map<String,String> parameterMap, Object... uriVariables)` 以GET方法发送HTTP请求，并在请求的url中添加动态参数 `parameterMap`，返回的数据是字符串类型
`static String`	`getForString(org.springframework.web.client.RestTemplate restTemplate, String url, Object... uriVariables)` 以GET方法发送HTTP请求，返回的数据是字符串类型
`static String`	`postForm(org.springframework.web.client.RestTemplate restTemplate, String url, org.springframework.util.LinkedMultiValueMap<String,String> requestBody, Object... uriVariables)` 以POST方法发送HTTP请求，请求的内容为form数据格式
`static String`	`postJson(org.springframework.web.client.RestTemplate restTemplate, String url, String requestBody, Object... uriVariables)` 以POST方法发送HTTP请求，请求的内容为JSON
`static org.springframework.web.util.UriComponents`	`uriBuild(String url, Map<String,List<String>> parameterMap, Object... uriVariables)` 构造和编码URI
`static org.springframework.web.util.UriComponents`	`uriBuild2(String url, Map<String,String> parameterMap, Object... uriVariables)` 构造和编码URI
`static StringBuilder`	`writeForm(Map<String,List<String>> form)` 将集合对象转换成 application/x-www-form-urlencoded 表单数据格式
`static StringBuilder`	`writeForm2(Map<String,String> form)` 将集合对象转换成 application/x-www-form-urlencoded 表单数据格式

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RestUtils
```
public RestUtils()
```

Method Detail

exchange

public static <T> T exchange(org.springframework.web.client.RestTemplate restTemplate,
                             org.springframework.http.HttpHeaders httpHeaders,
                             org.springframework.http.MediaType contentType,
                             URI uri,
                             org.springframework.http.HttpMethod method,
                             Object requestBody,
                             Class<T> responseType,
                             RestRequestCallback restRequestCallback)

自定义发送HTTP请求

Type Parameters:: T - 数据类型class的泛形
Parameters:: restTemplate - RestTemplate; httpHeaders - 自定义HttpHeaders; contentType - Internet Media Type，互联网媒体类型; uri - 请求的uri; method - 请求方法类型; requestBody - 请求的内容; responseType - 返回的数据类型; restRequestCallback - 回调函数，用于在发送请求之前，做某些处理操作；也可用于在返回结果之前，做某些处理操作
Returns:: 请求结果

exchange

public static <T> T exchange(org.springframework.web.client.RestTemplate restTemplate,
                             org.springframework.http.HttpHeaders httpHeaders,
                             org.springframework.http.MediaType contentType,
                             URI uri,
                             org.springframework.http.HttpMethod method,
                             Object requestBody,
                             Class<T> responseType)

自定义发送HTTP请求

Type Parameters:: T - 数据类型class的泛形
Parameters:: restTemplate - RestTemplate; httpHeaders - 自定义HttpHeaders; contentType - Internet Media Type，互联网媒体类型; uri - 请求的uri; method - 请求方法类型; requestBody - 请求的内容; responseType - 返回的数据类型
Returns:: 请求结果

exchange

public static <T> T exchange(org.springframework.web.client.RestTemplate restTemplate,
                             org.springframework.http.MediaType contentType,
                             URI uri,
                             org.springframework.http.HttpMethod method,
                             Object requestBody,
                             Class<T> responseType)

自定义发送HTTP请求

Type Parameters:: T - 数据类型class的泛形
Parameters:: restTemplate - RestTemplate; contentType - Internet Media Type，互联网媒体类型; uri - 请求的uri; method - 请求方法类型; requestBody - 请求的内容; responseType - 返回的数据类型
Returns:: 请求结果

exchange

public static <T> T exchange(org.springframework.web.client.RestTemplate restTemplate,
                             org.springframework.http.MediaType contentType,
                             String url,
                             org.springframework.http.HttpMethod method,
                             Object requestBody,
                             Class<T> responseType,
                             Object... uriVariables)

自定义发送HTTP请求

Type Parameters:: T - 数据类型class的泛形
Parameters:: restTemplate - RestTemplate; contentType - Internet Media Type，互联网媒体类型; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; method - 请求方法类型; requestBody - 请求的内容; responseType - 返回的数据类型; uriVariables - url中占位符的参数值
Returns:: 请求结果

postJson

public static String postJson(org.springframework.web.client.RestTemplate restTemplate,
                              String url,
                              String requestBody,
                              Object... uriVariables)

以POST方法发送HTTP请求，请求的内容为JSON

Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; requestBody - 请求的内容; uriVariables - url中占位符的参数值
Returns:: 请求结果

postForm

public static String postForm(org.springframework.web.client.RestTemplate restTemplate,
                              String url,
                              org.springframework.util.LinkedMultiValueMap<String,String> requestBody,
                              Object... uriVariables)

以POST方法发送HTTP请求，请求的内容为form数据格式

Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; requestBody - 请求的内容; uriVariables - url中占位符的参数值
Returns:: 请求结果

getForObject

public static <T> T getForObject(org.springframework.web.client.RestTemplate restTemplate,
                                 String url,
                                 Map<String,String> parameterMap,
                                 Class<T> responseType,
                                 Object... uriVariables)

以GET方法发送HTTP请求，并在请求的url中添加动态参数 parameterMap

Type Parameters:: T - 泛型
Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; parameterMap - 请求的参数，将会添加到url中; responseType - 返回的数据类型; uriVariables - url中占位符的参数值
Returns:: 请求结果

getForString

public static String getForString(org.springframework.web.client.RestTemplate restTemplate,
                                  String url,
                                  Map<String,String> parameterMap,
                                  Object... uriVariables)

以GET方法发送HTTP请求，并在请求的url中添加动态参数 parameterMap，返回的数据是字符串类型

Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; parameterMap - 请求的参数，将会添加到url中; uriVariables - url中占位符的参数值
Returns:: 请求结果

getForString

public static String getForString(org.springframework.web.client.RestTemplate restTemplate,
                                  String url,
                                  Object... uriVariables)

以GET方法发送HTTP请求，返回的数据是字符串类型

Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; uriVariables - url中占位符的参数值
Returns:: 请求结果

getForObject

public static <T> T getForObject(org.springframework.web.client.RestTemplate restTemplate,
                                 String url,
                                 org.springframework.util.LinkedMultiValueMap<String,String> parameterMap,
                                 Class<T> responseType,
                                 Object... uriVariables)

以GET方法发送HTTP请求，并在请求的url中添加动态参数 parameterMap

Type Parameters:: T - 泛型
Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; parameterMap - 请求的参数，将会添加到url中; responseType - 返回的数据类型; uriVariables - url中占位符的参数值
Returns:: 请求结果

getForString

public static String getForString(org.springframework.web.client.RestTemplate restTemplate,
                                  String url,
                                  org.springframework.util.LinkedMultiValueMap<String,String> parameterMap,
                                  Object... uriVariables)

以GET方法发送HTTP请求，并在请求的url中添加动态参数 parameterMap，返回的数据是字符串类型

Parameters:: restTemplate - RestTemplate; url - 请求的url，url中可以包含占位符{0}, {1}, {n}; parameterMap - 请求的参数，将会添加到url中; uriVariables - url中占位符的参数值
Returns:: 请求结果

writeForm
```
public static StringBuilder writeForm(Map<String,List<String>> form)
```
将集合对象转换成 application/x-www-form-urlencoded 表单数据格式

Parameters:

form - FORM表单数据

Returns:

FORM表单数据被编码成: key1=value1&key1=value2&key2=value3

writeForm2
```
public static StringBuilder writeForm2(Map<String,String> form)
```
将集合对象转换成 application/x-www-form-urlencoded 表单数据格式

Parameters:

form - FORM表单数据

Returns:

FORM表单数据被编码成: key1=value1&key1=value2&key2=value3

uriBuild

public static org.springframework.web.util.UriComponents uriBuild(String url,
                                                                  Map<String,List<String>> parameterMap,
                                                                  Object... uriVariables)

构造和编码URI

Parameters:: url - 原始url; parameterMap - 请求的参数，将会添加到url中; uriVariables - uri中占位符的参数值
Returns:: 替换后的URI

uriBuild2

public static org.springframework.web.util.UriComponents uriBuild2(String url,
                                                                   Map<String,String> parameterMap,
                                                                   Object... uriVariables)

构造和编码URI

Parameters:: url - 原始url; parameterMap - 请求的参数，将会添加到url中; uriVariables - uri中占位符的参数值
Returns:: 替换后的URI

Class RestUtils

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestUtils

Method Detail

exchange

exchange

exchange

exchange

postJson

postForm

getForObject

getForString

getForString

getForObject

getForString

writeForm

writeForm2

uriBuild

uriBuild2