HttpRequest (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.http.message.Request
- - org.voovan.http.server.HttpRequest

```
public class HttpRequest
extends Request
```
WebServer 请求对象

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Nested Class Summary
- Nested classes/interfaces inherited from class org.voovan.http.message.Request
  Request.RequestType

Field Summary
- Fields inherited from class org.voovan.http.message.Request
  isSend

Constructor Summary

Constructors
Constructor and Description
`HttpRequest()` 构造函数
`HttpRequest(Request request, String characterSet, IoSession socketSession)` 构造函数
`HttpRequest(String characterSet, IoSession socketSession)` 构造函数

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` 清理
`HttpRequest`	`copyFrom(HttpRequest request)`
`HttpRequest`	`copyFrom(HttpRequest request, boolean useForSend)`
`void`	`flush()` 将数据发送到 Socket 缓存
`<T> T`	`getAllParameterAsObject(Class<T> clazz)` 将 HTTP 请求的所有参数, 转换成一个 Java 对象
`Map<String,Object>`	`getAttributes()` 获取请求属性.此属性是会话级的
`Object`	`getAttributes(String attrName)` 获取请求属性值
`String`	`getCharacterSet()` 获取当前默认字符集
`String`	`getParameter(String paramName)` 获取请求参数
`boolean`	`getParameterAsBoolean(String paramName)` 获取 boolean 类型的数据
`byte`	`getParameterAsByte(String paramName)` 获取 byte 类型的数据
`char`	`getParameterAsChar(String paramName)` 获取 char 类型的数据
`double`	`getParameterAsDouble(String paramName)` 获取 double 类型的数据
`float`	`getParameterAsFloat(String paramName)` 获取 float 类型的数据
`int`	`getParameterAsInt(String paramName)` 获取 int 类型的数据
`long`	`getParameterAsLong(String paramName)` 获取 long 类型的数据
`<T> T`	`getParameterAsObject(String paramName, Class<T> clazz)` 将 HTTP 请求的一个参数,使用 JSON 转换成一个 Java 对象
`short`	`getParameterAsShort(String paramName)` 获取 short 类型的数据
`List<String>`	`getParameterNames()` 获取请求参数名称集合
`Map<String,String>`	`getParameters()` 获取请求参数集合
`protected String`	`getQueryString()` 获取请求字符串
`String`	`getRemoteAddres()` 获取对端连接的 IP
`int`	`getRemotePort()` 获取对端连接的端口
`HttpSession`	`getSession()` 获取 Session
`protected SessionManager`	`getSessionManager()`
`IoSession`	`getSocketSession()` 获取 socket 会话对象
`void`	`init(Request request, String characterSet, IoSession socketSession)`
`void`	`redirect(String url)` 重置请求用于在 HttpFilter 中重新定向,其他地方无用
`void`	`saveUploadedFile(String name, File file)` 保存上传的文件
`void`	`saveUploadedFile(String name, String file)` 保存上传的文件
`void`	`send()` 发送响应
`int`	`send(ByteBuffer byteBuffer)` 追加形式发送数据
`boolean`	`sessionExists()` 判断 session 是否存在
`void`	`setAttributes(String attrName, Object attrValue)` 设置请求属性
`protected void`	`setCharacterSet(String charset)` 设置当前默认字符集
`protected void`	`setSession(HttpSession session)` 设置一个 Session
`protected void`	`setSessionManager(SessionManager sessionManager)`
`protected void`	`setSocketSession(IoSession socketSession)` 设置 socket 会话对象

Methods inherited from class org.voovan.http.message.Request
body, cookies, copyFrom, getBodyType, getCookie, getMark, getQueryString, header, init, isHasBody, parts, protocol, release, send, setHasBody, setMark, toString

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

- Constructor Detail
  - HttpRequest
```
public HttpRequest()
```
    构造函数
  - HttpRequest
```
public HttpRequest(Request request,
                   String characterSet,
                   IoSession socketSession)
```
    构造函数
    
    Parameters:
    
    request - 解析出的 Request 对象
    
    characterSet - 字符集
    
    socketSession - socket 会话对象
  - HttpRequest
```
public HttpRequest(String characterSet,
                   IoSession socketSession)
```
    构造函数
    
    Parameters:
    
    characterSet - 字符集
    
    socketSession - socket 会话对象
- Method Detail
  - init
```
public void init(Request request,
                 String characterSet,
                 IoSession socketSession)
```
  - getSessionManager
```
protected SessionManager getSessionManager()
```
  - setSessionManager
```
protected void setSessionManager(SessionManager sessionManager)
```
  - getSocketSession
```
public IoSession getSocketSession()
```
    获取 socket 会话对象
    
    Returns:
    
    socket 会话对象
  - setSocketSession
```
protected void setSocketSession(IoSession socketSession)
```
    设置 socket 会话对象
    
    Parameters:
    
    socketSession - socket 会话对象
  - sessionExists
```
public boolean sessionExists()
```
    判断 session 是否存在
    
    Returns:
    
    true: session 存在, false: session 不存在
  - getSession
```
public HttpSession getSession()
```
    获取 Session
    
    Returns:
    
    HTTP-Session 对象
  - setSession
```
protected void setSession(HttpSession session)
```
    设置一个 Session
    
    Parameters:
    
    session - HTTP-Session 对象
  - getRemoteAddres
```
public String getRemoteAddres()
```
    获取对端连接的 IP
    
    Returns:
    
    对端连接的 IP
  - getRemotePort
```
public int getRemotePort()
```
    获取对端连接的端口
    
    Returns:
    
    对端连接的端口
  - getCharacterSet
```
public String getCharacterSet()
```
    获取当前默认字符集
    
    Returns:
    
    字符集
  - setCharacterSet
```
protected void setCharacterSet(String charset)
```
    设置当前默认字符集
    
    Parameters:
    
    charset - 字符集
  - getQueryString
```
protected String getQueryString()
```
    获取请求字符串
    
    Returns:
    
    请求字符串
  - getParameters
```
public Map<String,String> getParameters()
```
    获取请求参数集合
    
    Returns:
    
    请求参数集合
  - getParameter
```
public String getParameter(String paramName)
```
    获取请求参数
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    请求参数值
  - getParameterAsInt
```
public int getParameterAsInt(String paramName)
```
    获取 int 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    int 类型的数据
  - getParameterAsFloat
```
public float getParameterAsFloat(String paramName)
```
    获取 float 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    float 类型的数据
  - getParameterAsLong
```
public long getParameterAsLong(String paramName)
```
    获取 long 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    long 类型的数据
  - getParameterAsShort
```
public short getParameterAsShort(String paramName)
```
    获取 short 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    short 类型的数据
  - getParameterAsDouble
```
public double getParameterAsDouble(String paramName)
```
    获取 double 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    double 类型的数据
  - getParameterAsBoolean
```
public boolean getParameterAsBoolean(String paramName)
```
    获取 boolean 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    boolean 类型的数据
  - getParameterAsByte
```
public byte getParameterAsByte(String paramName)
```
    获取 byte 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    byte 类型的数据
  - getParameterAsChar
```
public char getParameterAsChar(String paramName)
```
    获取 char 类型的数据
    
    Parameters:
    
    paramName - 请求参数名称
    
    Returns:
    
    char 类型的数据
  - getParameterAsObject
```
public <T> T getParameterAsObject(String paramName,
                                  Class<T> clazz)
```
    将 HTTP 请求的一个参数,使用 JSON 转换成一个 Java 对象
    
    Type Parameters:
    
    T - 范型
    
    Parameters:
    
    paramName - 参数名
    
    clazz - 自定义数据类型
    
    Returns:
    
    char 自定义数据类型的对象,转换时字段忽略大小写
  - getAllParameterAsObject
```
public <T> T getAllParameterAsObject(Class<T> clazz)
```
    将 HTTP 请求的所有参数, 转换成一个 Java 对象
    
    Type Parameters:
    
    T - 范型
    
    Parameters:
    
    clazz - 自定义数据类型
    
    Returns:
    
    char 自定义数据类型的对象,转换时字段忽略大小写
  - getParameterNames
```
public List<String> getParameterNames()
```
    获取请求参数名称集合
    
    Returns:
    
    请求参数集合
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    获取请求属性.此属性是会话级的
    
    Returns:
    
    返回请求属性
  - getAttributes
```
public Object getAttributes(String attrName)
```
    获取请求属性值
    
    Parameters:
    
    attrName - 请求属性名称
    
    Returns:
    
    请求属性值
  - setAttributes
```
public void setAttributes(String attrName,
                          Object attrValue)
```
    设置请求属性
    
    Parameters:
    
    attrName - 请求属性名称
    
    attrValue - 请求属性值
  - send
```
public void send()
          throws IOException
```
    发送响应
    
    Throws:
    
    IOException - IO 异常
  - send
```
public int send(ByteBuffer byteBuffer)
         throws IOException
```
    追加形式发送数据
    
    Parameters:
    
    byteBuffer - 发送的缓冲区
    
    Returns:
    
    发送的字节数
    
    Throws:
    
    IOException - IOException IO 异常
  - flush
```
public void flush()
```
    将数据发送到 Socket 缓存
  - saveUploadedFile
```
public void saveUploadedFile(String name,
                             File file)
                      throws IOException
```
    保存上传的文件
    
    Parameters:
    
    name - 提交的参数名
    
    file - 目标文件名
    
    Throws:
    
    IOException - IO 异常
  - saveUploadedFile
```
public void saveUploadedFile(String name,
                             String file)
                      throws IOException
```
    保存上传的文件
    
    Parameters:
    
    name - 提交的参数名
    
    file - 目标文件名
    
    Throws:
    
    IOException - IO 异常
  - redirect
```
public void redirect(String url)
```
    重置请求用于在 HttpFilter 中重新定向,其他地方无用
    
    Parameters:
    
    url - 请求地址,"/"起始,可以包含"?"参数引导及参数.
  - copyFrom
```
public HttpRequest copyFrom(HttpRequest request)
```
  - copyFrom
```
public HttpRequest copyFrom(HttpRequest request,
                            boolean useForSend)
```
  - clear
```
public void clear()
```
    Description copied from class: Request
    
    清理
    
    Overrides:
    
    clear in class Request

Class HttpRequest

Nested Class Summary

Nested classes/interfaces inherited from class org.voovan.http.message.Request

Field Summary

Fields inherited from class org.voovan.http.message.Request

Constructor Summary

Method Summary

Methods inherited from class org.voovan.http.message.Request

Methods inherited from class java.lang.Object

Constructor Detail

HttpRequest

HttpRequest

HttpRequest

Method Detail

init

getSessionManager

setSessionManager

getSocketSession

setSocketSession

sessionExists

getSession

setSession

getRemoteAddres

getRemotePort

getCharacterSet

setCharacterSet

getQueryString

getParameters

getParameter

getParameterAsInt

getParameterAsFloat

getParameterAsLong

getParameterAsShort

getParameterAsDouble

getParameterAsBoolean

getParameterAsByte

getParameterAsChar

getParameterAsObject

getAllParameterAsObject

getParameterNames

getAttributes

getAttributes

setAttributes

send

send

flush

saveUploadedFile

saveUploadedFile

redirect

copyFrom

copyFrom

clear