RequestInvoker (http-client-core 1.6.2 API)

java.lang.Object
- com.ifengxue.http.proxy.RequestInvoker

所有已实现的接口:: HttpOperations, HttpClientConfig, InvocationHandler

public class RequestInvoker
extends Object
implements InvocationHandler, HttpClientConfig, HttpOperations

请求调用代理

字段概要
- 从接口继承的字段 com.ifengxue.http.proxy.HttpClientConfig
  UTF_8

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addHeader(String name, String value)` 添加全局header
`void`	`addInterceptor(Interceptor interceptor)` 添加拦截器
`void`	`addParameter(String name, Object value)` 添加全局请求参数
`static <T> T`	`create(Class<T> proxyInterface)` 使用`Thread.currentThread().getContextClassLoader()`作为类加载器创建请求代理
`static <T> T`	`create(Class<T> proxyInterface, ClassLoader classLoader)` 创建请求代理
`<T> T`	`exchange(String url, HttpMethod method, BodyType bodyType, ResponseType responseType, Type responseEntityType, Map<String,String> httpHeaders, Map<String,Object> uriVariables, Object requestBody)` 自定义执行http请求
`Object`	`invoke(Object proxy, Method method, Object[] args)`
`void`	`removeInterceptors(Class<? extends Interceptor> interceptorClass)` 批量移除拦截器
`void`	`removeInterceptors(Interceptor interceptor)` 批量移除拦截器
`void`	`setBasicAuth(String username, String password)` 设置http basic auth
`void`	`setCharset(Charset charset)` 设置编码
`void`	`setHost(String host)` 设置替换协议(http/https),主机(host),端口(port)的uri
`void`	`setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)` 使用自定义的http client
`void`	`setProxy(String host, int port, String scheme)` 设置代理
`void`	`setThreadPool(ExecutorService threadPool)` 使用自定义的线程池
`void`	`setTimeout(int socketTimeout, int connectTimeout)` 设置套接字超时时间和建立请求超时时间
`void`	`setUserAgent(String userAgent)` 设置user-agent

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.ifengxue.http.contract.HttpOperations
exchange, exchange, getForEntity, getForEntity, getForEntity, getForJsonEntity, getForJsonEntity, postForEntity, postForEntity, postForEntity, postForJsonEntity, postForJsonEntity

- 方法详细资料
  - create
```
public static <T> T create(Class<T> proxyInterface)
```
    使用Thread.currentThread().getContextClassLoader()作为类加载器创建请求代理
    
    参数:
    
    proxyInterface - 被代理的接口
  - create
```
public static <T> T create(Class<T> proxyInterface,
                           ClassLoader classLoader)
```
    创建请求代理
    
    参数:
    
    proxyInterface - 被代理的接口
    
    classLoader - 类加载器
  - invoke
```
public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable
```
    指定者:
    
    invoke 在接口中 InvocationHandler
    
    抛出:
    
    Throwable
  - addInterceptor
```
public void addInterceptor(Interceptor interceptor)
```
    从接口复制的说明: HttpClientConfig
    
    添加拦截器
    
    指定者:
    
    addInterceptor 在接口中 HttpClientConfig
  - removeInterceptors
```
public void removeInterceptors(Interceptor interceptor)
                        throws NoSuchElementException
```
    从接口复制的说明: HttpClientConfig
    
    批量移除拦截器
    
    指定者:
    
    removeInterceptors 在接口中 HttpClientConfig
    
    抛出:
    
    NoSuchElementException
  - removeInterceptors
```
public void removeInterceptors(Class<? extends Interceptor> interceptorClass)
                        throws NoSuchElementException
```
    从接口复制的说明: HttpClientConfig
    
    批量移除拦截器
    
    指定者:
    
    removeInterceptors 在接口中 HttpClientConfig
    
    抛出:
    
    NoSuchElementException
  - setCharset
```
public void setCharset(Charset charset)
```
    从接口复制的说明: HttpClientConfig
    
    设置编码
    
    指定者:
    
    setCharset 在接口中 HttpClientConfig
  - setUserAgent
```
public void setUserAgent(String userAgent)
```
    从接口复制的说明: HttpClientConfig
    
    设置user-agent
    
    指定者:
    
    setUserAgent 在接口中 HttpClientConfig
  - addHeader
```
public void addHeader(String name,
                      String value)
```
    从接口复制的说明: HttpClientConfig
    
    添加全局header
    
    指定者:
    
    addHeader 在接口中 HttpClientConfig
  - addParameter
```
public void addParameter(String name,
                         Object value)
```
    从接口复制的说明: HttpClientConfig
    
    添加全局请求参数
    
    指定者:
    
    addParameter 在接口中 HttpClientConfig
    
    参数:
    
    name - 参数名称
    
    value - 参数值
  - setHost
```
public void setHost(String host)
```
    从接口复制的说明: HttpClientConfig
    
    设置替换协议(http/https),主机(host),端口(port)的uri
    
    指定者:
    
    setHost 在接口中 HttpClientConfig
    
    参数:
    
    host - 参数必须是http(s)://host:port，如果是80,443则可以省略
  - setProxy
```
public void setProxy(String host,
                     int port,
                     String scheme)
```
    从接口复制的说明: HttpClientConfig
    
    设置代理
    
    指定者:
    
    setProxy 在接口中 HttpClientConfig
    
    参数:
    
    host - 主机地址
    
    port - 端口
    
    scheme - 协议：如http
  - setTimeout
```
public void setTimeout(int socketTimeout,
                       int connectTimeout)
```
    从接口复制的说明: HttpClientConfig
    
    设置套接字超时时间和建立请求超时时间
    
    指定者:
    
    setTimeout 在接口中 HttpClientConfig
    
    参数:
    
    socketTimeout - 设置套接字的超时时间（等待数据响应的超时时间），即两个数据包之间可以间隔的最大时间。如果为0则永不超时，如果为负值则使用系统设置，默认为-1
    
    connectTimeout - 设置建立连接所允许的超时时间。如果为0则永不超时，如果为负值则使用系统设置，默认为-1
  - setHttpClient
```
public void setHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)
```
    从接口复制的说明: HttpClientConfig
    
    使用自定义的http client
    
    指定者:
    
    setHttpClient 在接口中 HttpClientConfig
  - setThreadPool
```
public void setThreadPool(ExecutorService threadPool)
```
    从接口复制的说明: HttpClientConfig
    
    使用自定义的线程池
    
    指定者:
    
    setThreadPool 在接口中 HttpClientConfig
  - setBasicAuth
```
public void setBasicAuth(String username,
                         String password)
```
    从接口复制的说明: HttpClientConfig
    
    设置http basic auth
    
    指定者:
    
    setBasicAuth 在接口中 HttpClientConfig
    
    参数:
    
    username - 用户名
    
    password - 密码
  - exchange
```
public <T> T exchange(@Nonnull
                      String url,
                      @Nonnull
                      HttpMethod method,
                      @Nonnull
                      BodyType bodyType,
                      @Nonnull
                      ResponseType responseType,
                      @Nonnull
                      Type responseEntityType,
                      @Nullable
                      Map<String,String> httpHeaders,
                      @Nullable
                      Map<String,Object> uriVariables,
                      @Nullable
                      Object requestBody)
```
    从接口复制的说明: HttpOperations
    
    自定义执行http请求
    
    指定者:
    
    exchange 在接口中 HttpOperations
    
    参数:
    
    url - 请求地址。如请求地址为https://example.com/foo/bar，则url应为/foo/bar
    
    method - 请求方法。如GET, POST等
    
    bodyType - 请求body类型
    
    responseType - response body类型
    
    responseEntityType - 返回实体类型 TypeReference
    
    httpHeaders - 请求header
    
    uriVariables - 查询参数
    
    requestBody - 请求body
    
    返回:
    
    由responseEntityType指定的返回值

类 RequestInvoker

字段概要

从接口继承的字段 com.ifengxue.http.proxy.HttpClientConfig

方法概要

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

从接口继承的方法 com.ifengxue.http.contract.HttpOperations

方法详细资料

create

create

invoke

addInterceptor

removeInterceptors

removeInterceptors

setCharset

setUserAgent

addHeader

addParameter

setHost

setProxy

setTimeout

setHttpClient

setThreadPool

setBasicAuth

exchange