Request (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.http.client.Request

All Implemented Interfaces:

HeaderOperation<Request>
```
public class Request
extends Object
implements HeaderOperation<Request>
```
请求消息
请求消息用于定义请求所需的信息，如请求URL、请求方法、请求头、请求体等
此对象为无状态对象，与具体引擎不相关，因此可以复用。

Since:

6.0.0

Author:

looly

Constructor Summary

Constructors
Constructor and Description

Request()
默认构造

Constructors
Constructor and Description
`Request()` 默认构造

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Request`	`basicAuth(String username, String password)` 简单验证，生成的头信息类似于： Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
`HttpBody`	`body()` 获取请求体
`Request`	`body(HttpBody body)` 添加请求体
`Request`	`body(String body)` 添加字符串请求体
`byte[]`	`bodyBytes()` 获取请求体字节码
`String`	`bodyStr()` 获取请求体字符串
`InputStream`	`bodyStream()` 获取请求体资源流
`Charset`	`charset()` 获取请求编码，默认`DEFAULT_CHARSET`，一般用于：编码请求体服务端未返回编码时，使用此编码解码响应体
`Request`	`charset(Charset charset)` 设置自定义编码，一般用于：编码请求体服务端未返回编码时，使用此编码解码响应体
`Request`	`form(Map<String,Object> formMap)` 添加请求表单内容
`HttpBody`	`handledBody()` 获取处理过的请求体，即如果是非REST的GET请求，始终返回`null`
`UrlBuilder`	`handledUrl()` 获取处理后的请求URL，即如果为非REST的GET请求，将form类型的body拼接为URL的一部分
`Request`	`header(String name, String value, boolean isOverride)` 设置一个header 如果覆盖模式，则替换之前的值，否则加入到值列表中如果给定值为`null`，则删除这个头信息
`Map<String,? extends Collection<String>>`	`headers()` 获取headers
`Request`	`locationTo(String location)` 更新设置重定向后的URL，用于处理相对路径注意此方法会修改对象本身
`int`	`maxRedirects()` 获取最大重定向请求次数如果次数小于1则表示不重定向，大于等于1表示打开重定向。
`Method`	`method()` 获取Http请求方法
`Request`	`method(Method method)` 设置请求方法
`static Request`	`of(String url)` 构建一个HTTP请求，默认编解码规则，规则为：如果传入的URL已编码，则先解码，再按照RFC3986规范重新编码。
`static Request`	`of(String url, Charset decodeAndEncodeCharset)` 构建一个HTTP请求对于传入的URL，可以自定义是否解码已经编码的内容，规则如下：如果url已编码，则decodeAndEncodeCharset设置为`null`，此时URL不会解码，发送也不编码。
`static Request`	`of(UrlBuilder url)` 构建一个HTTP请求
`static Request`	`ofWithoutEncode(String url)` 构建一个HTTP请求，不解码和编码，此时要求用户传入的URL必须是已经编码过的。
`Response`	`send()` 发送请求
`Response`	`send(ClientEngine engine)` 发送请求
`Request`	`setEncodeUrl(boolean isEncodeUrl)` 设置是否编码URL
`Request`	`setMaxRedirects(int maxRedirects)` 设置最大重定向次数如果次数小于1则表示不重定向，大于等于1表示打开重定向
`Request`	`setRest(boolean isRest)` 设置是否rest模式 rest模式下get请求不会把参数附加到URL之后，而是作为body发送
`String`	`toString()`
`UrlBuilder`	`url()` 获取请求的URL
`Request`	`url(UrlBuilder url)` 设置URL

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

Methods inherited from interface org.dromara.hutool.http.client.HeaderOperation
auth, basicAuth, bearerAuth, contentEncoding, contentLength, contentType, cookie, cookie, cookie, disableCookie, enableDefaultCookie, header, header, header, header, header, header, header, isChunked, keepAlive, proxyAuth

- Constructor Detail
  - Request
```
public Request()
```
    默认构造
- Method Detail
  - ofWithoutEncode
```
public static Request ofWithoutEncode(String url)
```
    构建一个HTTP请求，不解码和编码，此时要求用户传入的URL必须是已经编码过的。
    
    Parameters:
    
    url - URL链接
    
    Returns:
    
    HttpRequest
  - of
```
public static Request of(String url)
```
    构建一个HTTP请求，默认编解码规则，规则为：
    - 如果传入的URL已编码，则先解码，再按照RFC3986规范重新编码。
    - 如果传入的URL未编码，则先解码（解码后不变），再按照RFC3986规范重新编码。
    - 如果传入的URL部分编码，则先解码编码过的部分，再按照RFC3986规范重新编码。
    如果服务端要求的URL编码规则不符合RFC3986，则需要先自行编码，再调用of(String, Charset)指定decodeAndEncodeCharset为null
    Parameters:
    
    url - URL链接，默认自动解码并重新编码URL中的参数等信息
    
    Returns:
    
    HttpRequest
  - of
```
public static Request of(String url,
                         Charset decodeAndEncodeCharset)
```
    构建一个HTTP请求
    对于传入的URL，可以自定义是否解码已经编码的内容，规则如下：
    - 如果url已编码，则decodeAndEncodeCharset设置为null，此时URL不会解码，发送也不编码。
    - 如果url未编码或部分编码，则需要设置decodeAndEncodeCharset，此时URL会解码编码后的参数，发送时按照RFC3986规范重新编码。
    - 如果url未编码，且存在歧义字符串，则需要设置decodeAndEncodeCharset为null，并调用setEncodeUrl(boolean)为true编码URL。
    Parameters:
    
    url - URL链接
    
    decodeAndEncodeCharset - 编码，如果为null不自动解码编码URL
    
    Returns:
    
    HttpRequest
  - of
```
public static Request of(UrlBuilder url)
```
    构建一个HTTP请求
    
    Parameters:
    
    url - UrlBuilder
    
    Returns:
    
    HttpRequest
  - method
```
public Method method()
```
    获取Http请求方法
    
    Returns:
    
    Method
    
    Since:
    
    4.1.8
  - method
```
public Request method(Method method)
```
    设置请求方法
    
    Parameters:
    
    method - HTTP方法
    
    Returns:
    
    HttpRequest
  - url
```
public UrlBuilder url()
```
    获取请求的URL
    
    Returns:
    
    URL
  - handledUrl
```
public UrlBuilder handledUrl()
```
    获取处理后的请求URL，即如果为非REST的GET请求，将form类型的body拼接为URL的一部分
    
    Returns:
    
    URL
  - url
```
public Request url(UrlBuilder url)
```
    设置URL
    
    Parameters:
    
    url - URL
    
    Returns:
    
    this
  - locationTo
```
public Request locationTo(String location)
```
    更新设置重定向后的URL，用于处理相对路径
    注意此方法会修改对象本身
    
    Parameters:
    
    location - 重定向后的URL
    
    Returns:
    
    this
  - charset
```
public Request charset(Charset charset)
```
    设置自定义编码，一般用于：
    - 编码请求体
    - 服务端未返回编码时，使用此编码解码响应体
    Parameters:
    
    charset - 编码
    
    Returns:
    
    this
  - charset
```
public Charset charset()
```
    获取请求编码，默认DEFAULT_CHARSET，一般用于：
    - 编码请求体
    - 服务端未返回编码时，使用此编码解码响应体
    Returns:
    
    编码
  - setEncodeUrl
```
public Request setEncodeUrl(boolean isEncodeUrl)
```
    设置是否编码URL
    
    Parameters:
    
    isEncodeUrl - 如果为true，则使用请求编码编码URL，false则不编码URL
    
    Returns:
    
    this
  - headers
```
public Map<String,? extends Collection<String>> headers()
```
    Description copied from interface: HeaderOperation
    
    获取headers
    
    Specified by:
    
    headers in interface HeaderOperation<Request>
    
    Returns:
    
    Headers Map
  - header
```
public Request header(String name,
                      String value,
                      boolean isOverride)
```
    设置一个header
    如果覆盖模式，则替换之前的值，否则加入到值列表中
    如果给定值为null，则删除这个头信息
    
    Specified by:
    
    header in interface HeaderOperation<Request>
    
    Parameters:
    
    name - Header名，null跳过
    
    value - Header值，null表示删除name对应的头
    
    isOverride - 是否覆盖已有值
    
    Returns:
    
    this
  - basicAuth
```
public Request basicAuth(String username,
                         String password)
```
    简单验证，生成的头信息类似于：
```
 Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l
 
```
    Parameters:
    
    username - 用户名
    
    password - 密码
    
    Returns:
    
    this
  - body
```
public HttpBody body()
```
    获取请求体
    
    Returns:
    
    请求体
  - bodyStr
```
public String bodyStr()
```
    获取请求体字符串
    
    Returns:
    
    请求体字符串
  - bodyBytes
```
public byte[] bodyBytes()
```
    获取请求体字节码
    
    Returns:
    
    请求体字节码
  - bodyStream
```
public InputStream bodyStream()
```
    获取请求体资源流
    
    Returns:
    
    请求体资源流
  - handledBody
```
public HttpBody handledBody()
```
    获取处理过的请求体，即如果是非REST的GET请求，始终返回null
    
    Returns:
    
    请求体
  - form
```
public Request form(Map<String,Object> formMap)
```
    添加请求表单内容
    
    Parameters:
    
    formMap - 表单内容
    
    Returns:
    
    this
  - body
```
public Request body(String body)
```
    添加字符串请求体
    
    Parameters:
    
    body - 请求体
    
    Returns:
    
    this
  - body
```
public Request body(HttpBody body)
```
    添加请求体
    
    Parameters:
    
    body - 请求体，可以是文本、表单、流、byte[] 或 Multipart
    
    Returns:
    
    this
  - maxRedirects
```
public int maxRedirects()
```
    获取最大重定向请求次数
    如果次数小于1则表示不重定向，大于等于1表示打开重定向。
    
    Returns:
    
    最大重定向请求次数
  - setMaxRedirects
```
public Request setMaxRedirects(int maxRedirects)
```
    设置最大重定向次数
    如果次数小于1则表示不重定向，大于等于1表示打开重定向
    
    Parameters:
    
    maxRedirects - 最大重定向次数
    
    Returns:
    
    this
  - setRest
```
public Request setRest(boolean isRest)
```
    设置是否rest模式
    rest模式下get请求不会把参数附加到URL之后，而是作为body发送
    
    Parameters:
    
    isRest - 是否rest模式
    
    Returns:
    
    this
  - send
```
public Response send()
```
    发送请求
    
    Returns:
    
    响应内容
  - send
```
public Response send(ClientEngine engine)
```
    发送请求
    
    Parameters:
    
    engine - 自自定义引擎
    
    Returns:
    
    响应内容
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Request

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.dromara.hutool.http.client.HeaderOperation

Constructor Detail

Request

Method Detail

ofWithoutEncode

of

of

of

method

method

url

handledUrl

url

locationTo

charset

charset

setEncodeUrl

headers

header

basicAuth

body

bodyStr

bodyBytes

bodyStream

handledBody

form

body

body

maxRedirects

setMaxRedirects

setRest

send

send

toString