程序包 com.alibaba.nacos.common.http.client

类 NacosRestTemplate

java.lang.Object

com.alibaba.nacos.common.http.client.AbstractNacosRestTemplate

com.alibaba.nacos.common.http.client.NacosRestTemplate

public class NacosRestTemplate
extends AbstractNacosRestTemplate

Nacos rest template Interface specifying a basic set of RESTful operations.

作者:

mai.jh

另请参阅:

HttpClientRequest, HttpClientResponse

字段概要

字段

修饰符和类型	字段	说明
private java.util.List<HttpClientRequestInterceptor>	interceptors
private HttpClientRequest	requestClient

从类继承的字段 com.alibaba.nacos.common.http.client.AbstractNacosRestTemplate

logger

构造器概要

构造器

构造器	说明
NacosRestTemplate(org.slf4j.Logger logger, HttpClientRequest requestClient)

方法概要

修饰符和类型	方法	说明
void	close()	close request client.
<T> HttpRestResult<T>	delete(java.lang.String url, HttpClientConfig config, Header header, Query query, java.lang.reflect.Type responseType)	http delete URL request params are expanded using the given query Query.
<T> HttpRestResult<T>	delete(java.lang.String url, Header header, Query query, java.lang.reflect.Type responseType)	http delete URL request params are expanded using the given query Query.
<T> HttpRestResult<T>	exchange(java.lang.String url, HttpClientConfig config, Header header, Query query, java.lang.Object body, java.lang.String httpMethod, java.lang.reflect.Type responseType)	Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as HttpRestResult.
<T> HttpRestResult<T>	exchangeForm(java.lang.String url, Header header, Query query, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.String httpMethod, java.lang.reflect.Type responseType)	Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as HttpRestResult.
private <T> HttpRestResult<T>	execute(java.lang.String url, java.lang.String httpMethod, RequestHttpEntity requestEntity, java.lang.reflect.Type responseType)
<T> HttpRestResult<T>	get(java.lang.String url, HttpClientConfig config, Header header, Query query, java.lang.reflect.Type responseType)	http get URL request params are expanded using the given query Query.
<T> HttpRestResult<T>	get(java.lang.String url, Header header, Query query, java.lang.reflect.Type responseType)	http get URL request params are expanded using the given query Query.
java.util.List<HttpClientRequestInterceptor>	getInterceptors()	Return the request interceptors that this accessor uses.
<T> HttpRestResult<T>	getLarge(java.lang.String url, Header header, Query query, java.lang.Object body, java.lang.reflect.Type responseType)	get request, may be pulling a lot of data URL request params are expanded using the given query Query, More request parameters can be set via body.
<T> HttpRestResult<T>	post(java.lang.String url, Header header, Query query, java.lang.Object body, java.lang.reflect.Type responseType)	http post Create a new resource by POSTing the given object to the http request.
<T> HttpRestResult<T>	postForm(java.lang.String url, HttpClientConfig config, Header header, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.reflect.Type responseType)	http post from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.
<T> HttpRestResult<T>	postForm(java.lang.String url, Header header, Query query, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.reflect.Type responseType)	http post from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.
<T> HttpRestResult<T>	postForm(java.lang.String url, Header header, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.reflect.Type responseType)	http post from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.
<T> HttpRestResult<T>	postJson(java.lang.String url, Header header, Query query, java.lang.String body, java.lang.reflect.Type responseType)	http post json Create a new resource by POSTing the given object to the http request, http header contentType default 'application/json;charset=UTF-8'.
<T> HttpRestResult<T>	postJson(java.lang.String url, Header header, java.lang.String body, java.lang.reflect.Type responseType)	http post json Create a new resource by POSTing the given object to the http request, http header contentType default 'application/json;charset=UTF-8'.
<T> HttpRestResult<T>	put(java.lang.String url, Header header, Query query, java.lang.Object body, java.lang.reflect.Type responseType)	http put Create a new resource by PUTting the given body to http request.
<T> HttpRestResult<T>	putForm(java.lang.String url, HttpClientConfig config, Header header, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.reflect.Type responseType)	http put from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.
<T> HttpRestResult<T>	putForm(java.lang.String url, Header header, Query query, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.reflect.Type responseType)	http put from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.
<T> HttpRestResult<T>	putForm(java.lang.String url, Header header, java.util.Map<java.lang.String,java.lang.String> bodyValues, java.lang.reflect.Type responseType)	http put from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.
<T> HttpRestResult<T>	putJson(java.lang.String url, Header header, Query query, java.lang.String body, java.lang.reflect.Type responseType)	http put json Create a new resource by PUTting the given body to http request, http header contentType default 'application/json;charset=UTF-8'.
<T> HttpRestResult<T>	putJson(java.lang.String url, Header header, java.lang.String body, java.lang.reflect.Type responseType)	http put json Create a new resource by PUTting the given body to http request, http header contentType default 'application/json;charset=UTF-8'.
private HttpClientRequest	requestClient()
void	setInterceptors(java.util.List<HttpClientRequestInterceptor> interceptors)	Set the request interceptors that this accessor should use.

从类继承的方法 com.alibaba.nacos.common.http.client.AbstractNacosRestTemplate

registerResponseHandler, selectResponseHandler

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

requestClient

private final HttpClientRequest requestClient

interceptors

private final java.util.List<HttpClientRequestInterceptor> interceptors

构造器详细资料

NacosRestTemplate

public NacosRestTemplate(org.slf4j.Logger logger,
                         HttpClientRequest requestClient)

方法详细资料

get

public <T> HttpRestResult<T> get(java.lang.String url,
                                 Header header,
                                 Query query,
                                 java.lang.reflect.Type responseType)
                          throws java.lang.Exception

http get URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

get

public <T> HttpRestResult<T> get(java.lang.String url,
                                 HttpClientConfig config,
                                 Header header,
                                 Query query,
                                 java.lang.reflect.Type responseType)
                          throws java.lang.Exception

http get URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

config Specify the request config via HttpClientConfig

参数:

url - url

config - http config

header - headers

query - http query param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

getLarge

public <T> HttpRestResult<T> getLarge(java.lang.String url,
                                      Header header,
                                      Query query,
                                      java.lang.Object body,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

get request, may be pulling a lot of data URL request params are expanded using the given query Query, More request parameters can be set via body.

This method can only be used when HttpClientRequest is implemented by DefaultHttpClientRequest, note: JdkHttpClientRequest Implementation does not support this method.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

body - get with body

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

delete

public <T> HttpRestResult<T> delete(java.lang.String url,
                                    Header header,
                                    Query query,
                                    java.lang.reflect.Type responseType)
                             throws java.lang.Exception

http delete URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

delete

public <T> HttpRestResult<T> delete(java.lang.String url,
                                    HttpClientConfig config,
                                    Header header,
                                    Query query,
                                    java.lang.reflect.Type responseType)
                             throws java.lang.Exception

http delete URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

config Specify the request config via HttpClientConfig

参数:

url - url

config - http config

header - http header param

query - http query param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

put

public <T> HttpRestResult<T> put(java.lang.String url,
                                 Header header,
                                 Query query,
                                 java.lang.Object body,
                                 java.lang.reflect.Type responseType)
                          throws java.lang.Exception

http put Create a new resource by PUTting the given body to http request.

URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

body - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

putJson

public <T> HttpRestResult<T> putJson(java.lang.String url,
                                     Header header,
                                     Query query,
                                     java.lang.String body,
                                     java.lang.reflect.Type responseType)
                              throws java.lang.Exception

http put json Create a new resource by PUTting the given body to http request, http header contentType default 'application/json;charset=UTF-8'.

URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

body - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

putJson

public <T> HttpRestResult<T> putJson(java.lang.String url,
                                     Header header,
                                     java.lang.String body,
                                     java.lang.reflect.Type responseType)
                              throws java.lang.Exception

http put json Create a new resource by PUTting the given body to http request, http header contentType default 'application/json;charset=UTF-8'.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

body - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

putForm

public <T> HttpRestResult<T> putForm(java.lang.String url,
                                     Header header,
                                     Query query,
                                     java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                     java.lang.reflect.Type responseType)
                              throws java.lang.Exception

http put from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.

URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

bodyValues - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

putForm

public <T> HttpRestResult<T> putForm(java.lang.String url,
                                     Header header,
                                     java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                     java.lang.reflect.Type responseType)
                              throws java.lang.Exception

http put from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

bodyValues - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

putForm

public <T> HttpRestResult<T> putForm(java.lang.String url,
                                     HttpClientConfig config,
                                     Header header,
                                     java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                     java.lang.reflect.Type responseType)
                              throws java.lang.Exception

http put from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.

responseType can be an HttpRestResult or HttpRestResult data T type.

config Specify the request config via HttpClientConfig

参数:

url - url

config - http config

header - http header param

bodyValues - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

post

public <T> HttpRestResult<T> post(java.lang.String url,
                                  Header header,
                                  Query query,
                                  java.lang.Object body,
                                  java.lang.reflect.Type responseType)
                           throws java.lang.Exception

http post Create a new resource by POSTing the given object to the http request.

URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

body - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

postJson

public <T> HttpRestResult<T> postJson(java.lang.String url,
                                      Header header,
                                      Query query,
                                      java.lang.String body,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

http post json Create a new resource by POSTing the given object to the http request, http header contentType default 'application/json;charset=UTF-8'.

URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

body - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

postJson

public <T> HttpRestResult<T> postJson(java.lang.String url,
                                      Header header,
                                      java.lang.String body,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

http post json Create a new resource by POSTing the given object to the http request, http header contentType default 'application/json;charset=UTF-8'.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

body - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

postForm

public <T> HttpRestResult<T> postForm(java.lang.String url,
                                      Header header,
                                      Query query,
                                      java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

http post from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.

URL request params are expanded using the given query Query.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

query - http query param

bodyValues - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

postForm

public <T> HttpRestResult<T> postForm(java.lang.String url,
                                      Header header,
                                      java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

http post from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.

responseType can be an HttpRestResult or HttpRestResult data T type.

参数:

url - url

header - http header param

bodyValues - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

postForm

public <T> HttpRestResult<T> postForm(java.lang.String url,
                                      HttpClientConfig config,
                                      Header header,
                                      java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

http post from Create a new resource by PUTting the given map bodyValues to http request, http header contentType default 'application/x-www-form-urlencoded;charset=utf-8'.

responseType can be an HttpRestResult or HttpRestResult data T type.

config Specify the request config via HttpClientConfig

参数:

url - url

config - http config

header - http header param

bodyValues - http body param

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

exchangeForm

public <T> HttpRestResult<T> exchangeForm(java.lang.String url,
                                          Header header,
                                          Query query,
                                          java.util.Map<java.lang.String,java.lang.String> bodyValues,
                                          java.lang.String httpMethod,
                                          java.lang.reflect.Type responseType)
                                   throws java.lang.Exception

Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as HttpRestResult.

参数:

url - url

header - http header param

query - http query param

bodyValues - http body param

httpMethod - http method

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

exchange

public <T> HttpRestResult<T> exchange(java.lang.String url,
                                      HttpClientConfig config,
                                      Header header,
                                      Query query,
                                      java.lang.Object body,
                                      java.lang.String httpMethod,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as HttpRestResult.

参数:

url - url

config - HttpClientConfig

header - http header param

query - http query param

body - http body param

httpMethod - http method

responseType - return type

返回:

HttpRestResult

抛出:

java.lang.Exception - ex

setInterceptors

public void setInterceptors(java.util.List<HttpClientRequestInterceptor> interceptors)

Set the request interceptors that this accessor should use.

参数:

interceptors - HttpClientRequestInterceptor

getInterceptors

public java.util.List<HttpClientRequestInterceptor> getInterceptors()

Return the request interceptors that this accessor uses.

The returned List is active and may get appended to.

execute

private <T> HttpRestResult<T> execute(java.lang.String url,
                                      java.lang.String httpMethod,
                                      RequestHttpEntity requestEntity,
                                      java.lang.reflect.Type responseType)
                               throws java.lang.Exception

抛出:

java.lang.Exception

requestClient

private HttpClientRequest requestClient()

close

public void close()
           throws java.lang.Exception

close request client.

抛出:

java.lang.Exception