HttpRequest (Redkale 1.9.6 API)

java.lang.Object
- org.redkale.net.Request<HttpContext>
- - org.redkale.net.http.HttpRequest

```
public class HttpRequest
extends Request<HttpContext>
```
Http请求包与javax.servlet.http.HttpServletRequest 基本类似。
同时提供json的解析接口: public Object getJsonParameter(Type type, String name)
Redkale提倡带简单的参数的GET请求采用类似REST风格, 因此提供了 getRequstURIPath 系列接口。
例如简单的翻页查询
/pipes/record/query/offset:0/limit:20
获取页号: int offset = request.getRequstURIPath("offset:", 0);
获取行数: int limit = request.getRequstURIPath("limit:", 10);

详情见: https://redkale.org

作者:

zhangjx

字段概要

字段
限定符和类型	字段和说明
`protected int`	`actionid`
`protected boolean`	`boundary`
`protected String`	`cookie`
`protected Object`	`currentUser`
`protected AnyValue.DefaultAnyValue`	`header`
`protected int`	`moduleid`
`protected String`	`newsessionid`
`protected AnyValue.DefaultAnyValue`	`params`
`protected String`	`requestURI`
`static String`	`SESSIONID_NAME`

从类继承的字段 org.redkale.net.Request
attributes, bsonConvert, channel, context, createtime, jsonConvert, keepAlive, more, moredata, readBuffer

构造器概要

构造器
构造器和说明

HttpRequest(HttpContext context, String remoteAddrHeader)

构造器
构造器和说明
`HttpRequest(HttpContext context, String remoteAddrHeader)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`String`	`changeSessionid()` 更新sessionid
`String`	`changeSessionid(String newsessionid)` 指定值更新sessionid
`<T> T`	`currentUser()` 获取当前用户信息数据类型由@HttpUserType指定
`int`	`getActionid()` 获取操作ID，来自@HttpMapping.actionid()
`byte[]`	`getBody()` 获取请求内容的byte[]
`String`	`getBody(Charset charset)` 获取请求内容指定的编码字符串
`<T> T`	`getBodyJson(JsonConvert convert, Type type)` 获取请求内容的JavaBean对象
`<T> T`	`getBodyJson(Type type)` 获取请求内容的JavaBean对象
`String`	`getBodyUTF8()` 获取请求内容的UTF-8编码字符串
`boolean`	`getBooleanHeader(String name, boolean defaultValue)` 获取指定的header的boolean值, 没有返回默认boolean值
`boolean`	`getBooleanParameter(String name, boolean defaultValue)` 获取指定的参数boolean值, 没有返回默认boolean值
`protected AsyncConnection`	`getChannel()`
`String`	`getConnection()` 获取Connection的Header值
`long`	`getContentLength()` 获取请求内容的长度, 为-1表示内容长度不确定
`String`	`getContentType()` 获取Content-Type的header值
`String`	`getCookie(String name)` 获取Cookie值
`String`	`getCookie(String name, String dfvalue)` 获取Cookie值，没有返回默认值
`HttpCookie[]`	`getCookies()` 获取所有Cookie对象
`protected ByteArray`	`getDirectBody()` 直接获取body对象
`double`	`getDoubleHeader(String name, double defaultValue)` 获取指定的header的double值, 没有返回默认double值
`double`	`getDoubleParameter(String name, double defaultValue)` 获取指定的参数double值, 没有返回默认double值
`Flipper`	`getFlipper()` 获取翻页对象同 getFlipper("flipper", false, 0);
`Flipper`	`getFlipper(boolean needcreate)` 获取翻页对象同 getFlipper("flipper", needcreate, 0);
`Flipper`	`getFlipper(boolean needcreate, int maxLimit)` 获取翻页对象同 getFlipper("flipper", needcreate, maxLimit)
`Flipper`	`getFlipper(int maxLimit)` 获取翻页对象同 getFlipper("flipper", false, maxLimit);
`Flipper`	`getFlipper(String name, boolean needcreate, int maxLimit)` 获取翻页对象 https://redkale.org/pipes/records/list/offset:0/limit:20/sort:createtime%20ASC https://redkale.org/pipes/records/list?
`float`	`getFloatHeader(String name, float defaultValue)` 获取指定的header的float值, 没有返回默认float值
`float`	`getFloatParameter(String name, float defaultValue)` 获取指定的参数float值, 没有返回默认float值
`String`	`getHeader(String name)` 获取指定的header值
`String`	`getHeader(String name, String defaultValue)` 获取指定的header值, 没有返回默认值
`String[]`	`getHeaderNames()` 获取所有的header名
`AnyValue`	`getHeaders()` 获取请求Header总对象
`Map<String,String>`	`getHeadersToMap(Map<String,String> map)` 将请求Header转换成Map
`String`	`getHost()` 获取Host的Header值
`int`	`getIntHeader(int radix, String name, int defaultValue)` 获取指定的header的int值, 没有返回默认int值
`int`	`getIntHeader(String name, int defaultValue)` 获取指定的header的int值, 没有返回默认int值
`int`	`getIntParameter(int radix, String name, int defaultValue)` 获取指定的参数int值, 没有返回默认int值
`int`	`getIntParameter(String name, int defaultValue)` 获取指定的参数int值, 没有返回默认int值
`protected JsonConvert`	`getJsonConvert()`
`<T> T`	`getJsonHeader(JsonConvert convert, Type type, String name)` 获取指定的header的json值
`<T> T`	`getJsonHeader(Type type, String name)` 获取指定的header的json值
`<T> T`	`getJsonParameter(JsonConvert convert, Type type, String name)` 获取指定的参数json值
`<T> T`	`getJsonParameter(Type type, String name)` 获取指定的参数json值
`long`	`getLongHeader(int radix, String name, long defaultValue)` 获取指定的header的long值, 没有返回默认long值
`long`	`getLongHeader(String name, long defaultValue)` 获取指定的header的long值, 没有返回默认long值
`long`	`getLongParameter(int radix, String name, long defaultValue)` 获取指定的参数long值, 没有返回默认long值
`long`	`getLongParameter(String name, long defaultValue)` 获取指定的参数long值, 没有返回默认long值
`String`	`getMethod()` 获取请求方法 GET、POST等
`int`	`getModuleid()` 获取模块ID，来自@HttpServlet.moduleid()
`MultiContext`	`getMultiContext()` 获取文件上传对象
`String`	`getParameter(String name)` 获取指定的参数值
`String`	`getParameter(String name, String defaultValue)` 获取指定的参数值, 没有返回默认值
`String[]`	`getParameterNames()` 获取所有参数名
`AnyValue`	`getParameters()` 获取请求参数总对象
`Map<String,String>`	`getParametersToMap(Map<String,String> map)` 将请求参数转换成Map
`String`	`getParametersToString()` 将请求参数转换成String, 字符串格式为: bean1={}&id=13&name=xxx 不会返回null，没有参数返回空字符串
`String`	`getParametersToString(String prefix)` 将请求参数转换成String, 字符串格式为: bean1={}&id=13&name=xxx 不会返回null，没有参数返回空字符串
`protected <T> T`	`getProperty(String name)`
`String`	`getProtocol()` 获取协议名 http、https、ws、wss等
`String`	`getRemoteAddr()` 获取客户端地址IP, 与getRemoteAddress() 的区别在于：本方法优先取header中指定为RemoteAddress名的值，没有则返回getRemoteAddress()的getHostAddress()。
`SocketAddress`	`getRemoteAddress()` 获取客户端地址IP
`String`	`getRequestURI()` 获取请求的URL
`String`	`getRequstURILastPath()` 截取getRequestURI最后的一个/后面的部分
`double`	`getRequstURILastPath(double defvalue)` 获取请求URL最后的一个/后面的部分的double值例如请求URL /pipes/record/query/2 获取type参数: double type = request.getRequstURILastPath(0.0); //type = 2.0
`float`	`getRequstURILastPath(float defvalue)` 获取请求URL最后的一个/后面的部分的float值例如请求URL /pipes/record/query/2 获取type参数: float type = request.getRequstURILastPath(0.0f); //type = 2.0f
`int`	`getRequstURILastPath(int defvalue)` 获取请求URL最后的一个/后面的部分的int值例如请求URL /pipes/record/query/2 获取type参数: int type = request.getRequstURILastPath(0); //type = 2
`int`	`getRequstURILastPath(int radix, int defvalue)` 获取请求URL最后的一个/后面的部分的int值例如请求URL /pipes/record/query/2 获取type参数: int type = request.getRequstURILastPath(16, 0); //type = 2
`long`	`getRequstURILastPath(int radix, long defvalue)` 获取请求URL最后的一个/后面的部分的int值例如请求URL /pipes/record/query/2 获取type参数: long type = request.getRequstURILastPath(16, 0L); //type = 2
`short`	`getRequstURILastPath(int radix, short defvalue)` 获取请求URL最后的一个/后面的部分的short值例如请求URL /pipes/record/query/2 获取type参数: short type = request.getRequstURILastPath(16, (short)0); //type = 2
`long`	`getRequstURILastPath(long defvalue)` 获取请求URL最后的一个/后面的部分的int值例如请求URL /pipes/record/query/2 获取type参数: long type = request.getRequstURILastPath(0L); //type = 2
`short`	`getRequstURILastPath(short defvalue)` 获取请求URL最后的一个/后面的部分的short值例如请求URL /pipes/record/query/2 获取type参数: short type = request.getRequstURILastPath((short)0); //type = 2
`int`	`getRequstURIPath(int radix, String prefix, int defvalue)` 获取请求URL分段中含prefix段的int值例如请求URL /pipes/record/query/offset:0/limit:50 获取offset参数: int offset = request.getRequstURIPath("offset:", 0); 获取limit参数: int limit = request.getRequstURIPath(16, "limit:", 20); // limit = 16
`long`	`getRequstURIPath(int radix, String prefix, long defvalue)` 获取请求URL分段中含prefix段的long值例如请求URL /pipes/record/query/time:1453104341363/id:40 获取time参数: long time = request.getRequstURIPath(16, "time:", 0L);
`short`	`getRequstURIPath(int radix, String prefix, short defvalue)` 获取请求URL分段中含prefix段的short值例如请求URL /pipes/record/query/type:a 获取type参数: short type = request.getRequstURIPath(16, "type:", (short)0); //type = 10
`double`	`getRequstURIPath(String prefix, double defvalue)` 获取请求URL分段中含prefix段的double值例如请求URL /pipes/record/query/point:40.0 获取time参数: double point = request.getRequstURIPath("point:", 0.0);
`float`	`getRequstURIPath(String prefix, float defvalue)` 获取请求URL分段中含prefix段的float值例如请求URL /pipes/record/query/point:40.0 获取time参数: float point = request.getRequstURIPath("point:", 0.0f);
`int`	`getRequstURIPath(String prefix, int defvalue)` 获取请求URL分段中含prefix段的int值例如请求URL /pipes/record/query/offset:0/limit:50 获取offset参数: int offset = request.getRequstURIPath("offset:", 0); 获取limit参数: int limit = request.getRequstURIPath("limit:", 20);
`long`	`getRequstURIPath(String prefix, long defvalue)` 获取请求URL分段中含prefix段的long值例如请求URL /pipes/record/query/time:1453104341363/id:40 获取time参数: long time = request.getRequstURIPath("time:", 0L);
`short`	`getRequstURIPath(String prefix, short defvalue)` 获取请求URL分段中含prefix段的short值例如请求URL /pipes/record/query/type:10 获取type参数: short type = request.getRequstURIPath("type:", (short)0);
`String`	`getRequstURIPath(String prefix, String defvalue)` 获取请求URL分段中含prefix段的值例如请求URL /pipes/record/query/name:hello 获取name参数: String name = request.getRequstURIPath("name:", "none");
`String[]`	`getRequstURIPaths(String prefix)` 从prefix之后截取getRequestURI再对"/"进行分隔
`String`	`getSessionid(boolean create)` 获取sessionid
`short`	`getShortHeader(int radix, String name, int defaultValue)` 获取指定的header的short值, 没有返回默认short值
`short`	`getShortHeader(int radix, String name, short defaultValue)` 获取指定的header的short值, 没有返回默认short值
`short`	`getShortHeader(String name, int defaultValue)` 获取指定的header的short值, 没有返回默认short值
`short`	`getShortHeader(String name, short defaultValue)` 获取指定的header的short值, 没有返回默认short值
`short`	`getShortParameter(int radix, String name, short defaultValue)` 获取指定的参数short值, 没有返回默认short值
`short`	`getShortParameter(String name, int defaultValue)` 获取指定的参数short值, 没有返回默认short值
`short`	`getShortParameter(String name, short defaultValue)` 获取指定的参数short值, 没有返回默认short值
`void`	`invalidateSession()` 使sessionid失效
`protected boolean`	`isKeepAlive()`
`protected boolean`	`isWebSocket()`
`Iterable<MultiPart>`	`multiParts()` 获取文件上传信息列表
`protected void`	`prepare()`
`protected int`	`readBody(ByteBuffer buffer)` 读取buffer，并返回读取的有效数据长度
`protected int`	`readHeader(ByteBuffer buffer)` 返回值：Integer.MIN_VALUE: 帧数据； -1：数据不合法； 0：解析完毕； >0: 需再读取的字节数。
`protected void`	`recycle()`
`protected <T> T`	`removeProperty(String name)`
`<T> HttpRequest`	`setCurrentUser(T user)` 设置当前用户信息, 通常在HttpServlet.preExecute方法里设置currentUser 数据类型由@HttpUserType指定
`protected void`	`setKeepAlive(boolean keepAlive)`
`protected <T> T`	`setProperty(String name, T value)`
`protected void`	`skipBodyParse()`
`String`	`toString()`

从类继承的方法 org.redkale.net.Request
getAttribute, getAttributes, getContext, getCreatetime, getProperties, offerReadBuffer, pollReadBuffer, removeAttribute, removeMoredata, setAttribute, setMoredata

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

- 字段详细资料
  - SESSIONID_NAME
```
public static final String SESSIONID_NAME
```
    另请参阅:
    
    常量字段值
  - requestURI
```
protected String requestURI
```
  - cookie
```
@Comment(value="\u539f\u59cb\u7684cookie\u5b57\u7b26\u4e32\uff0c\u89e3\u6790\u540e\u503c\u8d4b\u7ed9HttpCookie[] cookies")
protected String cookie
```
  - newsessionid
```
protected String newsessionid
```
  - header
```
protected final AnyValue.DefaultAnyValue header
```
  - params
```
protected final AnyValue.DefaultAnyValue params
```
  - boundary
```
protected boolean boundary
```
  - moduleid
```
protected int moduleid
```
  - actionid
```
protected int actionid
```
  - currentUser
```
protected Object currentUser
```
- 构造器详细资料
  - HttpRequest
```
public HttpRequest(HttpContext context,
                   String remoteAddrHeader)
```
- 方法详细资料
  - isWebSocket
```
protected boolean isWebSocket()
```
  - setKeepAlive
```
protected void setKeepAlive(boolean keepAlive)
```
  - isKeepAlive
```
protected boolean isKeepAlive()
```
  - getChannel
```
protected AsyncConnection getChannel()
```
  - getJsonConvert
```
protected JsonConvert getJsonConvert()
```
  - readHeader
```
protected int readHeader(ByteBuffer buffer)
```
    从类复制的说明: Request
    
    返回值：Integer.MIN_VALUE: 帧数据； -1：数据不合法； 0：解析完毕； >0: 需再读取的字节数。
    
    指定者:
    
    readHeader 在类中 Request<HttpContext>
    
    参数:
    
    buffer - ByteBuffer对象
    
    返回:
    
    缺少的字节数
  - readBody
```
protected int readBody(ByteBuffer buffer)
```
    从类复制的说明: Request
    
    读取buffer，并返回读取的有效数据长度
    
    指定者:
    
    readBody 在类中 Request<HttpContext>
    
    参数:
    
    buffer - ByteBuffer对象
    
    返回:
    
    有效数据长度
  - prepare
```
protected void prepare()
```
    指定者:
    
    prepare 在类中 Request<HttpContext>
  - skipBodyParse
```
protected void skipBodyParse()
```
  - setProperty
```
protected <T> T setProperty(String name,
                            T value)
```
    覆盖:
    
    setProperty 在类中 Request<HttpContext>
  - getProperty
```
protected <T> T getProperty(String name)
```
    覆盖:
    
    getProperty 在类中 Request<HttpContext>
  - removeProperty
```
protected <T> T removeProperty(String name)
```
    覆盖:
    
    removeProperty 在类中 Request<HttpContext>
  - setCurrentUser
```
public <T> HttpRequest setCurrentUser(T user)
```
    设置当前用户信息, 通常在HttpServlet.preExecute方法里设置currentUser
    数据类型由@HttpUserType指定
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    user - 用户信息
    
    返回:
    
    HttpRequest
  - currentUser
```
public <T> T currentUser()
```
    获取当前用户信息
    数据类型由@HttpUserType指定
    
    类型参数:
    
    T - @HttpUserType指定的用户信息类型
    
    返回:
    
    用户信息
  - getModuleid
```
public int getModuleid()
```
    获取模块ID，来自@HttpServlet.moduleid()
    
    返回:
    
    模块ID
  - getActionid
```
public int getActionid()
```
    获取操作ID，来自@HttpMapping.actionid()
    
    返回:
    
    模块ID
  - getRemoteAddress
```
public SocketAddress getRemoteAddress()
```
    获取客户端地址IP
    
    返回:
    
    地址
  - getRemoteAddr
```
public String getRemoteAddr()
```
    获取客户端地址IP, 与getRemoteAddress() 的区别在于：本方法优先取header中指定为RemoteAddress名的值，没有则返回getRemoteAddress()的getHostAddress()。
    本方法适用于服务前端有如nginx的代理服务器进行中转，通过 getRemoteAddress()是获取不到客户端的真实IP。
    
    返回:
    
    地址
  - getBody
```
public String getBody(Charset charset)
```
    获取请求内容指定的编码字符串
    
    参数:
    
    charset - 编码
    
    返回:
    
    内容
  - getBodyUTF8
```
public String getBodyUTF8()
```
    获取请求内容的UTF-8编码字符串
    
    返回:
    
    内容
  - getBodyJson
```
public <T> T getBodyJson(Type type)
```
    获取请求内容的JavaBean对象
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    type - 类型
    
    返回:
    
    内容
  - getBodyJson
```
public <T> T getBodyJson(JsonConvert convert,
                         Type type)
```
    获取请求内容的JavaBean对象
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    convert - JsonConvert
    
    type - 类型
    
    返回:
    
    内容
  - getBody
```
public byte[] getBody()
```
    获取请求内容的byte[]
    
    返回:
    
    内容
  - getDirectBody
```
protected ByteArray getDirectBody()
```
    直接获取body对象
    
    返回:
    
    body对象
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - getMultiContext
```
public final MultiContext getMultiContext()
```
    获取文件上传对象
    
    返回:
    
    文件上传对象
  - multiParts
```
public final Iterable<MultiPart> multiParts()
                                     throws IOException
```
    获取文件上传信息列表
    
    返回:
    
    文件上传对象集合
    
    抛出:
    
    IOException - IO异常
  - recycle
```
protected void recycle()
```
    覆盖:
    
    recycle 在类中 Request<HttpContext>
  - getSessionid
```
public String getSessionid(boolean create)
```
    获取sessionid
    
    参数:
    
    create - 无sessionid是否自动创建
    
    返回:
    
    sessionid
  - changeSessionid
```
public String changeSessionid()
```
    更新sessionid
    
    返回:
    
    新的sessionid值
  - changeSessionid
```
public String changeSessionid(String newsessionid)
```
    指定值更新sessionid
    
    参数:
    
    newsessionid - 新sessionid值
    
    返回:
    
    新的sessionid值
  - invalidateSession
```
public void invalidateSession()
```
    使sessionid失效
  - getCookies
```
public HttpCookie[] getCookies()
```
    获取所有Cookie对象
    
    返回:
    
    cookie对象数组
  - getCookie
```
public String getCookie(String name)
```
    获取Cookie值
    
    参数:
    
    name - cookie名
    
    返回:
    
    cookie值
  - getCookie
```
public String getCookie(String name,
                        String dfvalue)
```
    获取Cookie值，没有返回默认值
    
    参数:
    
    name - cookie名
    
    dfvalue - 默认cookie值
    
    返回:
    
    cookie值
  - getProtocol
```
public String getProtocol()
```
    获取协议名 http、https、ws、wss等
    
    返回:
    
    protocol
  - getMethod
```
public String getMethod()
```
    获取请求方法 GET、POST等
    
    返回:
    
    method
  - getContentType
```
public String getContentType()
```
    获取Content-Type的header值
    
    返回:
    
    contentType
  - getContentLength
```
public long getContentLength()
```
    获取请求内容的长度, 为-1表示内容长度不确定
    
    返回:
    
    内容长度
  - getConnection
```
public String getConnection()
```
    获取Connection的Header值
    
    返回:
    
    Connection
  - getHost
```
public String getHost()
```
    获取Host的Header值
    
    返回:
    
    Host
  - getRequestURI
```
public String getRequestURI()
```
    获取请求的URL
    
    返回:
    
    请求的URL
  - getRequstURILastPath
```
public String getRequstURILastPath()
```
    截取getRequestURI最后的一个/后面的部分
    
    返回:
    
    String
  - getRequstURILastPath
```
public short getRequstURILastPath(short defvalue)
```
    获取请求URL最后的一个/后面的部分的short值
    例如请求URL /pipes/record/query/2
    获取type参数: short type = request.getRequstURILastPath((short)0); //type = 2
    
    参数:
    
    defvalue - 默认short值
    
    返回:
    
    short值
  - getRequstURILastPath
```
public short getRequstURILastPath(int radix,
                                  short defvalue)
```
    获取请求URL最后的一个/后面的部分的short值
    例如请求URL /pipes/record/query/2
    获取type参数: short type = request.getRequstURILastPath(16, (short)0); //type = 2
    
    参数:
    
    radix - 进制数
    
    defvalue - 默认short值
    
    返回:
    
    short值
  - getRequstURILastPath
```
public int getRequstURILastPath(int defvalue)
```
    获取请求URL最后的一个/后面的部分的int值
    例如请求URL /pipes/record/query/2
    获取type参数: int type = request.getRequstURILastPath(0); //type = 2
    
    参数:
    
    defvalue - 默认int值
    
    返回:
    
    int值
  - getRequstURILastPath
```
public int getRequstURILastPath(int radix,
                                int defvalue)
```
    获取请求URL最后的一个/后面的部分的int值
    例如请求URL /pipes/record/query/2
    获取type参数: int type = request.getRequstURILastPath(16, 0); //type = 2
    
    参数:
    
    radix - 进制数
    
    defvalue - 默认int值
    
    返回:
    
    int值
  - getRequstURILastPath
```
public float getRequstURILastPath(float defvalue)
```
    获取请求URL最后的一个/后面的部分的float值
    例如请求URL /pipes/record/query/2
    获取type参数: float type = request.getRequstURILastPath(0.0f); //type = 2.0f
    
    参数:
    
    defvalue - 默认float值
    
    返回:
    
    float值
  - getRequstURILastPath
```
public long getRequstURILastPath(long defvalue)
```
    获取请求URL最后的一个/后面的部分的int值
    例如请求URL /pipes/record/query/2
    获取type参数: long type = request.getRequstURILastPath(0L); //type = 2
    
    参数:
    
    defvalue - 默认long值
    
    返回:
    
    long值
  - getRequstURILastPath
```
public long getRequstURILastPath(int radix,
                                 long defvalue)
```
    获取请求URL最后的一个/后面的部分的int值
    例如请求URL /pipes/record/query/2
    获取type参数: long type = request.getRequstURILastPath(16, 0L); //type = 2
    
    参数:
    
    radix - 进制数
    
    defvalue - 默认long值
    
    返回:
    
    long值
  - getRequstURILastPath
```
public double getRequstURILastPath(double defvalue)
```
    获取请求URL最后的一个/后面的部分的double值
    例如请求URL /pipes/record/query/2
    获取type参数: double type = request.getRequstURILastPath(0.0); //type = 2.0
    
    参数:
    
    defvalue - 默认double值
    
    返回:
    
    double值
  - getRequstURIPaths
```
public String[] getRequstURIPaths(String prefix)
```
    从prefix之后截取getRequestURI再对"/"进行分隔
    
    参数:
    
    prefix - 前缀
    
    返回:
    
    String[]
  - getRequstURIPath
```
public String getRequstURIPath(String prefix,
                               String defvalue)
```
    获取请求URL分段中含prefix段的值
    例如请求URL /pipes/record/query/name:hello
    获取name参数: String name = request.getRequstURIPath("name:", "none");
    
    参数:
    
    prefix - prefix段前缀
    
    defvalue - 默认值
    
    返回:
    
    prefix截断后的值
  - getRequstURIPath
```
public short getRequstURIPath(String prefix,
                              short defvalue)
```
    获取请求URL分段中含prefix段的short值
    例如请求URL /pipes/record/query/type:10
    获取type参数: short type = request.getRequstURIPath("type:", (short)0);
    
    参数:
    
    prefix - prefix段前缀
    
    defvalue - 默认short值
    
    返回:
    
    short值
  - getRequstURIPath
```
public short getRequstURIPath(int radix,
                              String prefix,
                              short defvalue)
```
    获取请求URL分段中含prefix段的short值
    例如请求URL /pipes/record/query/type:a
    获取type参数: short type = request.getRequstURIPath(16, "type:", (short)0); //type = 10
    
    参数:
    
    radix - 进制数
    
    prefix - prefix段前缀
    
    defvalue - 默认short值
    
    返回:
    
    short值
  - getRequstURIPath
```
public int getRequstURIPath(String prefix,
                            int defvalue)
```
    获取请求URL分段中含prefix段的int值
    例如请求URL /pipes/record/query/offset:0/limit:50
    获取offset参数: int offset = request.getRequstURIPath("offset:", 0);
    获取limit参数: int limit = request.getRequstURIPath("limit:", 20);
    
    参数:
    
    prefix - prefix段前缀
    
    defvalue - 默认int值
    
    返回:
    
    int值
  - getRequstURIPath
```
public int getRequstURIPath(int radix,
                            String prefix,
                            int defvalue)
```
    获取请求URL分段中含prefix段的int值
    例如请求URL /pipes/record/query/offset:0/limit:50
    获取offset参数: int offset = request.getRequstURIPath("offset:", 0);
    获取limit参数: int limit = request.getRequstURIPath(16, "limit:", 20); // limit = 16
    
    参数:
    
    radix - 进制数
    
    prefix - prefix段前缀
    
    defvalue - 默认int值
    
    返回:
    
    int值
  - getRequstURIPath
```
public float getRequstURIPath(String prefix,
                              float defvalue)
```
    获取请求URL分段中含prefix段的float值
    例如请求URL /pipes/record/query/point:40.0
    获取time参数: float point = request.getRequstURIPath("point:", 0.0f);
    
    参数:
    
    prefix - prefix段前缀
    
    defvalue - 默认float值
    
    返回:
    
    float值
  - getRequstURIPath
```
public long getRequstURIPath(String prefix,
                             long defvalue)
```
    获取请求URL分段中含prefix段的long值
    例如请求URL /pipes/record/query/time:1453104341363/id:40
    获取time参数: long time = request.getRequstURIPath("time:", 0L);
    
    参数:
    
    prefix - prefix段前缀
    
    defvalue - 默认long值
    
    返回:
    
    long值
  - getRequstURIPath
```
public long getRequstURIPath(int radix,
                             String prefix,
                             long defvalue)
```
    获取请求URL分段中含prefix段的long值
    例如请求URL /pipes/record/query/time:1453104341363/id:40
    获取time参数: long time = request.getRequstURIPath(16, "time:", 0L);
    
    参数:
    
    radix - 进制数
    
    prefix - prefix段前缀
    
    defvalue - 默认long值
    
    返回:
    
    long值
  - getRequstURIPath
```
public double getRequstURIPath(String prefix,
                               double defvalue)
```
    获取请求URL分段中含prefix段的double值
    例如请求URL /pipes/record/query/point:40.0
    获取time参数: double point = request.getRequstURIPath("point:", 0.0);
    
    参数:
    
    prefix - prefix段前缀
    
    defvalue - 默认double值
    
    返回:
    
    double值
  - getHeaders
```
public AnyValue getHeaders()
```
    获取请求Header总对象
    
    返回:
    
    AnyValue
  - getHeadersToMap
```
public Map<String,String> getHeadersToMap(Map<String,String> map)
```
    将请求Header转换成Map
    
    参数:
    
    map - Map
    
    返回:
    
    Map
  - getHeaderNames
```
public String[] getHeaderNames()
```
    获取所有的header名
    
    返回:
    
    header名数组
  - getHeader
```
public String getHeader(String name)
```
    获取指定的header值
    
    参数:
    
    name - header名
    
    返回:
    
    header值
  - getHeader
```
public String getHeader(String name,
                        String defaultValue)
```
    获取指定的header值, 没有返回默认值
    
    参数:
    
    name - header名
    
    defaultValue - 默认值
    
    返回:
    
    header值
  - getJsonHeader
```
public <T> T getJsonHeader(Type type,
                           String name)
```
    获取指定的header的json值
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    type - 反序列化的类名
    
    name - header名
    
    返回:
    
    header值
  - getJsonHeader
```
public <T> T getJsonHeader(JsonConvert convert,
                           Type type,
                           String name)
```
    获取指定的header的json值
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    convert - JsonConvert对象
    
    type - 反序列化的类名
    
    name - header名
    
    返回:
    
    header值
  - getBooleanHeader
```
public boolean getBooleanHeader(String name,
                                boolean defaultValue)
```
    获取指定的header的boolean值, 没有返回默认boolean值
    
    参数:
    
    name - header名
    
    defaultValue - 默认boolean值
    
    返回:
    
    header值
  - getShortHeader
```
public short getShortHeader(String name,
                            short defaultValue)
```
    获取指定的header的short值, 没有返回默认short值
    
    参数:
    
    name - header名
    
    defaultValue - 默认short值
    
    返回:
    
    header值
  - getShortHeader
```
public short getShortHeader(int radix,
                            String name,
                            short defaultValue)
```
    获取指定的header的short值, 没有返回默认short值
    
    参数:
    
    radix - 进制数
    
    name - header名
    
    defaultValue - 默认short值
    
    返回:
    
    header值
  - getShortHeader
```
public short getShortHeader(String name,
                            int defaultValue)
```
    获取指定的header的short值, 没有返回默认short值
    
    参数:
    
    name - header名
    
    defaultValue - 默认short值
    
    返回:
    
    header值
  - getShortHeader
```
public short getShortHeader(int radix,
                            String name,
                            int defaultValue)
```
    获取指定的header的short值, 没有返回默认short值
    
    参数:
    
    radix - 进制数
    
    name - header名
    
    defaultValue - 默认short值
    
    返回:
    
    header值
  - getIntHeader
```
public int getIntHeader(String name,
                        int defaultValue)
```
    获取指定的header的int值, 没有返回默认int值
    
    参数:
    
    name - header名
    
    defaultValue - 默认int值
    
    返回:
    
    header值
  - getIntHeader
```
public int getIntHeader(int radix,
                        String name,
                        int defaultValue)
```
    获取指定的header的int值, 没有返回默认int值
    
    参数:
    
    radix - 进制数
    
    name - header名
    
    defaultValue - 默认int值
    
    返回:
    
    header值
  - getLongHeader
```
public long getLongHeader(String name,
                          long defaultValue)
```
    获取指定的header的long值, 没有返回默认long值
    
    参数:
    
    name - header名
    
    defaultValue - 默认long值
    
    返回:
    
    header值
  - getLongHeader
```
public long getLongHeader(int radix,
                          String name,
                          long defaultValue)
```
    获取指定的header的long值, 没有返回默认long值
    
    参数:
    
    radix - 进制数
    
    name - header名
    
    defaultValue - 默认long值
    
    返回:
    
    header值
  - getFloatHeader
```
public float getFloatHeader(String name,
                            float defaultValue)
```
    获取指定的header的float值, 没有返回默认float值
    
    参数:
    
    name - header名
    
    defaultValue - 默认float值
    
    返回:
    
    header值
  - getDoubleHeader
```
public double getDoubleHeader(String name,
                              double defaultValue)
```
    获取指定的header的double值, 没有返回默认double值
    
    参数:
    
    name - header名
    
    defaultValue - 默认double值
    
    返回:
    
    header值
  - getParameters
```
public AnyValue getParameters()
```
    获取请求参数总对象
    
    返回:
    
    AnyValue
  - getParametersToMap
```
public Map<String,String> getParametersToMap(Map<String,String> map)
```
    将请求参数转换成Map
    
    参数:
    
    map - Map
    
    返回:
    
    Map
  - getParametersToString
```
public String getParametersToString()
```
    将请求参数转换成String, 字符串格式为: bean1={}&id=13&name=xxx
    不会返回null，没有参数返回空字符串
    
    返回:
    
    String
  - getParametersToString
```
public String getParametersToString(String prefix)
```
    将请求参数转换成String, 字符串格式为: bean1={}&id=13&name=xxx
    不会返回null，没有参数返回空字符串
    
    参数:
    
    prefix - 拼接前缀，如果无参数，返回的字符串不会含有拼接前缀
    
    返回:
    
    String
  - getParameterNames
```
public String[] getParameterNames()
```
    获取所有参数名
    
    返回:
    
    参数名数组
  - getParameter
```
public String getParameter(String name)
```
    获取指定的参数值
    
    参数:
    
    name - 参数名
    
    返回:
    
    参数值
  - getParameter
```
public String getParameter(String name,
                           String defaultValue)
```
    获取指定的参数值, 没有返回默认值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认值
    
    返回:
    
    参数值
  - getJsonParameter
```
public <T> T getJsonParameter(Type type,
                              String name)
```
    获取指定的参数json值
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    type - 反序列化的类名
    
    name - 参数名
    
    返回:
    
    参数值
  - getJsonParameter
```
public <T> T getJsonParameter(JsonConvert convert,
                              Type type,
                              String name)
```
    获取指定的参数json值
    
    类型参数:
    
    T - 泛型
    
    参数:
    
    convert - JsonConvert对象
    
    type - 反序列化的类名
    
    name - 参数名
    
    返回:
    
    参数值
  - getBooleanParameter
```
public boolean getBooleanParameter(String name,
                                   boolean defaultValue)
```
    获取指定的参数boolean值, 没有返回默认boolean值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认boolean值
    
    返回:
    
    参数值
  - getShortParameter
```
public short getShortParameter(String name,
                               short defaultValue)
```
    获取指定的参数short值, 没有返回默认short值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认short值
    
    返回:
    
    参数值
  - getShortParameter
```
public short getShortParameter(int radix,
                               String name,
                               short defaultValue)
```
    获取指定的参数short值, 没有返回默认short值
    
    参数:
    
    radix - 进制数
    
    name - 参数名
    
    defaultValue - 默认short值
    
    返回:
    
    参数值
  - getShortParameter
```
public short getShortParameter(String name,
                               int defaultValue)
```
    获取指定的参数short值, 没有返回默认short值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认short值
    
    返回:
    
    参数值
  - getIntParameter
```
public int getIntParameter(String name,
                           int defaultValue)
```
    获取指定的参数int值, 没有返回默认int值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认int值
    
    返回:
    
    参数值
  - getIntParameter
```
public int getIntParameter(int radix,
                           String name,
                           int defaultValue)
```
    获取指定的参数int值, 没有返回默认int值
    
    参数:
    
    radix - 进制数
    
    name - 参数名
    
    defaultValue - 默认int值
    
    返回:
    
    参数值
  - getLongParameter
```
public long getLongParameter(String name,
                             long defaultValue)
```
    获取指定的参数long值, 没有返回默认long值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认long值
    
    返回:
    
    参数值
  - getLongParameter
```
public long getLongParameter(int radix,
                             String name,
                             long defaultValue)
```
    获取指定的参数long值, 没有返回默认long值
    
    参数:
    
    radix - 进制数
    
    name - 参数名
    
    defaultValue - 默认long值
    
    返回:
    
    参数值
  - getFloatParameter
```
public float getFloatParameter(String name,
                               float defaultValue)
```
    获取指定的参数float值, 没有返回默认float值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认float值
    
    返回:
    
    参数值
  - getDoubleParameter
```
public double getDoubleParameter(String name,
                                 double defaultValue)
```
    获取指定的参数double值, 没有返回默认double值
    
    参数:
    
    name - 参数名
    
    defaultValue - 默认double值
    
    返回:
    
    参数值
  - getFlipper
```
public Flipper getFlipper()
```
    获取翻页对象同 getFlipper("flipper", false, 0);
    
    返回:
    
    Flipper翻页对象
  - getFlipper
```
public Flipper getFlipper(boolean needcreate)
```
    获取翻页对象同 getFlipper("flipper", needcreate, 0);
    
    参数:
    
    needcreate - 无参数时是否创建新Flipper对象
    
    返回:
    
    Flipper翻页对象
  - getFlipper
```
public Flipper getFlipper(int maxLimit)
```
    获取翻页对象同 getFlipper("flipper", false, maxLimit);
    
    参数:
    
    maxLimit - 最大行数，小于1则值为Flipper.DEFAULT_LIMIT
    
    返回:
    
    Flipper翻页对象
  - getFlipper
```
public Flipper getFlipper(boolean needcreate,
                          int maxLimit)
```
    获取翻页对象同 getFlipper("flipper", needcreate, maxLimit)
    
    参数:
    
    needcreate - 无参数时是否创建新Flipper对象
    
    maxLimit - 最大行数，小于1则值为Flipper.DEFAULT_LIMIT
    
    返回:
    
    Flipper翻页对象
  - getFlipper
```
public Flipper getFlipper(String name,
                          boolean needcreate,
                          int maxLimit)
```
    获取翻页对象 https://redkale.org/pipes/records/list/offset:0/limit:20/sort:createtime%20ASC
    https://redkale.org/pipes/records/list?flipper={'offset':0,'limit':20, 'sort':'createtime ASC'}
    以上两种接口都可以获取到翻页对象
    
    参数:
    
    name - Flipper对象的参数名，默认为 "flipper"
    
    needcreate - 无参数时是否创建新Flipper对象
    
    maxLimit - 最大行数，小于1则值为Flipper.DEFAULT_LIMIT
    
    返回:
    
    Flipper翻页对象

类 HttpRequest

字段概要

从类继承的字段 org.redkale.net.Request

构造器概要

方法概要

从类继承的方法 org.redkale.net.Request

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

字段详细资料

SESSIONID_NAME

requestURI

cookie

newsessionid

header

params

boundary

moduleid

actionid

currentUser

构造器详细资料

HttpRequest

方法详细资料

isWebSocket

setKeepAlive

isKeepAlive

getChannel

getJsonConvert

readHeader

readBody

prepare

skipBodyParse

setProperty

getProperty

removeProperty

setCurrentUser

currentUser

getModuleid

getActionid

getRemoteAddress

getRemoteAddr

getBody

getBodyUTF8

getBodyJson

getBodyJson

getBody

getDirectBody

toString

getMultiContext

multiParts

recycle

getSessionid

changeSessionid

changeSessionid

invalidateSession

getCookies

getCookie

getCookie

getProtocol

getMethod

getContentType

getContentLength

getConnection

getHost

getRequestURI

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURILastPath

getRequstURIPaths

getRequstURIPath

getRequstURIPath

getRequstURIPath

getRequstURIPath

getRequstURIPath

getRequstURIPath

getRequstURIPath