XRequest (xtools-common 1.3.1 API)

java.lang.Object
- me.xuxiaoxiao.xtools.common.http.executor.impl.XRequest

所有已实现的接口:

XHttpExecutor.Request
```
public final class XRequest
extends Object
implements XHttpExecutor.Request
```
HTTP请求类，记录了HTTP请求的请求方法，请求地址，请求头，请求体

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`XRequest.FileContent` 文件类型请求体
`static class`	`XRequest.MultipartContent` multipart类型请求体
`static class`	`XRequest.StringContent` 字符串类型请求体
`static class`	`XRequest.UrlencodedContent` urlencoded类型请求体

字段概要

字段
限定符和类型	字段和说明
`static String`	`CFG_REQ_CHARSET`
`static String`	`CFG_REQ_CHARSET_DEFAULT`
`static String`	`METHOD_DELETE`
`static String`	`METHOD_GET`
`static String`	`METHOD_POST`
`static String`	`METHOD_PUT`
`static String`	`MIME_JSON`
`static String`	`MIME_MULTIPART`
`static String`	`MIME_URLENCODED`
`static String`	`MIME_XML`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`XRequest`	`content(String key, Object value)` 添加值不为null的HTTP请求体参数，允许同名的请求体参数。
`XRequest`	`content(String key, Object value, boolean append)` 添加值不为null的HTTP请求体参数，可选择对同名的请求体参数的处理方式。
`XRequest`	`content(XHttpExecutor.Content content)` 添加自定义的HTTP请求体
`void`	`defaultCharset()`
`static XRequest`	`DELETE(String url)` 新建一个DELETE请求
`static XRequest`	`GET(String url)` 新建一个GET请求
`String`	`getCharset()`
`XHttpExecutor.Content`	`getContent()` 获得HTTP请求的请求体
`List<XHttpExecutor.KeyValue>`	`getHeaders()` 获得HTTP请求的请求头列表
`String`	`getMethod()` 获得HTTP请求的请求方法
`String`	`getUrl()` 获得HTTP请求的请求url，如果有请求地址参数则自动拼接成带参数的url
`XRequest`	`header(String key, String value)` 添加值不为null的HTTP请求头，允许同名的请求头
`XRequest`	`header(String key, String value, boolean append)` 添加值不为null的HTTP请求头，可选择对于同名的请求头的处理方式
`static XRequest`	`POST(String url)` 新建一个POST请求
`static XRequest`	`PUT(String url)` 新建一个PUT请求
`XRequest`	`query(String key, Object value)` 添加值不为null的HTTP请求地址参数，允许同名的请求地址参数
`XRequest`	`query(String key, Object value, boolean append)` 添加值不为null的HTTP请求地址参数，可选择对于同名的请求地址参数的处理方式
`void`	`setCharset(String charset)`
`void`	`setContent(XHttpExecutor.Content content)` 设置请求体
`void`	`setHeader(String key, String value, boolean append)` 设置请求头部
`void`	`setMethod(String method)` 设置请求方法
`void`	`setUrl(String url)` 设置请求url

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

- 字段详细资料
  - CFG_REQ_CHARSET
```
public static final String CFG_REQ_CHARSET
```
    另请参阅:
    
    常量字段值
  - CFG_REQ_CHARSET_DEFAULT
```
public static final String CFG_REQ_CHARSET_DEFAULT
```
    另请参阅:
    
    常量字段值
  - MIME_URLENCODED
```
public static final String MIME_URLENCODED
```
    另请参阅:
    
    常量字段值
  - MIME_MULTIPART
```
public static final String MIME_MULTIPART
```
    另请参阅:
    
    常量字段值
  - MIME_JSON
```
public static final String MIME_JSON
```
    另请参阅:
    
    常量字段值
  - MIME_XML
```
public static final String MIME_XML
```
    另请参阅:
    
    常量字段值
  - METHOD_GET
```
public static final String METHOD_GET
```
    另请参阅:
    
    常量字段值
  - METHOD_POST
```
public static final String METHOD_POST
```
    另请参阅:
    
    常量字段值
  - METHOD_PUT
```
public static final String METHOD_PUT
```
    另请参阅:
    
    常量字段值
  - METHOD_DELETE
```
public static final String METHOD_DELETE
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - GET
```
public static XRequest GET(String url)
```
    新建一个GET请求
    
    参数:
    
    url - 请求url
    
    返回:
    
    GET请求
  - POST
```
public static XRequest POST(String url)
```
    新建一个POST请求
    
    参数:
    
    url - 请求url
    
    返回:
    
    POST请求
  - PUT
```
public static XRequest PUT(String url)
```
    新建一个PUT请求
    
    参数:
    
    url - 请求url
    
    返回:
    
    PUT请求
  - DELETE
```
public static XRequest DELETE(String url)
```
    新建一个DELETE请求
    
    参数:
    
    url - 请求url
    
    返回:
    
    DELETE请求
  - defaultCharset
```
public void defaultCharset()
```
  - setCharset
```
public void setCharset(String charset)
```
  - getCharset
```
public String getCharset()
```
  - query
```
public XRequest query(String key,
                      Object value)
```
    添加值不为null的HTTP请求地址参数，允许同名的请求地址参数
    
    参数:
    
    key - 请求地址参数名称
    
    value - 请求地址参数值，为null则不会被添加
    
    返回:
    
    HTTP请求实例
  - query
```
public XRequest query(String key,
                      Object value,
                      boolean append)
```
    添加值不为null的HTTP请求地址参数，可选择对于同名的请求地址参数的处理方式
    
    参数:
    
    key - 请求地址参数名称
    
    value - 请求地址参数值，为null则不会被添加
    
    append - true：清除已经存在的同名的请求地址参数，false：追加同名的请求地址参数
    
    返回:
    
    HTTP请求实例
  - header
```
public XRequest header(String key,
                       String value)
```
    添加值不为null的HTTP请求头，允许同名的请求头
    
    参数:
    
    key - 请求头名称
    
    value - 请求头值，为null则不会被添加
    
    返回:
    
    HTTP请求实例
  - header
```
public XRequest header(String key,
                       String value,
                       boolean append)
```
    添加值不为null的HTTP请求头，可选择对于同名的请求头的处理方式
    
    参数:
    
    key - 请求头名称
    
    value - 请求头值，为null则不会被添加
    
    append - true：清除已经存在的同名的请求头，false：追加同名的请求头
    
    返回:
    
    HTTP请求实例
  - content
```
public XRequest content(String key,
                        Object value)
```
    添加值不为null的HTTP请求体参数，允许同名的请求体参数。如果有文件参数，则会使用multipart请求体，否则使用urlencoded请求体
    
    参数:
    
    key - 请求体参数名
    
    value - 请求体参数值，为null则不会被添加
    
    返回:
    
    HTTP请求实例
  - content
```
public XRequest content(String key,
                        Object value,
                        boolean append)
```
    添加值不为null的HTTP请求体参数，可选择对同名的请求体参数的处理方式。如果有文件参数，则会使用multipart请求体，否则使用urlencoded请求体
    
    参数:
    
    key - 请求体参数名
    
    value - 请求体参数值，为null则不会被添加
    
    append - true：清除已经存在的同名的请求体参数，false：追加同名请求体参数
    
    返回:
    
    HTTP请求实例
  - content
```
public XRequest content(XHttpExecutor.Content content)
```
    添加自定义的HTTP请求体
    
    参数:
    
    content - 自定义的HTTP请求体
    
    返回:
    
    HTTP请求实例
  - setMethod
```
public void setMethod(String method)
```
    从接口复制的说明: XHttpExecutor.Request
    
    设置请求方法
    
    指定者:
    
    setMethod 在接口中 XHttpExecutor.Request
    
    参数:
    
    method - 请求方法
  - getMethod
```
public String getMethod()
```
    获得HTTP请求的请求方法
    
    指定者:
    
    getMethod 在接口中 XHttpExecutor.Request
    
    返回:
    
    HTTP请求的请求方法
  - setUrl
```
public void setUrl(String url)
```
    从接口复制的说明: XHttpExecutor.Request
    
    设置请求url
    
    指定者:
    
    setUrl 在接口中 XHttpExecutor.Request
    
    参数:
    
    url - 请求url
  - getUrl
```
public String getUrl()
```
    获得HTTP请求的请求url，如果有请求地址参数则自动拼接成带参数的url
    
    指定者:
    
    getUrl 在接口中 XHttpExecutor.Request
    
    返回:
    
    HTTP请求的请求url
  - setHeader
```
public void setHeader(String key,
                      String value,
                      boolean append)
```
    从接口复制的说明: XHttpExecutor.Request
    
    设置请求头部
    
    指定者:
    
    setHeader 在接口中 XHttpExecutor.Request
    
    参数:
    
    key - 请求头键
    
    value - 请求头值
    
    append - 重复请求头是否追加
  - getHeaders
```
public List<XHttpExecutor.KeyValue> getHeaders()
```
    获得HTTP请求的请求头列表
    
    指定者:
    
    getHeaders 在接口中 XHttpExecutor.Request
    
    返回:
    
    HTTP请求的请求头列表
  - setContent
```
public void setContent(XHttpExecutor.Content content)
```
    从接口复制的说明: XHttpExecutor.Request
    
    设置请求体
    
    指定者:
    
    setContent 在接口中 XHttpExecutor.Request
    
    参数:
    
    content - 请求体
  - getContent
```
public XHttpExecutor.Content getContent()
```
    获得HTTP请求的请求体
    
    指定者:
    
    getContent 在接口中 XHttpExecutor.Request
    
    返回:
    
    HTTP请求的请求体

类 XRequest

嵌套类概要

字段概要

方法概要

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

字段详细资料

CFG_REQ_CHARSET

CFG_REQ_CHARSET_DEFAULT

MIME_URLENCODED

MIME_MULTIPART

MIME_JSON

MIME_XML

METHOD_GET

METHOD_POST

METHOD_PUT

METHOD_DELETE

方法详细资料

GET

POST

PUT

DELETE

defaultCharset

setCharset

getCharset

query

query

header

header

content

content

content

setMethod

getMethod

setUrl

getUrl

setHeader

getHeaders

setContent

getContent