ServerRequest (hutool 6.0.0-M20 API)

All Known Implementing Classes:

JavaxServletRequest, ServletRequest, SmartHttpRequest, SunServerRequest, TomcatRequest, UndertowRequest
```
public interface ServerRequest
```
服务端请求对象，用于获取请求参数等

Since:

6.0.0

Author:

looly

Field Summary

Fields
Modifier and Type Field and Description

static Charset DEFAULT_CHARSET
默认编码，用于获取请求头和响应头编码，默认为UTF-8

Fields
Modifier and Type	Field and Description
`static Charset`	`DEFAULT_CHARSET` 默认编码，用于获取请求头和响应头编码，默认为UTF-8

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default String`	`getBody()` 获取请求体文本，可以是form表单、json、xml等任意内容使用`getCharset()`判断编码，判断失败使用UTF-8编码
`default String`	`getBody(Charset charset)` 获取请求体文本，可以是form表单、json、xml等任意内容
`default byte[]`	`getBodyBytes()` 获取body的bytes数组
`InputStream`	`getBodyStream()` 获取请求体流
`default Charset`	`getCharset()` 获取编码，获取失败默认使用UTF-8，获取规则如下： 1、从Content-Type头中获取编码，类似于：text/html;charset=utf-8
`default long`	`getContentLength()` 获取Content-Length头信息，单位：字节
`default String`	`getContentType()` 获取Content-Type头信息
`default String`	`getCookiesStr()` 获得Cookie信息字符串
`default String`	`getHeader(HeaderName headerNameKey)` 获得请求header中的信息
`String`	`getHeader(String name)` 获取请求头
`default String`	`getHeader(String headerKey, Charset charset)` 获得请求header中的信息
`String`	`getMethod()` 获取请求方法
`default MultipartFormData`	`getMultipart()` 获得MultiPart表单内容，多用于获得上传的文件
`default String`	`getParam(String name)` 获取指定名称的参数值，取第一个值
`default ListValueMap<String,String>`	`getParams()` 获取参数Map
`default Collection<String>`	`getParams(String name)` 获取指定名称的参数值
`String`	`getPath()` 获取请求路径，包含请求参数部分
`String`	`getQuery()` 获取请求参数，包括pathVariable和queryString
`default UserAgent`	`getUserAgent()` 获得User-Agent，未识别返回null
`default String`	`getUserAgentStr()` 获得User-Agent
`default boolean`	`isGetMethod()` 是否为GET请求
`default boolean`	`isMultipart()` 是否为Multipart类型表单，此类型表单用于文件上传
`default boolean`	`isPostMethod()` 是否为POST请求
`default MultipartFormData`	`parseMultipart(UploadSetting uploadSetting)` 获得multipart/form-data 表单内容包括文件和普通表单数据在同一次请求中，此方法只能被执行一次！

- Field Detail
  - DEFAULT_CHARSET
```
static final Charset DEFAULT_CHARSET
```
    默认编码，用于获取请求头和响应头编码，默认为UTF-8
- Method Detail
  - getMethod
```
String getMethod()
```
    获取请求方法
    
    Returns:
    
    请求方法
  - isGetMethod
```
default boolean isGetMethod()
```
    是否为GET请求
    
    Returns:
    
    是否为GET请求
  - isPostMethod
```
default boolean isPostMethod()
```
    是否为POST请求
    
    Returns:
    
    是否为POST请求
  - getPath
```
String getPath()
```
    获取请求路径，包含请求参数部分
    
    Returns:
    
    请求路径，包含请求参数部分
  - getQuery
```
String getQuery()
```
    获取请求参数，包括pathVariable和queryString
    
    Returns:
    
    请求参数，包括pathVariable和queryString
  - getHeader
```
String getHeader(String name)
```
    获取请求头
    
    Parameters:
    
    name - 请求头名
    
    Returns:
    
    请求头
  - getHeader
```
default String getHeader(HeaderName headerNameKey)
```
    获得请求header中的信息
    
    Parameters:
    
    headerNameKey - 头信息的KEY
    
    Returns:
    
    header值
  - getHeader
```
default String getHeader(String headerKey,
                         Charset charset)
```
    获得请求header中的信息
    
    Parameters:
    
    headerKey - 头信息的KEY
    
    charset - 字符集
    
    Returns:
    
    header值
  - getContentType
```
default String getContentType()
```
    获取Content-Type头信息
    
    Returns:
    
    Content-Type头信息
  - getContentLength
```
default long getContentLength()
```
    获取Content-Length头信息，单位：字节
    
    Returns:
    
    Content-Length头信息，单位：字节
  - getCharset
```
default Charset getCharset()
```
    获取编码，获取失败默认使用UTF-8，获取规则如下：
```
     1、从Content-Type头中获取编码，类似于：text/html;charset=utf-8
 
```
    Returns:
    
    编码，默认UTF-8
  - getUserAgentStr
```
default String getUserAgentStr()
```
    获得User-Agent
    
    Returns:
    
    User-Agent字符串
  - getUserAgent
```
default UserAgent getUserAgent()
```
    获得User-Agent，未识别返回null
    
    Returns:
    
    User-Agent字符串，未识别返回null
  - getCookiesStr
```
default String getCookiesStr()
```
    获得Cookie信息字符串
    
    Returns:
    
    cookie字符串
  - isMultipart
```
default boolean isMultipart()
```
    是否为Multipart类型表单，此类型表单用于文件上传
    
    Returns:
    
    是否为Multipart类型表单，此类型表单用于文件上传
  - getBodyStream
```
InputStream getBodyStream()
```
    获取请求体流
    
    Returns:
    
    请求体流
  - getBody
```
default String getBody()
```
    获取请求体文本，可以是form表单、json、xml等任意内容
    使用getCharset()判断编码，判断失败使用UTF-8编码
    
    Returns:
    
    请求
  - getBody
```
default String getBody(Charset charset)
```
    获取请求体文本，可以是form表单、json、xml等任意内容
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    请求
  - getBodyBytes
```
default byte[] getBodyBytes()
```
    获取body的bytes数组
    
    Returns:
    
    body的bytes数组
  - getMultipart
```
default MultipartFormData getMultipart()
                                throws IORuntimeException
```
    获得MultiPart表单内容，多用于获得上传的文件
    
    Returns:
    
    MultipartFormData
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    5.3.0
  - parseMultipart
```
default MultipartFormData parseMultipart(UploadSetting uploadSetting)
                                  throws IORuntimeException
```
    获得multipart/form-data 表单内容
    包括文件和普通表单数据
    在同一次请求中，此方法只能被执行一次！
    
    Parameters:
    
    uploadSetting - 上传文件的设定，包括最大文件大小、保存在内存的边界大小、临时目录、扩展名限定等
    
    Returns:
    
    MultiPart表单
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    5.3.0
  - getParam
```
default String getParam(String name)
```
    获取指定名称的参数值，取第一个值
    
    Parameters:
    
    name - 参数名
    
    Returns:
    
    参数值
    
    Since:
    
    5.5.8
  - getParams
```
default Collection<String> getParams(String name)
```
    获取指定名称的参数值
    
    Parameters:
    
    name - 参数名
    
    Returns:
    
    参数值
    
    Since:
    
    5.5.8
  - getParams
```
default ListValueMap<String,String> getParams()
```
    获取参数Map
    
    Returns:
    
    参数map

Interface ServerRequest

Field Summary

Method Summary

Field Detail

DEFAULT_CHARSET

Method Detail

getMethod

isGetMethod

isPostMethod

getPath

getQuery

getHeader

getHeader

getHeader

getContentType

getContentLength

getCharset

getUserAgentStr

getUserAgent

getCookiesStr

isMultipart

getBodyStream

getBody

getBody

getBodyBytes

getMultipart

parseMultipart

getParam

getParams

getParams