org.dromara.hutool.http.server.engine.sun

Class SunServerRequest

java.lang.Object

org.dromara.hutool.http.server.engine.sun.SunServerExchangeBase

org.dromara.hutool.http.server.engine.sun.SunServerRequest

All Implemented Interfaces:

Closeable, AutoCloseable, ServerRequest

public class SunServerRequest
extends SunServerExchangeBase
implements ServerRequest

Sun Http请求包装

Author:

Looly

Field Summary

Fields inherited from class org.dromara.hutool.http.server.engine.sun.SunServerExchangeBase

httpExchange

Fields inherited from interface org.dromara.hutool.http.server.handler.ServerRequest

DEFAULT_CHARSET

Constructor Summary

Constructors

Constructor and Description
SunServerRequest(com.sun.net.httpserver.HttpExchange httpExchange) 构造

Method Summary

Modifier and Type	Method and Description
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伪造。
HttpCookie	getCookie(String cookieName) 获得指定Cookie名对应的HttpCookie对象
Map<String,HttpCookie>	getCookieMap() 获得Cookie信息Map，键为Cookie名，值为HttpCookie对象
Collection<HttpCookie>	getCookies() 获得Cookie信息列表
String	getHeader(String name) 获取请求头
com.sun.net.httpserver.Headers	getHeaders() 获得请求header中的信息
String	getMethod() 获取请求方法
MultipartFormData	getMultipart() 获得MultiPart表单内容，多用于获得上传的文件
ListValueMap<String,String>	getParams() 获取参数Map
String	getPath() 获取请求路径，包含请求参数部分
String	getQuery() 获取请求参数，包括pathVariable和queryString
URI	getURI() 获得请求URI

Methods inherited from class org.dromara.hutool.http.server.engine.sun.SunServerExchangeBase

close, getExchange, getHttpContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dromara.hutool.http.server.handler.ServerRequest

getBody, getBody, getContentLength, getContentType, getCookiesStr, getHeader, getHeader, getParam, getParams, getUserAgent, getUserAgentStr, isGetMethod, isMultipart, isPostMethod, parseMultipart

Constructor Detail

SunServerRequest

public SunServerRequest(com.sun.net.httpserver.HttpExchange httpExchange)

构造

Parameters:

httpExchange - HttpExchange

Method Detail

getMethod

public String getMethod()

Description copied from interface: ServerRequest

获取请求方法

Specified by:

getMethod in interface ServerRequest

Returns:

请求方法

getURI

public URI getURI()

获得请求URI

Returns:

请求URI

getPath

public String getPath()

Description copied from interface: ServerRequest

获取请求路径，包含请求参数部分

Specified by:

getPath in interface ServerRequest

Returns:

请求路径，包含请求参数部分

getQuery

public String getQuery()

Description copied from interface: ServerRequest

获取请求参数，包括pathVariable和queryString

Specified by:

getQuery in interface ServerRequest

Returns:

请求参数，包括pathVariable和queryString

getHeaders

public com.sun.net.httpserver.Headers getHeaders()

获得请求header中的信息

Returns:

header值

getHeader

public String getHeader(String name)

Description copied from interface: ServerRequest

获取请求头

Specified by:

getHeader in interface ServerRequest

Parameters:

name - 请求头名

Returns:

请求头

getCharset

public Charset getCharset()

Description copied from interface: ServerRequest

获取编码，获取失败默认使用UTF-8，获取规则如下：

     1、从Content-Type头中获取编码，类似于：text/html;charset=utf-8
 

Specified by:

getCharset in interface ServerRequest

Returns:

编码，默认UTF-8

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对象

getBodyStream

public InputStream getBodyStream()

Description copied from interface: ServerRequest

获取请求体流

Specified by:

getBodyStream in interface ServerRequest

Returns:

请求体流

getBodyBytes

public byte[] getBodyBytes()

Description copied from interface: ServerRequest

获取body的bytes数组

Specified by:

getBodyBytes in interface ServerRequest

Returns:

body的bytes数组

getMultipart

public MultipartFormData getMultipart()
                               throws IORuntimeException

Description copied from interface: ServerRequest

获得MultiPart表单内容，多用于获得上传的文件

Specified by:

getMultipart in interface ServerRequest

Returns:

MultipartFormData

Throws:

IORuntimeException - IO异常

getParams

public ListValueMap<String,String> getParams()

Description copied from interface: ServerRequest

获取参数Map

Specified by:

getParams in interface ServerRequest

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