HttpHelper (jessma-core 3.5.1 API)

java.lang.Object
- org.jessma.util.http.HttpHelper

```
public class HttpHelper
extends Object
```
HTTP 帮助类

字段概要

字段
限定符和类型	字段和说明
`static int`	`HTTP_DEFAULT_PORT` HTTP 默认端口
`static String`	`HTTP_SCHEME` HTTP URL 标识
`static int`	`HTTPS_DEFAULT_PORT` HTTPS 默认端口
`static String`	`HTTPS_SCHEME` HTTPS URL 标识
`static String`	`URL_PARAM_FLAG` URL 参数标识符
`static String`	`URL_PARAM_SEPARATOR` URL 参数分隔符
`static String`	`URL_PATH_SEPARATOR` URL 目录分隔符
`static String`	`URL_PORT_SEPARATOR` URL 端口分隔符
`static String`	`URL_SECHEME_SUFFIX` URL scheme 指示符

构造器概要

构造器
构造器和说明

HttpHelper()

构造器
构造器和说明
`HttpHelper()`

方法概要

方法
限定符和类型	方法和说明
`static void`	`addCookie(javax.servlet.http.HttpServletResponse response, javax.servlet.http.Cookie cookie)` 添加 `Cookie`
`static void`	`addCookie(javax.servlet.http.HttpServletResponse response, String name, String value)` 添加 `Cookie`
`static String`	`addUrlParams(String url, Map<String,String> map)` 添加 URL 地址参数
`static String`	`addUrlParams(String url, Object... params)` 添加 URL 地址参数
`static <T> T`	`createFormBean(javax.servlet.http.HttpServletRequest request, Class<T> clazz)` 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)
`static <T> T`	`createFormBean(javax.servlet.http.HttpServletRequest request, Class<T> clazz, Map<String,String> keyMap)` 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)
`static <T> T`	`createFormBeanByFieldValues(javax.servlet.http.HttpServletRequest request, Class<T> clazz)` 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)
`static <T> T`	`createFormBeanByFieldValues(javax.servlet.http.HttpServletRequest request, Class<T> clazz, Map<String,String> keyMap)` 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)
`static <T> T`	`createFormBeanByProperties(javax.servlet.http.HttpServletRequest request, Class<T> clazz)` 使用表单元素创建 Form Bean (表单元素的名称和 Form Bean 属性名完全一致)
`static <T> T`	`createFormBeanByProperties(javax.servlet.http.HttpServletRequest request, Class<T> clazz, Map<String,String> keyMap)` 使用表单元素创建 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性)
`static javax.servlet.http.HttpSession`	`createSession(javax.servlet.http.HttpServletRequest request)` 创建 `HttpSession` 对象，如果已存在则返回原对象。
`static String`	`deleteUrlParams(String url, String... names)` 删除 URL 地址参数
`static String`	`encodeUrlParams(String url)` 编码 URL 地址参数
`static String`	`ensurePath(String path, String defPath)` 确保 URL 路径的前后存在 URL 路径分隔符
`static <T> void`	`fillFormBeanFieldValues(javax.servlet.http.HttpServletRequest request, T bean)` 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 成员变量名完全一致)
`static <T> void`	`fillFormBeanFieldValues(javax.servlet.http.HttpServletRequest request, T bean, Map<String,String> keyMap)` 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 成员变量)
`static <T> void`	`fillFormBeanProperties(javax.servlet.http.HttpServletRequest request, T bean)` 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性名完全一致)
`static <T> void`	`fillFormBeanProperties(javax.servlet.http.HttpServletRequest request, T bean, Map<String,String> keyMap)` 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性)
`static <T> void`	`fillFormBeanPropertiesOrFieldValues(javax.servlet.http.HttpServletRequest request, T bean)` 使用表单元素填充 Form Bean (表单元素的名称和 Form Bean 属性或成员变量名完全一致)
`static <T> void`	`fillFormBeanPropertiesOrFieldValues(javax.servlet.http.HttpServletRequest request, T bean, Map<String,String> keyMap)` 使用表单元素填充 Form Bean (用 keyMap 映射与表单元素名称不对应的 Form Bean 属性或成员变量)
`static <T> T`	`getApplicationAttribute(javax.servlet.ServletContext servletContext, String name)` 获取 `ServletContext` 的指定属性值
`static <T> T`	`getApplicationAttribute(String name)` 获取 `ServletContext` 的指定属性值
`static Boolean`	`getBooleanParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static boolean`	`getBooleanParam(javax.servlet.http.HttpServletRequest request, String name, boolean def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static Byte`	`getByteParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static byte`	`getByteParam(javax.servlet.http.HttpServletRequest request, String name, byte def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static Character`	`getCharParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static char`	`getCharParam(javax.servlet.http.HttpServletRequest request, String name, char def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static javax.servlet.http.Cookie`	`getCookie(javax.servlet.http.HttpServletRequest request, String name)` 获取指定名称的 `Cookie`
`static javax.servlet.http.Cookie[]`	`getCookies(javax.servlet.http.HttpServletRequest request)` 获取所有 `Cookie`
`static String`	`getCookieValue(javax.servlet.http.HttpServletRequest request, String name)` 获取指定名称的 `Cookie` 值，失败返回 null
`static Date`	`getDateParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static Date`	`getDateParam(javax.servlet.http.HttpServletRequest request, String name, String format)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static Double`	`getDoubleParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static double`	`getDoubleParam(javax.servlet.http.HttpServletRequest request, String name, double def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static Float`	`getFloatParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static float`	`getFloatParam(javax.servlet.http.HttpServletRequest request, String name, float def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static HttpURLConnection`	`getHttpConnection(String url, KV<String,String>... properties)` 获取 `HttpURLConnection`
`static HttpURLConnection`	`getHttpConnection(String url, String method, KV<String,String>... properties)` 获取 `HttpURLConnection`
`static Integer`	`getIntParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static int`	`getIntParam(javax.servlet.http.HttpServletRequest request, String name, int def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static Long`	`getLongParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static long`	`getLongParam(javax.servlet.http.HttpServletRequest request, String name, long def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static String`	`getParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，并去除前后空格
`static Map<String,String[]>`	`getParamMap(javax.servlet.http.HttpServletRequest request)` 获取 `HttpServletRequest` 的所有参数名称和值
`static List<String>`	`getParamNames(javax.servlet.http.HttpServletRequest request)` 获取 `HttpServletRequest` 的参数名称集合
`static String`	`getParamNoTrim(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值
`static List<String>`	`getParamValues(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值集合
`static <T> T`	`getRequestAttribute(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定属性值
`static String`	`getRequestBasePath(javax.servlet.http.HttpServletRequest request)` 获取 URL 的 BASE 路径
`static Locale`	`getRequestLocale(javax.servlet.http.HttpServletRequest request)` 获取客户端 `Locale`
`static List<Locale>`	`getRequestLocales(javax.servlet.http.HttpServletRequest request)` 获取客户端 `Locale` 列表
`static String`	`getRequestRealPath(javax.servlet.http.HttpServletRequest request, String path)` 获取 URL 地址在文件系统的绝对路径, Servlet 2.4 以上通过 request.getServletContext().getRealPath() 获取, Servlet 2.4 以下通过 request.getRealPath() 获取。
`static String`	`getRequestUserAgentPlatform(javax.servlet.http.HttpServletRequest request)` 获取发送请求的客户端浏览器所在的操作系统平台
`static javax.servlet.ServletContext`	`getServletContext()` 获取 `ServletContext`
`static javax.servlet.http.HttpSession`	`getSession(javax.servlet.http.HttpServletRequest request)` 获取 `HttpSession` 对象，如果没有则进行创建。
`static javax.servlet.http.HttpSession`	`getSession(javax.servlet.http.HttpServletRequest request, boolean create)` 获取 `HttpSession` 对象，如果没有则根据参数决定是否创建。
`static <T> T`	`getSessionAttribute(javax.servlet.http.HttpSession session, String name)` 获取 `HttpSession` 的指定属性值
`static Short`	`getShortParam(javax.servlet.http.HttpServletRequest request, String name)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回 null
`static short`	`getShortParam(javax.servlet.http.HttpServletRequest request, String name, short def)` 获取 `HttpServletRequest` 的指定请求参数值，失败返回默认值
`static String`	`getUrlBase(String url)` 获取 URL 地址的 Base Path
`static String`	`getUrlBase(String url, String scheme)` 获取 URL 地址的 Base Path
`static String`	`getUrlHost(String url)` 获取 URL 地址的主机段
`static String`	`getUrlParam(String url, String name)` 获取 URL 地址的指定参数
`static Map<String,String>`	`getUrlParamMap(String url)` 获取 URL 地址参数
`static void`	`initializeServletContext(javax.servlet.ServletContext servletContext)` 初始化 `HttpHelper` 的 `ServletContext` （只能初始化一次，通常在应用程序启动时执行）
`static void`	`invalidateSession(javax.servlet.http.HttpSession session)` 销毁 `HttpSession`
`static boolean`	`isRequestNotComeFromWidnows(javax.servlet.http.HttpServletRequest request)` 检查请求是否来自非 Windows 系统的浏览器
`static String`	`makeURL(String srcURL, KV<String,String>... params)` 根据地址和参数生成 URL
`static String`	`makeURL(String srcURL, String charset, KV<String,String>... params)` 根据地址和参数生成 URL，并用指定字符集对地址进行编码
`static byte[]`	`readBytes(javax.servlet.http.HttpServletRequest request)` 读取页面请求的字节内容
`static byte[]`	`readBytes(HttpURLConnection conn)` 读取页面请求的字节内容
`static byte[]`	`readBytes(InputStream is)` 读取页面请求的字节内容
`static byte[]`	`readBytes(InputStream is, int length)` 读取页面请求的字节内容
`static String`	`readString(javax.servlet.http.HttpServletRequest request, boolean escapeReturnChar, String charsetName)` 读取页面请求的字节内容
`static String`	`readString(HttpURLConnection conn, boolean escapeReturnChar, String charsetName)` 读取页面请求的文本内容
`static String`	`readString(InputStream is, boolean escapeReturnChar, String charsetName)` 读取页面请求的文本内容
`static void`	`removeApplicationAttribute(javax.servlet.ServletContext servletContext, String name)` 删除 `ServletContext` 的指定属性值
`static void`	`removeApplicationAttribute(String name)` 删除 `ServletContext` 的指定属性值
`static void`	`removeRequestAttribute(javax.servlet.http.HttpServletRequest request, String name)` 删除 `HttpServletRequest` 的指定属性值
`static void`	`removeSessionAttribute(javax.servlet.http.HttpSession session, String name)` 删除 `HttpSession` 的指定属性值
`static <T> void`	`setApplicationAttribute(javax.servlet.ServletContext servletContext, String name, T value)` 设置 `ServletContext` 的指定属性值
`static <T> void`	`setApplicationAttribute(String name, T value)` 设置 `ServletContext` 的指定属性值
`static void`	`setContentType(javax.servlet.http.HttpServletResponse response, String contentType, String encoding)` 设置 HTTP 的 'Content-Type' 响应头
`static void`	`setNoCacheHeader(javax.servlet.http.HttpServletResponse response)` 禁止浏览器缓存当前页面
`static <T> void`	`setRequestAttribute(javax.servlet.http.HttpServletRequest request, String name, T value)` 设置 `HttpServletRequest` 的指定属性值
`static <T> void`	`setSessionAttribute(javax.servlet.http.HttpSession session, String name, T value)` 设置 `HttpSession` 的指定属性值
`static String`	`truncateUrlParams(String url)` 获取 URL 地址的非参数段
`static byte[]`	`unGZip(byte[] bytes)` GZip 解压
`static void`	`unInitializeServletContext()` 释放 `HttpHelper` 的 `ServletContext` （通常在应用程序关闭时执行）
`static void`	`writeBytes(javax.servlet.http.HttpServletResponse response, byte[] content)` 向页面输出字节内容
`static void`	`writeBytes(HttpURLConnection conn, byte[] content)` 向页面输出字节内容
`static void`	`writeBytes(OutputStream os, byte[] content)` 向页面输出字节内容
`static void`	`writeString(javax.servlet.http.HttpServletResponse response, String content, String charsetName)` 向页面输出文本内容
`static void`	`writeString(HttpURLConnection conn, String content, String charsetName)` 向页面输出文本内容
`static void`	`writeString(OutputStream os, String content, String charsetName)` 向页面输出文本内容

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

字段详细资料
- URL_SECHEME_SUFFIX
```
public static final String URL_SECHEME_SUFFIX
```
  URL scheme 指示符
  
  另请参阅:
  常量字段值
- URL_PATH_SEPARATOR
```
public static final String URL_PATH_SEPARATOR
```
  URL 目录分隔符
  
  另请参阅:
  常量字段值
- URL_PORT_SEPARATOR
```
public static final String URL_PORT_SEPARATOR
```
  URL 端口分隔符
  
  另请参阅:
  常量字段值
- URL_PARAM_FLAG
```
public static final String URL_PARAM_FLAG
```
  URL 参数标识符
  
  另请参阅:
  常量字段值
- URL_PARAM_SEPARATOR
```
public static final String URL_PARAM_SEPARATOR
```
  URL 参数分隔符
  
  另请参阅:
  常量字段值
- HTTP_SCHEME
```
public static final String HTTP_SCHEME
```
  HTTP URL 标识
  
  另请参阅:
  常量字段值
- HTTPS_SCHEME
```
public static final String HTTPS_SCHEME
```
  HTTPS URL 标识
  
  另请参阅:
  常量字段值
- HTTP_DEFAULT_PORT
```
public static final int HTTP_DEFAULT_PORT
```
  HTTP 默认端口
  
  另请参阅:
  常量字段值
- HTTPS_DEFAULT_PORT
```
public static final int HTTPS_DEFAULT_PORT
```
  HTTPS 默认端口
  
  另请参阅:
  常量字段值

构造器详细资料
- HttpHelper
```
public HttpHelper()
```

方法详细资料

getServletContext

public static javax.servlet.ServletContext getServletContext()

获取 ServletContext

initializeServletContext
```
public static final void initializeServletContext(javax.servlet.ServletContext servletContext)
```
初始化 HttpHelper 的 ServletContext （只能初始化一次，通常在应用程序启动时执行）

参数:
servletContext - : 全局 ServletContext 对象

抛出:

IllegalStateException - : 重复初始化时抛出

IllegalArgumentException: - servletContext 参数为 null 时抛出

unInitializeServletContext
```
public static final void unInitializeServletContext()
```
释放 HttpHelper 的 ServletContext （通常在应用程序关闭时执行）

getHttpConnection

public static final HttpURLConnection getHttpConnection(String url,
                                  KV<String,String>... properties)
                                                 throws IOException

获取 HttpURLConnection

抛出:: IOException

getHttpConnection

public static final HttpURLConnection getHttpConnection(String url,
                                  String method,
                                  KV<String,String>... properties)
                                                 throws IOException

获取 HttpURLConnection

抛出:: IOException

writeString

public static final void writeString(HttpURLConnection conn,
               String content,
               String charsetName)
                              throws IOException

向页面输出文本内容

抛出:: IOException

writeString

public static final void writeString(javax.servlet.http.HttpServletResponse response,
               String content,
               String charsetName)
                              throws IOException

向页面输出文本内容

抛出:: IOException

writeString

public static final void writeString(OutputStream os,
               String content,
               String charsetName)
                              throws IOException

向页面输出文本内容

抛出:: IOException

writeBytes

public static final void writeBytes(HttpURLConnection conn,
              byte[] content)
                             throws IOException

向页面输出字节内容

抛出:: IOException

writeBytes

public static final void writeBytes(javax.servlet.http.HttpServletResponse response,
              byte[] content)
                             throws IOException

向页面输出字节内容

抛出:: IOException

writeBytes

public static final void writeBytes(OutputStream os,
              byte[] content)
                             throws IOException

向页面输出字节内容

抛出:: IOException

readString

public static final String readString(HttpURLConnection conn,
                boolean escapeReturnChar,
                String charsetName)
                               throws IOException

读取页面请求的文本内容

抛出:: IOException

readString

public static final String readString(javax.servlet.http.HttpServletRequest request,
                boolean escapeReturnChar,
                String charsetName)
                               throws IOException

读取页面请求的字节内容

抛出:: IOException

readString

public static final String readString(InputStream is,
                boolean escapeReturnChar,
                String charsetName)
                               throws IOException

读取页面请求的文本内容

抛出:: IOException

readBytes

public static final byte[] readBytes(HttpURLConnection conn)
                              throws IOException

读取页面请求的字节内容

抛出:: IOException

readBytes

public static final byte[] readBytes(javax.servlet.http.HttpServletRequest request)
                              throws IOException

读取页面请求的字节内容

抛出:: IOException

readBytes

public static final byte[] readBytes(InputStream is)
                              throws IOException

读取页面请求的字节内容

抛出:: IOException

readBytes

public static final byte[] readBytes(InputStream is,
               int length)
                              throws IOException

读取页面请求的字节内容

抛出:: IOException

makeURL

public static final String makeURL(String srcURL,
             KV<String,String>... params)

根据地址和参数生成 URL

makeURL

public static final String makeURL(String srcURL,
             String charset,
             KV<String,String>... params)

根据地址和参数生成 URL，并用指定字符集对地址进行编码

ensurePath

public static final String ensurePath(String path,
                String defPath)

确保 URL 路径的前后存在 URL 路径分隔符

getRequestAttribute

public static final <T> T getRequestAttribute(javax.servlet.http.HttpServletRequest request,
                        String name)

获取 HttpServletRequest 的指定属性值

setRequestAttribute

public static final <T> void setRequestAttribute(javax.servlet.http.HttpServletRequest request,
                           String name,
                           T value)

设置 HttpServletRequest 的指定属性值

removeRequestAttribute

public static final void removeRequestAttribute(javax.servlet.http.HttpServletRequest request,
                          String name)

删除 HttpServletRequest 的指定属性值

getSessionAttribute

public static final <T> T getSessionAttribute(javax.servlet.http.HttpSession session,
                        String name)

获取 HttpSession 的指定属性值

setSessionAttribute

public static final <T> void setSessionAttribute(javax.servlet.http.HttpSession session,
                           String name,
                           T value)

设置 HttpSession 的指定属性值

removeSessionAttribute

public static final void removeSessionAttribute(javax.servlet.http.HttpSession session,
                          String name)

删除 HttpSession 的指定属性值

invalidateSession

public static final void invalidateSession(javax.servlet.http.HttpSession session)

销毁 HttpSession

getApplicationAttribute

public static final <T> T getApplicationAttribute(String name)

获取 ServletContext 的指定属性值

getApplicationAttribute

public static final <T> T getApplicationAttribute(javax.servlet.ServletContext servletContext,
                            String name)

获取 ServletContext 的指定属性值

setApplicationAttribute

public static final <T> void setApplicationAttribute(String name,
                               T value)

设置 ServletContext 的指定属性值

setApplicationAttribute

public static final <T> void setApplicationAttribute(javax.servlet.ServletContext servletContext,
                               String name,
                               T value)

设置 ServletContext 的指定属性值

removeApplicationAttribute

public static final void removeApplicationAttribute(String name)

删除 ServletContext 的指定属性值

removeApplicationAttribute

public static final void removeApplicationAttribute(javax.servlet.ServletContext servletContext,
                              String name)

删除 ServletContext 的指定属性值

getParam

public static final String getParam(javax.servlet.http.HttpServletRequest request,
              String name)

获取 HttpServletRequest 的指定请求参数值，并去除前后空格

getParamNoTrim

public static final String getParamNoTrim(javax.servlet.http.HttpServletRequest request,
                    String name)

获取 HttpServletRequest 的指定请求参数值

getParamNames

public static final List<String> getParamNames(javax.servlet.http.HttpServletRequest request)

获取 HttpServletRequest 的参数名称集合

getParamValues

public static final List<String> getParamValues(javax.servlet.http.HttpServletRequest request,
                          String name)

获取 HttpServletRequest 的指定请求参数值集合

getParamMap

public static final Map<String,String[]> getParamMap(javax.servlet.http.HttpServletRequest request)

获取 HttpServletRequest 的所有参数名称和值