HttpServerRequest (hutool 5.8.35 API)

java.lang.Object
- cn.hutool.http.server.HttpServerBase
- - cn.hutool.http.server.HttpServerRequest

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class HttpServerRequest
extends HttpServerBase
```
Http请求对象，对HttpExchange封装

Since:

5.2.6

Author:

looly

Constructor Summary

Constructors
Constructor and Description

HttpServerRequest(com.sun.net.httpserver.HttpExchange httpExchange)
构造

Constructors
Constructor and Description
`HttpServerRequest(com.sun.net.httpserver.HttpExchange httpExchange)` 构造

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBody()` 获取请求体文本，可以是form表单、json、xml等任意内容使用`getCharset()`判断编码，判断失败使用UTF-8编码
`String`	`getBody(Charset charset)` 获取请求体文本，可以是form表单、json、xml等任意内容
`byte[]`	`getBodyBytes()` 获取body的bytes数组
`InputStream`	`getBodyStream()` 获取请求体的流，流中可以读取请求内容，包括请求表单数据或文件上传数据
`Charset`	`getCharset()` 获取编码，获取失败默认使用UTF-8，获取规则如下： 1、从Content-Type头中获取编码，类似于：text/html;charset=utf-8
`String`	`getClientIP(String... otherHeaderNames)` 获取客户端IP 默认检测的Header: 1、X-Forwarded-For 2、X-Real-IP 3、Proxy-Client-IP 4、WL-Proxy-Client-IP otherHeaderNames参数用于自定义检测的Header 需要注意的是，使用此方法获取的客户IP地址必须在Http服务器（例如Nginx）中配置头信息，否则容易造成IP伪造。
`String`	`getClientIPByHeader(String... headerNames)` 获取客户端IP headerNames参数用于自定义检测的Header 需要注意的是，使用此方法获取的客户IP地址必须在Http服务器（例如Nginx）中配置头信息，否则容易造成IP伪造。
`String`	`getContentType()` 获取Content-Type头信息
`HttpCookie`	`getCookie(String cookieName)` 获得指定Cookie名对应的HttpCookie对象
`Map<String,HttpCookie>`	`getCookieMap()` 获得Cookie信息Map，键为Cookie名，值为HttpCookie对象
`Collection<HttpCookie>`	`getCookies()` 获得Cookie信息列表
`String`	`getCookiesStr()` 获得Cookie信息字符串
`String`	`getHeader(Header headerKey)` 获得请求header中的信息
`String`	`getHeader(String headerKey)` 获得请求header中的信息
`String`	`getHeader(String headerKey, Charset charset)` 获得请求header中的信息
`com.sun.net.httpserver.Headers`	`getHeaders()` 获得请求header中的信息
`String`	`getMethod()` 获得Http Method
`MultipartFormData`	`getMultipart()` 获得MultiPart表单内容，多用于获得上传的文件
`String`	`getParam(String name)` 获取指定名称的参数值，取第一个值
`ListValueMap<String,String>`	`getParams()` 获取参数Map
`List<String>`	`getParams(String name)` 获取指定名称的参数值
`String`	`getPath()` 获得请求路径Path
`String`	`getQuery()` 获取请求参数
`URI`	`getURI()` 获得请求URI
`UserAgent`	`getUserAgent()` 获得User-Agent，未识别返回null
`String`	`getUserAgentStr()` 获得User-Agent
`boolean`	`isGetMethod()` 是否为GET请求
`boolean`	`isMultipart()` 是否为Multipart类型表单，此类型表单用于文件上传
`boolean`	`isPostMethod()` 是否为POST请求
`MultipartFormData`	`parseMultipart(UploadSetting uploadSetting)` 获得multipart/form-data 表单内容包括文件和普通表单数据在同一次请求中，此方法只能被执行一次！

Methods inherited from class cn.hutool.http.server.HttpServerBase
close, getHttpContext, getHttpExchange

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

- Constructor Detail
  - HttpServerRequest
```
public HttpServerRequest(com.sun.net.httpserver.HttpExchange httpExchange)
```
    构造
    
    Parameters:
    
    httpExchange - HttpExchange
- Method Detail
  - getMethod
```
public String getMethod()
```
    获得Http Method
    
    Returns:
    
    Http Method
  - isGetMethod
```
public boolean isGetMethod()
```
    是否为GET请求
    
    Returns:
    
    是否为GET请求
  - isPostMethod
```
public boolean isPostMethod()
```
    是否为POST请求
    
    Returns:
    
    是否为POST请求
  - getURI
```
public URI getURI()
```
    获得请求URI
    
    Returns:
    
    请求URI
  - getPath
```
public String getPath()
```
    获得请求路径Path
    
    Returns:
    
    请求路径
  - getQuery
```
public String getQuery()
```
    获取请求参数
    
    Returns:
    
    参数字符串
  - getHeaders
```
public com.sun.net.httpserver.Headers getHeaders()
```
    获得请求header中的信息
    
    Returns:
    
    header值
  - getHeader
```
public String getHeader(Header headerKey)
```
    获得请求header中的信息
    
    Parameters:
    
    headerKey - 头信息的KEY
    
    Returns:
    
    header值
  - getHeader
```
public String getHeader(String headerKey)
```
    获得请求header中的信息
    
    Parameters:
    
    headerKey - 头信息的KEY
    
    Returns:
    
    header值
  - getHeader
```
public String getHeader(String headerKey,
                        Charset charset)
```
    获得请求header中的信息
    
    Parameters:
    
    headerKey - 头信息的KEY
    
    charset - 字符集
    
    Returns:
    
    header值
  - getContentType
```
public String getContentType()
```
    获取Content-Type头信息
    
    Returns:
    
    Content-Type头信息
  - getCharset
```
public Charset getCharset()
```
    获取编码，获取失败默认使用UTF-8，获取规则如下：
```
     1、从Content-Type头中获取编码，类似于：text/html;charset=utf-8
 
```
    Returns:
    
    编码，默认UTF-8
  - getUserAgentStr
```
public String getUserAgentStr()
```
    获得User-Agent
    
    Returns:
    
    User-Agent字符串
  - getUserAgent
```
public UserAgent getUserAgent()
```
    获得User-Agent，未识别返回null
    
    Returns:
    
    User-Agent字符串，未识别返回null
  - getCookiesStr
```
public String getCookiesStr()
```
    获得Cookie信息字符串
    
    Returns:
    
    cookie字符串
  - getCookies
```
public Collection<HttpCookie> getCookies()
```
    获得Cookie信息列表
    
    Returns:
    
    Cookie信息列表
  - getCookieMap
```
public Map<String,HttpCookie> getCookieMap()
```
    获得Cookie信息Map，键为Cookie名，值为HttpCookie对象
    
    Returns:
    
    Cookie信息Map
  - getCookie
```
public HttpCookie getCookie(String cookieName)
```
    获得指定Cookie名对应的HttpCookie对象
    
    Parameters:
    
    cookieName - Cookie名
    
    Returns:
    
    HttpCookie对象
  - isMultipart
```
public boolean isMultipart()
```
    是否为Multipart类型表单，此类型表单用于文件上传
    
    Returns:
    
    是否为Multipart类型表单，此类型表单用于文件上传
  - getBody
```
public String getBody()
```
    获取请求体文本，可以是form表单、json、xml等任意内容
    使用getCharset()判断编码，判断失败使用UTF-8编码
    
    Returns:
    
    请求
  - getBody
```
public String getBody(Charset charset)
```
    获取请求体文本，可以是form表单、json、xml等任意内容
    
    Parameters:
    
    charset - 编码
    
    Returns:
    
    请求
  - getBodyBytes
```
public byte[] getBodyBytes()
```
    获取body的bytes数组
    
    Returns:
    
    body的bytes数组
  - getBodyStream
```
public InputStream getBodyStream()
```
    获取请求体的流，流中可以读取请求内容，包括请求表单数据或文件上传数据
    
    Returns:
    
    流
  - getParam
```
public String getParam(String name)
```
    获取指定名称的参数值，取第一个值
    
    Parameters:
    
    name - 参数名
    
    Returns:
    
    参数值
    
    Since:
    
    5.5.8
  - getParams
```
public List<String> getParams(String name)
```
    获取指定名称的参数值
    
    Parameters:
    
    name - 参数名
    
    Returns:
    
    参数值
    
    Since:
    
    5.5.8
  - getParams
```
public ListValueMap<String,String> getParams()
```
    获取参数Map
    
    Returns:
    
    参数map
  - getClientIP
```
public String getClientIP(String... otherHeaderNames)
```
    获取客户端IP
    默认检测的Header:
```
 1、X-Forwarded-For
 2、X-Real-IP
 3、Proxy-Client-IP
 4、WL-Proxy-Client-IP
 
```
    otherHeaderNames参数用于自定义检测的Header
    需要注意的是，使用此方法获取的客户IP地址必须在Http服务器（例如Nginx）中配置头信息，否则容易造成IP伪造。
    Parameters:
    
    otherHeaderNames - 其他自定义头文件，通常在Http服务器（例如Nginx）中配置
    
    Returns:
    
    IP地址
  - getClientIPByHeader
```
public String getClientIPByHeader(String... headerNames)
```
    获取客户端IP
    headerNames参数用于自定义检测的Header
    需要注意的是，使用此方法获取的客户IP地址必须在Http服务器（例如Nginx）中配置头信息，否则容易造成IP伪造。
    
    Parameters:
    
    headerNames - 自定义头，通常在Http服务器（例如Nginx）中配置
    
    Returns:
    
    IP地址
    
    Since:
    
    4.4.1
  - getMultipart
```
public MultipartFormData getMultipart()
                               throws IORuntimeException
```
    获得MultiPart表单内容，多用于获得上传的文件
    
    Returns:
    
    MultipartFormData
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    5.3.0
  - parseMultipart
```
public MultipartFormData parseMultipart(UploadSetting uploadSetting)
                                 throws IORuntimeException
```
    获得multipart/form-data 表单内容
    包括文件和普通表单数据
    在同一次请求中，此方法只能被执行一次！
    
    Parameters:
    
    uploadSetting - 上传文件的设定，包括最大文件大小、保存在内存的边界大小、临时目录、扩展名限定等
    
    Returns:
    
    MultiPart表单
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    5.3.0

Class HttpServerRequest

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.http.server.HttpServerBase

Methods inherited from class java.lang.Object

Constructor Detail

HttpServerRequest

Method Detail

getMethod

isGetMethod

isPostMethod

getURI

getPath

getQuery

getHeaders

getHeader

getHeader

getHeader

getContentType

getCharset

getUserAgentStr

getUserAgent

getCookiesStr

getCookies

getCookieMap

getCookie

isMultipart

getBody

getBody

getBodyBytes

getBodyStream

getParam

getParams

getParams

getClientIP

getClientIPByHeader

getMultipart

parseMultipart