HttpRequest (hutool-http 4.5.12 API)

java.lang.Object
- cn.hutool.http.HttpBase<HttpRequest>
- - cn.hutool.http.HttpRequest

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

作者:

Looly

字段概要

字段
限定符和类型字段和说明

protected static java.net.CookieManager cookieManager
Cookie管理

static int TIMEOUT_DEFAULT
默认超时时长，-1表示默认超时时长
- 从类继承的字段 cn.hutool.http.HttpBase
  bodyBytes, charset, headers, HTTP_1_0, HTTP_1_1, httpVersion

字段
限定符和类型	字段和说明
`protected static java.net.CookieManager`	`cookieManager` Cookie管理
`static int`	`TIMEOUT_DEFAULT` 默认超时时长，-1表示默认超时时长

构造器概要

构造器
构造器和说明

HttpRequest(java.lang.String url)
构造

构造器
构造器和说明
`HttpRequest(java.lang.String url)` 构造

方法概要

方法
限定符和类型	方法和说明
`HttpRequest`	`basicAuth(java.lang.String username, java.lang.String password)` 简单验证
`HttpRequest`	`body(byte[] bodyBytes)` 设置主体字节码需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
`HttpRequest`	`body(JSON json)` 设置JSON内容主体设置默认的Content-Type为 application/json 需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
`HttpRequest`	`body(java.lang.String body)` 设置内容主体
`HttpRequest`	`body(java.lang.String body, java.lang.String contentType)` 设置内容主体请求体body参数支持两种类型： 1.
`static void`	`closeCookie()` 关闭Cookie
`java.lang.String`	`contentLength()` 获取内容长度
`HttpRequest`	`contentLength(int value)` 设置内容长度
`HttpRequest`	`contentType(java.lang.String contentType)` 设置contentType
`HttpRequest`	`cookie(java.net.HttpCookie... cookies)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`HttpRequest`	`cookie(java.lang.String cookie)` 设置Cookie 自定义Cookie后会覆盖Hutool的默认Cookie行为
`static HttpRequest`	`delete(java.lang.String url)` DELETE请求
`HttpRequest`	`disableCache()` 禁用缓存
`HttpRequest`	`disableCookie()` 禁用默认Cookie行为，此方法调用后会将Cookie置为空。
`HttpRequest`	`enableDefaultCookie()` 打开默认的Cookie行为（自动回填服务器传回的Cookie）
`HttpResponse`	`execute()` 执行Reuqest请求
`HttpResponse`	`execute(boolean isAsync)` 执行Reuqest请求
`HttpResponse`	`executeAsync()` 异步请求异步请求后获取的`HttpResponse` 为异步模式，此时此对象持有Http链接（http链接并不会关闭），直调用获取内容方法为止
`java.util.Map<java.lang.String,Resource>`	`fileForm()` 获取文件表单数据
`java.util.Map<java.lang.String,java.lang.Object>`	`form()` 获取表单数据
`HttpRequest`	`form(java.util.Map<java.lang.String,java.lang.Object> formMap)` 设置map类型表单数据
`HttpRequest`	`form(java.lang.String name, byte[] fileBytes, java.lang.String fileName)` 文件byte[]表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(java.lang.String name, java.io.File... files)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(java.lang.String name, java.io.File file)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(java.lang.String name, java.io.File file, java.lang.String fileName)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`HttpRequest`	`form(java.lang.String name, java.lang.Object value)` 设置表单数据
`HttpRequest`	`form(java.lang.String name, java.lang.Object value, java.lang.Object... parameters)` 设置表单数据
`HttpRequest`	`form(java.lang.String name, Resource resource)` 文件表单项一旦有文件加入，表单变为multipart/form-data
`static HttpRequest`	`get(java.lang.String url)` GET请求
`HttpConnection`	`getConnection()` 获取`HttpConnection`
`static java.net.CookieManager`	`getCookieManager()` 获取Cookie管理器，用于自定义Cookie管理
`Method`	`getMethod()` 获取Http请求方法
`java.lang.String`	`getUrl()` 获取请求URL
`static HttpRequest`	`head(java.lang.String url)` HEAD请求
`boolean`	`isKeepAlive()`
`HttpRequest`	`keepAlive(boolean isKeepAlive)` 设置是否为长连接
`HttpRequest`	`method(Method method)` 设置请求方法
`static HttpRequest`	`options(java.lang.String url)` OPTIONS请求
`static HttpRequest`	`patch(java.lang.String url)` PATCH请求
`static HttpRequest`	`post(java.lang.String url)` POST请求
`static HttpRequest`	`put(java.lang.String url)` PUT请求
`HttpRequest`	`setConnectionTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`HttpRequest`	`setEncodeUrlParams(boolean isEncodeUrlParams)` 是否对URL中的参数进行编码
`HttpRequest`	`setFollowRedirects(boolean isFollowRedirects)` 设置是否打开重定向，如果打开默认重定向次数为2 此方法效果与`setMaxRedirectCount(int)` 一致
`HttpRequest`	`setHostnameVerifier(javax.net.ssl.HostnameVerifier hostnameVerifier)` 设置域名验证器只针对HTTPS请求，如果不设置，不做验证，所有域名被信任
`HttpRequest`	`setMaxRedirectCount(int maxRedirectCount)` 设置最大重定向次数如果次数小于1则表示不重定向，大于等于1表示打开重定向
`HttpRequest`	`setMethod(Method method)` 设置请求方法
`HttpRequest`	`setProxy(java.net.Proxy proxy)` 设置代理
`HttpRequest`	`setReadTimeout(int milliseconds)` 设置连接超时，单位：毫秒
`HttpRequest`	`setRest(boolean isRest)` 设置是否rest模式
`HttpRequest`	`setSSLProtocol(java.lang.String protocol)` 设置HTTPS安全连接协议，只针对HTTPS请求，可以使用的协议包括： 1.
`HttpRequest`	`setSSLSocketFactory(javax.net.ssl.SSLSocketFactory ssf)` 设置SSLSocketFactory 只针对HTTPS请求，如果不设置，使用默认的SSLSocketFactory 默认SSLSocketFactory为：SSLSocketFactoryBuilder.create().build();
`HttpRequest`	`setUrl(java.lang.String url)` 设置URL
`HttpRequest`	`setUrlHandler(java.net.URLStreamHandler urlHandler)` 设置`URLStreamHandler` 部分环境下需要单独设置此项，例如当 WebLogic Server 实例充当 SSL 客户端角色（它会尝试通过 SSL 连接到其他服务器或应用程序）时，它会验证 SSL 服务器在数字证书中返回的主机名是否与用于连接 SSL 服务器的 URL 主机名相匹配。
`HttpRequest`	`timeout(int milliseconds)` 设置超时，单位：毫秒超时包括： 1.
`static HttpRequest`	`trace(java.lang.String url)` TRACE请求

从类继承的方法 cn.hutool.http.HttpBase
addHeaders, charset, charset, charset, header, header, header, header, header, header, header, header, headerList, headers, httpVersion, httpVersion, removeHeader, removeHeader, toString

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

- 字段详细资料
  - TIMEOUT_DEFAULT
```
public static final int TIMEOUT_DEFAULT
```
    默认超时时长，-1表示默认超时时长
    
    另请参阅:
    常量字段值
  - cookieManager
```
protected static java.net.CookieManager cookieManager
```
    Cookie管理
- 构造器详细资料
  - HttpRequest
```
public HttpRequest(java.lang.String url)
```
    构造
    
    参数:
    url - URL
- 方法详细资料
  - getCookieManager
```
public static java.net.CookieManager getCookieManager()
```
    获取Cookie管理器，用于自定义Cookie管理
    
    返回:
    CookieManager
    从以下版本开始:
    
    4.1.0
  - closeCookie
```
public static void closeCookie()
```
    关闭Cookie
    
    从以下版本开始:
    
    4.1.9
  - post
```
public static HttpRequest post(java.lang.String url)
```
    POST请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - get
```
public static HttpRequest get(java.lang.String url)
```
    GET请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - head
```
public static HttpRequest head(java.lang.String url)
```
    HEAD请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - options
```
public static HttpRequest options(java.lang.String url)
```
    OPTIONS请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - put
```
public static HttpRequest put(java.lang.String url)
```
    PUT请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - patch
```
public static HttpRequest patch(java.lang.String url)
```
    PATCH请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
    从以下版本开始:
    
    3.0.9
  - delete
```
public static HttpRequest delete(java.lang.String url)
```
    DELETE请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - trace
```
public static HttpRequest trace(java.lang.String url)
```
    TRACE请求
    
    参数:
    url - URL
    
    返回:
    HttpRequest
  - getUrl
```
public java.lang.String getUrl()
```
    获取请求URL
    
    返回:
    URL字符串
    从以下版本开始:
    
    4.1.8
  - setUrl
```
public HttpRequest setUrl(java.lang.String url)
```
    设置URL
    
    参数:
    url - url字符串
    从以下版本开始:
    
    4.1.8
  - setUrlHandler
```
public HttpRequest setUrlHandler(java.net.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 - url字符串
    从以下版本开始:
    
    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
    
    返回:
    HttpConnection
    从以下版本开始:
    
    4.2.2
  - method
```
public HttpRequest method(Method method)
```
    设置请求方法
    
    参数:
    method - HTTP方法
    
    返回:
    HttpRequest
  - contentType
```
public HttpRequest contentType(java.lang.String contentType)
```
    设置contentType
    
    参数:
    contentType - contentType
    
    返回:
    HttpRequest
  - keepAlive
```
public HttpRequest keepAlive(boolean isKeepAlive)
```
    设置是否为长连接
    
    参数:
    isKeepAlive - 是否长连接
    
    返回:
    HttpRequest
  - isKeepAlive
```
public boolean isKeepAlive()
```
    返回:
    获取是否为长连接
  - contentLength
```
public java.lang.String contentLength()
```
    获取内容长度
    
    返回:
    String
  - contentLength
```
public HttpRequest contentLength(int value)
```
    设置内容长度
    
    参数:
    value - 长度
    
    返回:
    HttpRequest
  - cookie
```
public HttpRequest cookie(java.net.HttpCookie... cookies)
```
    设置Cookie
    自定义Cookie后会覆盖Hutool的默认Cookie行为
    
    参数:
    cookies - Cookie值数组，如果为null则设置无效，使用默认Cookie行为
    
    返回:
    this
    从以下版本开始:
    
    3.1.1
  - cookie
```
public HttpRequest cookie(java.lang.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(java.lang.String name,
               java.lang.Object value)
```
    设置表单数据
    
    参数:
    name - 名
    value - 值
    
    返回:
    this
  - form
```
public HttpRequest form(java.lang.String name,
               java.lang.Object value,
               java.lang.Object... parameters)
```
    设置表单数据
    
    参数:
    name - 名
    value - 值
    parameters - 参数对，奇数为名，偶数为值
    
    返回:
    this
  - form
```
public HttpRequest form(java.util.Map<java.lang.String,java.lang.Object> formMap)
```
    设置map类型表单数据
    
    参数:
    formMap - 表单内容
    
    返回:
    this
  - form
```
public HttpRequest form(java.lang.String name,
               java.io.File... files)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    name - 名
    files - 需要上传的文件
    
    返回:
    this
  - form
```
public HttpRequest form(java.lang.String name,
               java.io.File file)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    name - 名
    file - 需要上传的文件
    
    返回:
    this
  - form
```
public HttpRequest form(java.lang.String name,
               java.io.File file,
               java.lang.String fileName)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    name - 名
    file - 需要上传的文件
    fileName - 文件名，为空使用文件默认的文件名
    
    返回:
    this
  - form
```
public HttpRequest form(java.lang.String name,
               byte[] fileBytes,
               java.lang.String fileName)
```
    文件byte[]表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    name - 名
    fileBytes - 需要上传的文件
    fileName - 文件名
    
    返回:
    this
    从以下版本开始:
    
    4.1.0
  - form
```
public HttpRequest form(java.lang.String name,
               Resource resource)
```
    文件表单项
    一旦有文件加入，表单变为multipart/form-data
    
    参数:
    name - 名
    resource - 数据源，文件可以使用FileResource包装使用
    
    返回:
    this
    从以下版本开始:
    
    4.0.9
  - form
```
public java.util.Map<java.lang.String,java.lang.Object> form()
```
    获取表单数据
    
    返回:
    表单Map
  - fileForm
```
public java.util.Map<java.lang.String,Resource> fileForm()
```
    获取文件表单数据
    
    返回:
    文件表单Map
    从以下版本开始:
    
    3.3.0
  - body
```
public HttpRequest body(java.lang.String body)
```
    设置内容主体
    
    参数:
    body - 请求体
    
    返回:
    this
  - body
```
public HttpRequest body(java.lang.String body,
               java.lang.String contentType)
```
    设置内容主体
    请求体body参数支持两种类型：
```
 1. 标准参数，例如 a=1&b=2 这种格式
 2. Rest模式，此时body需要传入一个JSON或者XML字符串，Hutool会自动绑定其对应的Content-Type
 
```
    参数:
    body - 请求体
    contentType - 请求体类型，null表示自动判断类型
    
    返回:
    this
  - body
```
public HttpRequest body(JSON json)
```
    设置JSON内容主体
    设置默认的Content-Type为 application/json 需在此方法调用前使用charset方法设置编码，否则使用默认编码UTF-8
    
    参数:
    json - JSON请求体
    
    返回:
    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
```
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(javax.net.ssl.HostnameVerifier hostnameVerifier)
```
    设置域名验证器
    只针对HTTPS请求，如果不设置，不做验证，所有域名被信任
    
    参数:
    hostnameVerifier - HostnameVerifier
    
    返回:
    this
  - setProxy
```
public HttpRequest setProxy(java.net.Proxy proxy)
```
    设置代理
    
    参数:
    proxy - 代理 Proxy
    
    返回:
    this
  - setSSLSocketFactory
```
public HttpRequest setSSLSocketFactory(javax.net.ssl.SSLSocketFactory ssf)
```
    设置SSLSocketFactory
    只针对HTTPS请求，如果不设置，使用默认的SSLSocketFactory
    默认SSLSocketFactory为：SSLSocketFactoryBuilder.create().build();
    
    参数:
    ssf - SSLScketFactory
    
    返回:
    this
  - setSSLProtocol
```
public HttpRequest setSSLProtocol(java.lang.String protocol)
```
    设置HTTPS安全连接协议，只针对HTTPS请求，可以使用的协议包括：
```
 1. TLSv1.2
 2. TLSv1.1
 3. SSLv3
 ...
 
```
    参数:
    protocol - 协议
    
    返回:
    this
    另请参阅:
    SSLSocketFactoryBuilder
  - setRest
```
public HttpRequest setRest(boolean isRest)
```
    设置是否rest模式
    
    参数:
    isRest - 是否rest模式
    
    返回:
    this
    从以下版本开始:
    
    4.5.0
  - execute
```
public HttpResponse execute()
```
    执行Reuqest请求
    
    返回:
    this
  - executeAsync
```
public HttpResponse executeAsync()
```
    异步请求
    异步请求后获取的HttpResponse 为异步模式，此时此对象持有Http链接（http链接并不会关闭），直调用获取内容方法为止
    
    返回:
    异步对象，使用get方法获取HttpResponse对象
  - execute
```
public HttpResponse execute(boolean isAsync)
```
    执行Reuqest请求
    
    参数:
    isAsync - 是否异步
    
    返回:
    this
  - basicAuth
```
public HttpRequest basicAuth(java.lang.String username,
                    java.lang.String password)
```
    简单验证
    
    参数:
    username - 用户名
    password - 密码
    
    返回:
    HttpRequest

类 HttpRequest

字段概要

从类继承的字段 cn.hutool.http.HttpBase

构造器概要

方法概要

从类继承的方法 cn.hutool.http.HttpBase

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

字段详细资料

TIMEOUT_DEFAULT

cookieManager

构造器详细资料

HttpRequest

方法详细资料

getCookieManager

closeCookie

post

get

head

options

put

patch

delete

trace

getUrl

setUrl

setUrlHandler

getMethod

setMethod

getConnection

method

contentType

keepAlive

isKeepAlive

contentLength

contentLength

cookie

cookie

disableCookie

enableDefaultCookie

form

form

form

form

form

form

form

form

form

fileForm

body

body

body

body

timeout

setConnectionTimeout

setReadTimeout

disableCache

setEncodeUrlParams

setFollowRedirects

setMaxRedirectCount

setHostnameVerifier

setProxy

setSSLSocketFactory

setSSLProtocol

setRest

execute

executeAsync

execute

basicAuth