HttpRequest (tool-http 1.0.3.9.RELEASE API)

java.lang.Object
- cn.luues.tool.http.HttpBase<HttpRequest>
- - cn.luues.tool.http.HttpRequest

```
public class HttpRequest
extends HttpBase<HttpRequest>
```
http请求类
Http请求类用于构建Http请求并同步获取结果，此类通过CookieManager持有域名对应的Cookie值，再次请求时会自动附带Cookie信息

作者:

Looly

字段概要

字段
限定符和类型	字段和说明
`private int`	`blockSize` Chuncked块大小，0或小于0表示不设置Chuncked模式
`private int`	`connectionTimeout` 默认连接超时
`private static String`	`CONTENT_TYPE_FILE_TEMPLATE`
`private static String`	`CONTENT_TYPE_MULTIPART_PREFIX`
`private String`	`cookie` Cookie
`private Map<String,Object>`	`form` 存储表单数据
`private HostnameVerifier`	`hostnameVerifier` HostnameVerifier，用于HTTPS安全连接
`(专用程序包) org.apache.http.impl.client.CloseableHttpClient`	`httpclient`
`private HttpConnection`	`httpConnection` 连接对象
`private boolean`	`isDisableCache` 是否禁用缓存
`private boolean`	`isMultiPart` 是否为Multipart表单
`private boolean`	`isRest` 是否是REST请求模式
`private boolean`	`isStream` 是否使用event-stream获取响应数据
`private int`	`maxRedirectCount` 最大重定向次数
`private Method`	`method`
`private Proxy`	`proxy` 代理
`private int`	`readTimeout` 默认读取超时
`private int`	`redirectCount` 重定向次数计数器，内部使用
`private SSLSocketFactory`	`ssf` SSLSocketFactory，用于HTTPS安全连接
`private UrlBuilder`	`url`
`private URLStreamHandler`	`urlHandler`

从类继承的字段 cn.luues.tool.http.HttpBase
bodyBytes, charset, headers, HTTP_1_0, HTTP_1_1, httpVersion

构造器概要

构造器
构造器和说明

HttpRequest(String url)
构造，URL编码默认使用UTF-8

HttpRequest(UrlBuilder url)
构造

构造器
构造器和说明
`HttpRequest(String url)` 构造，URL编码默认使用UTF-8
`HttpRequest(UrlBuilder url)` 构造

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`HttpRequest`	`auth(String content)` 验证，简单插入Authorization头
`HttpRequest`	`basicAuth(String username, String password)` 简单验证，生成的头信息类似于： Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
`HttpRequest`	`basicProxyAuth(String username, String password)` 简单代理验证，生成的头信息类似于： Proxy-Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
`HttpRequest`	`bearerAuth(String token)` 令牌验证，生成的头类似于："Authorization: Bearer XXXXX"，一般用于JWT
`HttpRequest`	`body(byte[] bodyBytes)` 设置主体字节码需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
`HttpRequest`	`body(String body)` 设置内容主体请求体body参数支持两种类型： 1.
`HttpRequest`	`body(String body, String contentType)` 设置内容主体请求体body参数支持两种类型： 1.
`static void`	`closeCookie()` 关闭Cookie
`String`	`contentLength()` 获取内容长度
`HttpRequest`	`contentLength(int value)` 设置内容长度
`HttpRequest`	`contentType(String contentType)` 设置contentType
`HttpRequest`	`cookie(Collection<HttpCookie> cookies)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`HttpRequest`	`cookie(HttpCookie... cookies)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`HttpRequest`	`cookie(String cookie)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`static HttpRequest`	`delete(String url)` DELETE请求
`HttpRequest`	`disableCache()` 禁用缓存
`HttpRequest`	`disableCookie()` 禁用默认Cookie行为，此方法调用后会将Cookie置为空。
`HttpRequest`	`enableDefaultCookie()` 打开默认的Cookie行为（自动回填服务器传回的Cookie）
`HttpResponse`	`execute()` 执行Reuqest请求
`HttpResponse`	`execute(boolean isAsync)` 执行Reuqest请求
`HttpResponse`	`executeAsync()` 异步请求异步请求后获取的`HttpResponse` 为异步模式，执行完此方法后发送请求到服务器，但是并不立即读取响应内容。
`Map<String,Resource>`	`fileForm()` 获取文件表单数据
`Map<String,Object>`	`form()` 获取表单数据
`HttpRequest`	`form(Map<String,Object> formMap)` 设置map类型表单数据
`HttpRequest`	`form(String name, byte[] fileBytes, String fileName)` 文件byte[]表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(String name, File... files)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(String name, File file)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(String name, File file, String fileName)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(String name, Object value)` 设置表单数据
`HttpRequest`	`form(String name, Object value, Object... parameters)` 设置表单数据
`HttpRequest`	`form(String name, Resource resource)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`static HttpRequest`	`get(String url)` GET请求
`HttpConnection`	`getConnection()` 获取`HttpConnection` 在`execute()` 执行前此对象为null
`static CookieManager`	`getCookieManager()` 获取Cookie管理器，用于自定义Cookie管理
`private String`	`getFormUrlEncoded()` 获取编码后的表单数据，无表单数据返回""
`Method`	`getMethod()` 获取Http请求方法
`String`	`getUrl()` 获取请求URL
`static HttpRequest`	`head(String url)` HEAD请求
`private void`	`initConnection()` 初始化网络连接
`private org.apache.http.client.methods.HttpPost`	`initStreamConnection()` 初始化网络连接
`private boolean`	`isIgnoreResponseBody()` 是否忽略读取响应body部分 HEAD、CONNECT、OPTIONS、TRACE方法将不读取响应体
`boolean`	`isKeepAlive()`
`private boolean`	`isMultipart()` 判断是否为multipart/form-data表单，条件如下： 1.
`HttpRequest`	`keepAlive(boolean isKeepAlive)` 设置是否为长连接
`HttpRequest`	`method(Method method)` 设置请求方法
`static HttpRequest`	`options(String url)` OPTIONS请求
`static HttpRequest`	`patch(String url)` PATCH请求
`static HttpRequest`	`post(String url)` POST请求
`static HttpRequest`	`postStream(String url)`
`HttpRequest`	`proxyAuth(String content)` 验证，简单插入Authorization头
`static HttpRequest`	`put(String url)` PUT请求
`private HttpRequest`	`putToForm(String name, Object value)` 将参数加入到form中，如果form为空，新建之。
`private void`	`send()` 发送数据流
`private void`	`sendFormUrlEncoded()` 发送普通表单发送数据后自动关闭输出流
`private void`	`sendMultipart()` 发送多组件请求（例如包含文件的表单）发送数据后自动关闭输出流
`private HttpResponse`	`sendRedirectIfPossible()` 调用转发，如果需要转发返回转发结果，否则返回`null`
`HttpRequest`	`setChunkedStreamingMode(int blockSize)` 采用流方式上传数据，无需本地缓存数据。
`HttpRequest`	`setConnectionTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`static void`	`setCookieManager(CookieManager customCookieManager)` 自定义`CookieManager`
`HttpRequest`	`setEncodeUrlParams(boolean isEncodeUrlParams)` 已过时。编码自动完成，无需设置
`HttpRequest`	`setFollowRedirects(boolean isFollowRedirects)` 设置是否打开重定向，如果打开默认重定向次数为2 此方法效果与`setMaxRedirectCount(int)` 一致
`static void`	`setGlobalTimeout(int customTimeout)` 设置全局默认的连接和读取超时时长
`HttpRequest`	`setHostnameVerifier(HostnameVerifier hostnameVerifier)` 设置域名验证器只针对HTTPS请求，如果不设置，不做验证，所有域名被信任
`HttpRequest`	`setHttpProxy(String host, int port)` 设置Http代理
`HttpRequest`	`setMaxRedirectCount(int maxRedirectCount)` 设置最大重定向次数如果次数小于1则表示不重定向，大于等于1表示打开重定向
`HttpRequest`	`setMethod(Method method)` 设置请求方法
`private void`	`setMultipart()` 设置表单类型为Multipart（文件上传）
`HttpRequest`	`setProxy(Proxy proxy)` 设置代理
`HttpRequest`	`setReadTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`HttpRequest`	`setRest(boolean isRest)` 设置是否rest模式 rest模式下get请求不会把参数附加到URL之后
`HttpRequest`	`setSSLProtocol(String protocol)` 设置HTTPS安全连接协议，只针对HTTPS请求，可以使用的协议包括：此方法调用后`setSSLSocketFactory(SSLSocketFactory)` 将被覆盖。
`HttpRequest`	`setSSLSocketFactory(SSLSocketFactory ssf)` 设置SSLSocketFactory 只针对HTTPS请求，如果不设置，使用默认的SSLSocketFactory 默认SSLSocketFactory为：SSLSocketFactoryBuilder.create().build();
`HttpRequest`	`setUrl(String url)` 设置URL
`HttpRequest`	`setUrl(UrlBuilder urlBuilder)` 设置URL
`HttpRequest`	`setUrlHandler(URLStreamHandler urlHandler)` 设置`URLStreamHandler` 部分环境下需要单独设置此项，例如当 WebLogic Server 实例充当 SSL 客户端角色（它会尝试通过 SSL 连接到其他服务器或应用程序）时，它会验证 SSL 服务器在数字证书中返回的主机名是否与用于连接 SSL 服务器的 URL 主机名相匹配。
`HttpRequest`	`stream()`
`HttpRequest`	`timeout(int milliseconds)` 设置超时，单位：毫秒超时包括： 1.
`String`	`toString()`
`static HttpRequest`	`trace(String url)` TRACE请求
`private void`	`urlWithParamIfGet()` 对于GET请求将参数加到URL中此处不对URL中的特殊字符做单独编码

从类继承的方法 cn.luues.tool.http.HttpBase
addHeaders, charset, charset, charset, header, header, header, header, header, header, header, header, headerList, headerMap, headers, httpVersion, httpVersion, removeHeader, removeHeader

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

- 字段详细资料
  - CONTENT_TYPE_MULTIPART_PREFIX
```
private static final String CONTENT_TYPE_MULTIPART_PREFIX
```
  - CONTENT_TYPE_FILE_TEMPLATE
```
private static final String CONTENT_TYPE_FILE_TEMPLATE
```
    另请参阅:
    
    常量字段值
  - url
```
private UrlBuilder url
```
  - urlHandler
```
private URLStreamHandler urlHandler
```
  - method
```
private Method method
```
  - connectionTimeout
```
private int connectionTimeout
```
    默认连接超时
  - readTimeout
```
private int readTimeout
```
    默认读取超时
  - form
```
private Map<String,Object> form
```
    存储表单数据
  - isMultiPart
```
private boolean isMultiPart
```
    是否为Multipart表单
  - cookie
```
private String cookie
```
    Cookie
  - httpConnection
```
private HttpConnection httpConnection
```
    连接对象
  - httpclient
```
org.apache.http.impl.client.CloseableHttpClient httpclient
```
  - isDisableCache
```
private boolean isDisableCache
```
    是否禁用缓存
  - isRest
```
private boolean isRest
```
    是否是REST请求模式
  - redirectCount
```
private int redirectCount
```
    重定向次数计数器，内部使用
  - maxRedirectCount
```
private int maxRedirectCount
```
    最大重定向次数
  - blockSize
```
private int blockSize
```
    Chuncked块大小，0或小于0表示不设置Chuncked模式
  - proxy
```
private Proxy proxy
```
    代理
  - hostnameVerifier
```
private HostnameVerifier hostnameVerifier
```
    HostnameVerifier，用于HTTPS安全连接
  - ssf
```
private SSLSocketFactory ssf
```
    SSLSocketFactory，用于HTTPS安全连接
  - isStream
```
private boolean isStream
```
    是否使用event-stream获取响应数据
- 构造器详细资料
  - HttpRequest
```
public HttpRequest(String url)
```
    构造，URL编码默认使用UTF-8
    
    参数:
    
    url - URL
  - HttpRequest
```
public HttpRequest(UrlBuilder url)
```
    构造
    
    参数:
    
    url - UrlBuilder
- 方法详细资料
  - setGlobalTimeout
```
public static void setGlobalTimeout(int customTimeout)
```
    设置全局默认的连接和读取超时时长
    
    参数:
    
    customTimeout - 超时时长
    
    从以下版本开始:
    
    4.6.2
    
    另请参阅:
    
    HttpGlobalConfig.setTimeout(int)
  - getCookieManager
```
public static CookieManager getCookieManager()
```
    获取Cookie管理器，用于自定义Cookie管理
    
    返回:
    
    CookieManager
    
    从以下版本开始:
    
    4.1.0
    
    另请参阅:
    
    GlobalCookieManager.getCookieManager()
  - setCookieManager
```
public static void setCookieManager(CookieManager customCookieManager)
```
    自定义CookieManager
    
    参数:
    
    customCookieManager - 自定义的CookieManager
    
    从以下版本开始:
    
    4.5.14
    
    另请参阅:
    
    GlobalCookieManager.setCookieManager(CookieManager)
  - closeCookie
```
public static void closeCookie()
```
    关闭Cookie
    
    从以下版本开始:
    
    4.1.9
    
    另请参阅:
    
    GlobalCookieManager.setCookieManager(CookieManager)
  - post
```
public static HttpRequest post(String url)
```
    POST请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - postStream
```
public static HttpRequest postStream(String url)
```
  - get
```
public static HttpRequest get(String url)
```
    GET请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - head
```
public static HttpRequest head(String url)
```
    HEAD请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - options
```
public static HttpRequest options(String url)
```
    OPTIONS请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - put
```
public static HttpRequest put(String url)
```
    PUT请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - patch
```
public static HttpRequest patch(String url)
```
    PATCH请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
    
    从以下版本开始:
    
    3.0.9
  - delete
```
public static HttpRequest delete(String url)
```
    DELETE请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - trace
```
public static HttpRequest trace(String url)
```
    TRACE请求
    
    参数:
    
    url - URL
    
    返回:
    
    HttpRequest
  - getUrl
```
public String getUrl()
```
    获取请求URL
    
    返回:
    
    URL字符串
    
    从以下版本开始:
    
    4.1.8
  - setUrl
```
public HttpRequest setUrl(String url)
```
    设置URL
    
    参数:
    
    url - url字符串
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.1.8
  - setUrl
```
public HttpRequest setUrl(UrlBuilder urlBuilder)
```
    设置URL
    
    参数:
    
    urlBuilder - url字符串
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.3.1
  - setUrlHandler
```
public HttpRequest setUrlHandler(URLStreamHandler urlHandler)
```
    设置URLStreamHandler
    部分环境下需要单独设置此项，例如当 WebLogic Server 实例充当 SSL 客户端角色（它会尝试通过 SSL 连接到其他服务器或应用程序）时，
    它会验证 SSL 服务器在数字证书中返回的主机名是否与用于连接 SSL 服务器的 URL 主机名相匹配。如果主机名不匹配，则删除此连接。
    因此weblogic不支持https的sni协议的主机名验证，此时需要将此值设置为sun.net.www.protocol.https.Handler对象。
    相关issue见：https://gitee.com/loolly/hutool/issues/IMD1X
    
    参数:
    
    urlHandler - URLStreamHandler
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.1.9
  - getMethod
```
public Method getMethod()
```
    获取Http请求方法
    
    返回:
    
    Method
    
    从以下版本开始:
    
    4.1.8
  - setMethod
```
public HttpRequest setMethod(Method method)
```
    设置请求方法
    
    参数:
    
    method - HTTP方法
    
    返回:
    
    HttpRequest
    
    从以下版本开始:
    
    4.1.8
    
    另请参阅:
    
    method(Method)
  - getConnection
```
public HttpConnection getConnection()
```
    获取HttpConnection
    在execute() 执行前此对象为null
    
    返回:
    
    HttpConnection
    
    从以下版本开始:
    
    4.2.2
  - method
```
public HttpRequest method(Method method)
```
    设置请求方法
    
    参数:
    
    method - HTTP方法
    
    返回:
    
    HttpRequest
  - stream
```
public HttpRequest stream()
```
  - contentType
```
public HttpRequest contentType(String contentType)
```
    设置contentType
    
    参数:
    
    contentType - contentType
    
    返回:
    
    HttpRequest
  - keepAlive
```
public HttpRequest keepAlive(boolean isKeepAlive)
```
    设置是否为长连接
    
    参数:
    
    isKeepAlive - 是否长连接
    
    返回:
    
    HttpRequest
  - isKeepAlive
```
public boolean isKeepAlive()
```
    返回:
    
    获取是否为长连接
  - contentLength
```
public String contentLength()
```
    获取内容长度
    
    返回:
    
    String
  - contentLength
```
public HttpRequest contentLength(int value)
```
    设置内容长度
    
    参数:
    
    value - 长度
    
    返回:
    
    HttpRequest
  - cookie
```
public HttpRequest cookie(Collection<HttpCookie> cookies)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    参数:
    
    cookies - Cookie值数组，如果为null则设置无效，使用默认Cookie行为
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.1
  - cookie
```
public HttpRequest cookie(HttpCookie... cookies)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    参数:
    
    cookies - Cookie值数组，如果为null则设置无效，使用默认Cookie行为
    
    返回:
    
    this
    
    从以下版本开始:
    
    3.1.1
  - cookie
```
public HttpRequest cookie(String cookie)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    参数:
    
    cookie - Cookie值，如果为null则设置无效，使用默认Cookie行为
    
    返回:
    
    this
    
    从以下版本开始:
    
    3.0.7
  - disableCookie
```
public HttpRequest disableCookie()
```
    禁用默认Cookie行为，此方法调用后会将Cookie置为空。
    如果想重新启用Cookie，请调用：cookie(String)方法自定义Cookie。
    如果想启动默认的Cookie行为（自动回填服务器传回的Cookie），则调用enableDefaultCookie()
    
    返回:
    
    this
    
    从以下版本开始:
    
    3.0.7
  - enableDefaultCookie
```
public HttpRequest enableDefaultCookie()
```
    打开默认的Cookie行为（自动回填服务器传回的Cookie）
    
    返回:
    
    this
  - form
```
public HttpRequest form(String name,
                        Object value)
```
    设置表单数据
    
    参数:
    
    name - 名
    
    value - 值
    
    返回:
    
    this
  - form
```
public HttpRequest form(String name,
                        Object value,
                        Object... parameters)
```
    设置表单数据
    
    参数:
    
    name - 名
    
    value - 值
    
    parameters - 参数对，奇数为名，偶数为值
    
    返回:
    
    this
  - form
```
public HttpRequest form(Map<String,Object> formMap)
```
    设置map类型表单数据
    
    参数:
    
    formMap - 表单内容
    
    返回:
    
    this
  - form
```
public HttpRequest form(String name,
                        File... files)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    
    name - 名
    
    files - 需要上传的文件，为空跳过
    
    返回:
    
    this
  - form
```
public HttpRequest form(String name,
                        File file)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    
    name - 名
    
    file - 需要上传的文件
    
    返回:
    
    this
  - form
```
public HttpRequest form(String name,
                        File file,
                        String fileName)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    
    name - 名
    
    file - 需要上传的文件
    
    fileName - 文件名，为空使用文件默认的文件名
    
    返回:
    
    this
  - form
```
public HttpRequest form(String name,
                        byte[] fileBytes,
                        String fileName)
```
    文件byte[]表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    
    name - 名
    
    fileBytes - 需要上传的文件
    
    fileName - 文件名
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.1.0
  - form
```
public HttpRequest form(String name,
                        Resource resource)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    
    name - 名
    
    resource - 数据源，文件可以使用FileResource包装使用
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.0.9
  - form
```
public Map<String,Object> form()
```
    获取表单数据
    
    返回:
    
    表单Map
  - fileForm
```
public Map<String,Resource> fileForm()
```
    获取文件表单数据
    
    返回:
    
    文件表单Map
    
    从以下版本开始:
    
    3.3.0
  - body
```
public HttpRequest body(String body)
```
    设置内容主体
    请求体body参数支持两种类型：
```
 1. 标准参数，例如 a=1&b=2 这种格式
 2. Rest模式，此时body需要传入一个JSON或者XML字符串，Hutool会自动绑定其对应的Content-Type
 
```
    参数:
    
    body - 请求体
    
    返回:
    
    this
  - body
```
public HttpRequest body(String body,
                        String contentType)
```
    设置内容主体
    请求体body参数支持两种类型：
```
 1. 标准参数，例如 a=1&b=2 这种格式
 2. Rest模式，此时body需要传入一个JSON或者XML字符串，Hutool会自动绑定其对应的Content-Type
 
```
    参数:
    
    body - 请求体
    
    contentType - 请求体类型，null表示自动判断类型
    
    返回:
    
    this
  - body
```
public HttpRequest body(byte[] bodyBytes)
```
    设置主体字节码
    需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
    
    参数:
    
    bodyBytes - 主体
    
    返回:
    
    this
  - timeout
```
public HttpRequest timeout(int milliseconds)
```
    设置超时，单位：毫秒
    超时包括：
```
 1. 连接超时
 2. 读取响应超时
 
```
    参数:
    
    milliseconds - 超时毫秒数
    
    返回:
    
    this
    
    另请参阅:
    
    setConnectionTimeout(int), setReadTimeout(int)
  - setConnectionTimeout
```
public HttpRequest setConnectionTimeout(int milliseconds)
```
    设置连接超时，单位：毫秒
    
    参数:
    
    milliseconds - 超时毫秒数
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.5.6
  - setReadTimeout
```
public HttpRequest setReadTimeout(int milliseconds)
```
    设置连接超时，单位：毫秒
    
    参数:
    
    milliseconds - 超时毫秒数
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.5.6
  - disableCache
```
public HttpRequest disableCache()
```
    禁用缓存
    
    返回:
    
    this
  - setEncodeUrlParams
```
@Deprecated
public HttpRequest setEncodeUrlParams(boolean isEncodeUrlParams)
```
    已过时。编码自动完成，无需设置
    
    是否对URL中的参数进行编码
    
    参数:
    
    isEncodeUrlParams - 是否对URL中的参数进行编码
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.4.1
  - setFollowRedirects
```
public HttpRequest setFollowRedirects(boolean isFollowRedirects)
```
    设置是否打开重定向，如果打开默认重定向次数为2
    此方法效果与setMaxRedirectCount(int) 一致
    
    参数:
    
    isFollowRedirects - 是否打开重定向
    
    返回:
    
    this
  - setMaxRedirectCount
```
public HttpRequest setMaxRedirectCount(int maxRedirectCount)
```
    设置最大重定向次数
    如果次数小于1则表示不重定向，大于等于1表示打开重定向
    
    参数:
    
    maxRedirectCount - 最大重定向次数
    
    返回:
    
    this
    
    从以下版本开始:
    
    3.3.0
  - setHostnameVerifier
```
public HttpRequest setHostnameVerifier(HostnameVerifier hostnameVerifier)
```
    设置域名验证器
    只针对HTTPS请求，如果不设置，不做验证，所有域名被信任
    
    参数:
    
    hostnameVerifier - HostnameVerifier
    
    返回:
    
    this
  - setHttpProxy
```
public HttpRequest setHttpProxy(String host,
                                int port)
```
    设置Http代理
    
    参数:
    
    host - 代理主机
    
    port - 代理端口
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.5
  - setProxy
```
public HttpRequest setProxy(Proxy proxy)
```
    设置代理
    
    参数:
    
    proxy - 代理 Proxy
    
    返回:
    
    this
  - setSSLSocketFactory
```
public HttpRequest setSSLSocketFactory(SSLSocketFactory ssf)
```
    设置SSLSocketFactory
    只针对HTTPS请求，如果不设置，使用默认的SSLSocketFactory
    默认SSLSocketFactory为：SSLSocketFactoryBuilder.create().build();
    
    参数:
    
    ssf - SSLScketFactory
    
    返回:
    
    this
  - setSSLProtocol
```
public HttpRequest setSSLProtocol(String protocol)
```
    设置HTTPS安全连接协议，只针对HTTPS请求，可以使用的协议包括：
    此方法调用后setSSLSocketFactory(SSLSocketFactory) 将被覆盖。
```
 1. TLSv1.2
 2. TLSv1.1
 3. SSLv3
 ...
 
```
    参数:
    
    protocol - 协议
    
    返回:
    
    this
    
    另请参阅:
    
    SSLSocketFactoryBuilder, setSSLSocketFactory(SSLSocketFactory)
  - setRest
```
public HttpRequest setRest(boolean isRest)
```
    设置是否rest模式
    rest模式下get请求不会把参数附加到URL之后
    
    参数:
    
    isRest - 是否rest模式
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.5.0
  - setChunkedStreamingMode
```
public HttpRequest setChunkedStreamingMode(int blockSize)
```
    采用流方式上传数据，无需本地缓存数据。
    HttpUrlConnection默认是将所有数据读到本地缓存，然后再发送给服务器，这样上传大文件时就会导致内存溢出。
    
    参数:
    
    blockSize - 块大小（bytes数），0或小于0表示不设置Chuncked模式
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.6.5
  - execute
```
public HttpResponse execute()
```
    执行Reuqest请求
    
    返回:
    
    this
  - executeAsync
```
public HttpResponse executeAsync()
```
    异步请求
    异步请求后获取的HttpResponse 为异步模式，执行完此方法后发送请求到服务器，但是并不立即读取响应内容。
    此时保持Http连接不关闭，直调用获取内容方法为止。
    一般执行完execute之后会把响应内容全部读出来放在一个 byte数组里，如果你响应的内容太多内存就爆了，此法是发送完请求不直接读响应内容，等有需要的时候读。
    
    返回:
    
    异步对象，使用get方法获取HttpResponse对象
  - execute
```
public HttpResponse execute(boolean isAsync)
```
    执行Reuqest请求
    
    参数:
    
    isAsync - 是否异步
    
    返回:
    
    this
  - basicAuth
```
public HttpRequest basicAuth(String username,
                             String password)
```
    简单验证，生成的头信息类似于：
```
 Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
 
```
    参数:
    
    username - 用户名
    
    password - 密码
    
    返回:
    
    this
  - basicProxyAuth
```
public HttpRequest basicProxyAuth(String username,
                                  String password)
```
    简单代理验证，生成的头信息类似于：
```
 Proxy-Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
 
```
    参数:
    
    username - 用户名
    
    password - 密码
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.6
  - bearerAuth
```
public HttpRequest bearerAuth(String token)
```
    令牌验证，生成的头类似于："Authorization: Bearer XXXXX"，一般用于JWT
    
    参数:
    
    token - 令牌内容
    
    返回:
    
    HttpRequest
    
    从以下版本开始:
    
    5.5.3
  - auth
```
public HttpRequest auth(String content)
```
    验证，简单插入Authorization头
    
    参数:
    
    content - 验证内容
    
    返回:
    
    HttpRequest
    
    从以下版本开始:
    
    5.2.4
  - proxyAuth
```
public HttpRequest proxyAuth(String content)
```
    验证，简单插入Authorization头
    
    参数:
    
    content - 验证内容
    
    返回:
    
    HttpRequest
    
    从以下版本开始:
    
    5.4.6
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 HttpBase<HttpRequest>
  - initConnection
```
private void initConnection()
```
    初始化网络连接
  - initStreamConnection
```
private org.apache.http.client.methods.HttpPost initStreamConnection()
```
    初始化网络连接
  - urlWithParamIfGet
```
private void urlWithParamIfGet()
```
    对于GET请求将参数加到URL中
    此处不对URL中的特殊字符做单独编码
  - sendRedirectIfPossible
```
private HttpResponse sendRedirectIfPossible()
```
    调用转发，如果需要转发返回转发结果，否则返回null
    
    返回:
    
    HttpResponse，无转发返回 null
  - send
```
private void send()
           throws IORuntimeException
```
    发送数据流
    
    抛出:
    
    IORuntimeException - IO异常
  - sendFormUrlEncoded
```
private void sendFormUrlEncoded()
                         throws IOException
```
    发送普通表单
    发送数据后自动关闭输出流
    
    抛出:
    
    IOException - IO异常
  - getFormUrlEncoded
```
private String getFormUrlEncoded()
```
    获取编码后的表单数据，无表单数据返回""
    
    返回:
    
    编码后的表单数据，无表单数据返回""
    
    从以下版本开始:
    
    5.3.2
  - sendMultipart
```
private void sendMultipart()
                    throws IOException
```
    发送多组件请求（例如包含文件的表单）
    发送数据后自动关闭输出流
    
    抛出:
    
    IOException - IO异常
  - setMultipart
```
private void setMultipart()
```
    设置表单类型为Multipart（文件上传）
  - isIgnoreResponseBody
```
private boolean isIgnoreResponseBody()
```
    是否忽略读取响应body部分
    HEAD、CONNECT、OPTIONS、TRACE方法将不读取响应体
    
    返回:
    
    是否需要忽略响应body部分
    
    从以下版本开始:
    
    3.1.2
  - isMultipart
```
private boolean isMultipart()
```
    判断是否为multipart/form-data表单，条件如下：
```
     1. 存在资源对象（fileForm非空）
     2. 用户自定义头为multipart/form-data开头
 
```
    返回:
    
    是否为multipart/form-data表单
    
    从以下版本开始:
    
    5.3.5
  - putToForm
```
private HttpRequest putToForm(String name,
                              Object value)
```
    将参数加入到form中，如果form为空，新建之。
    
    参数:
    
    name - 表单属性名
    
    value - 属性值
    
    返回:
    
    this

类 HttpRequest

字段概要

从类继承的字段 cn.luues.tool.http.HttpBase

构造器概要

方法概要

从类继承的方法 cn.luues.tool.http.HttpBase

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

字段详细资料

CONTENT_TYPE_MULTIPART_PREFIX

CONTENT_TYPE_FILE_TEMPLATE

url

urlHandler

method

connectionTimeout

readTimeout

form

isMultiPart

cookie

httpConnection

httpclient

isDisableCache

isRest

redirectCount

maxRedirectCount

blockSize

proxy

hostnameVerifier

ssf

isStream

构造器详细资料

HttpRequest

HttpRequest

方法详细资料

setGlobalTimeout

getCookieManager

setCookieManager

closeCookie

post

postStream

get

head

options

put

patch

delete

trace

getUrl

setUrl

setUrl

setUrlHandler

getMethod

setMethod

getConnection

method

stream

contentType

keepAlive

isKeepAlive

contentLength

contentLength

cookie

cookie

cookie

disableCookie

enableDefaultCookie

form

form

form

form

form

form

form

form

form

fileForm

body

body

body

timeout

setConnectionTimeout