com.gitee.baa.utils

类 RequestUtils

java.lang.Object

com.gitee.baa.utils.RequestUtils

public class RequestUtils
extends Object

Servlet操作类

字段概要

字段

限定符和类型	字段和说明
private static String	callBackFormat
private static String	ENCODING
private static long	EXPIRED_TIME

构造器概要

构造器

构造器和说明
RequestUtils()

方法概要

限定符和类型	方法和说明
static String	createUrl(String uri, String queryString)
static String	decodeURL(String url)
static String	encodeURL(String url)
static boolean	get(javax.servlet.http.HttpServletRequest request, String key, boolean defaultValue)
static double	get(javax.servlet.http.HttpServletRequest request, String key, double defaultValue)
static int	get(javax.servlet.http.HttpServletRequest request, String key, int defaultValue)
static int	get(javax.servlet.http.HttpServletRequest request, String key, int defaultValue, int min, int max) 获取整数值
static LocalDate	get(javax.servlet.http.HttpServletRequest request, String key, LocalDate defaultValue)
static LocalDateTime	get(javax.servlet.http.HttpServletRequest request, String key, LocalDateTime defaultValue)
static long	get(javax.servlet.http.HttpServletRequest request, String key, long defaultValue)
static short	get(javax.servlet.http.HttpServletRequest request, String key, short defaultValue)
static String	get(javax.servlet.http.HttpServletRequest request, String key, String defaultValue) 获取参数值
static YearMonth	get(javax.servlet.http.HttpServletRequest request, String key, YearMonth defaultValue)
protected static boolean	getBoolean(javax.servlet.http.HttpServletRequest request, String key, boolean defaultValue) 获取request中，类型为Boolean的key的值，支持"true/1/on"。
protected static double	getDouble(javax.servlet.http.HttpServletRequest request, String key, double defaultValue)
static String	getHttpsUrl(javax.servlet.http.HttpServletRequest request, String httpUrl) 自动转换http地址为https
protected static int	getInt(javax.servlet.http.HttpServletRequest request, String key, int defaultValue) 获取request中，类型为Int的key的值
protected static LocalDate	getLocalDate(javax.servlet.http.HttpServletRequest request, String key, LocalDate defaultValue)
protected static LocalDateTime	getLocalDateTime(javax.servlet.http.HttpServletRequest request, String key, LocalDateTime defaultValue)
protected static long	getLong(javax.servlet.http.HttpServletRequest request, String key, long defaultValue) 获取request中，类型为Long的key的值
static Map<String,String>	getParameters(javax.servlet.http.HttpServletRequest req)
static String	getRefer(javax.servlet.http.HttpServletRequest request) 已过时。
static String	getReferer(javax.servlet.http.HttpServletRequest request)
static String	getRequestURL(javax.servlet.http.HttpServletRequest request) 获取当前请求的URL（包括schema/host/uri/querystring等)
static List<String>	gets(javax.servlet.http.HttpServletRequest request, String key)
protected static short	getShort(javax.servlet.http.HttpServletRequest request, String key, short defaultValue) 获取request中，类型为Short的key的值
protected static String	getString(javax.servlet.http.HttpServletRequest request, String key, String defaultValue) 获取request中，类型为String的key的值
protected static String	getString(javax.servlet.http.HttpServletRequest request, String key, String[] validValues, String defaultValue) 获取request中，类型为String的key，如果传入的值不在合法值集合中，则返回默认值
protected static String	getString(javax.servlet.http.HttpServletRequest request, String key, String[] validValues, String defaultValue, boolean caseSensitive) 获取request中，类型为String的key，如果传入的值不在合法值集合中，则返回默认值
protected static YearMonth	getYearMonth(javax.servlet.http.HttpServletRequest request, String key, YearMonth defaultValue)
static boolean	isAjaxRequest(javax.servlet.http.HttpServletRequest request)
static boolean	isHttps(javax.servlet.http.HttpServletRequest request) 判断某个请求是否是HTTPS
static boolean	isSecurity(String url) URL是否是HTTPS请求
static void	prepareHttpsAttribute(javax.servlet.http.HttpServletRequest req)
static void	setCacheHeader(javax.servlet.http.HttpServletResponse response, long time) 设置过期时间，增加CDN和浏览器缓存策略
static void	setCacheHeader(javax.servlet.http.HttpServletResponse response, TimeUnit unit, long time) 设置缓存过期时间
static void	setNoCacheHeader(javax.servlet.http.HttpServletResponse response) 设置Response头，加入no-cache属性 对于HTTP头HEADER会作如下处理： Expires: 0 RHOST: 后端IP地址信息 IpAddressUtils.getAllLocalSiteAddress() Cache-Control: no-cache Pragma: no-cache
static String	toCodeMsg(int code, String msg)
static void	writeCodeMsg(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int code, String msg)
static void	writeJsonResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, int code, String msg, Object data) 向Response写入数据，通常适用于写入字符串、Json数据、XML数据等，写入成功后会刷新输出流。
static void	writeJsonResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object data)
static void	writeJsonResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String obj) 写入JSON数据
static void	writeResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String obj) 向Response写入数据，通常适用于写入字符串、Json数据、XML数据等，写入成功后会刷新输出流。
static void	writeResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String obj, String contentType)

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

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

字段详细资料

ENCODING

private static final String ENCODING

另请参阅:

常量字段值

EXPIRED_TIME

private static final long EXPIRED_TIME

另请参阅:

常量字段值

callBackFormat

private static final String callBackFormat

另请参阅:

常量字段值

构造器详细资料

RequestUtils

public RequestUtils()

方法详细资料

get

public static String get(javax.servlet.http.HttpServletRequest request,
                         String key,
                         String defaultValue)

获取参数值

参数:

request - Servlet 请求

key - 参数名称

defaultValue - 参数不存在时默认值

返回:

非null参数值

gets

public static List<String> gets(javax.servlet.http.HttpServletRequest request,
                                String key)

get

public static int get(javax.servlet.http.HttpServletRequest request,
                      String key,
                      int defaultValue)

get

public static double get(javax.servlet.http.HttpServletRequest request,
                         String key,
                         double defaultValue)

get

public static int get(javax.servlet.http.HttpServletRequest request,
                      String key,
                      int defaultValue,
                      int min,
                      int max)

获取整数值

返回:

参数值，如果比最小值min小，则返回min;如果比最大值max大，则返回max

get

public static boolean get(javax.servlet.http.HttpServletRequest request,
                          String key,
                          boolean defaultValue)

get

public static long get(javax.servlet.http.HttpServletRequest request,
                       String key,
                       long defaultValue)

get

public static short get(javax.servlet.http.HttpServletRequest request,
                        String key,
                        short defaultValue)

get

public static LocalDate get(javax.servlet.http.HttpServletRequest request,
                            String key,
                            LocalDate defaultValue)

get

public static LocalDateTime get(javax.servlet.http.HttpServletRequest request,
                                String key,
                                LocalDateTime defaultValue)

get

public static YearMonth get(javax.servlet.http.HttpServletRequest request,
                            String key,
                            YearMonth defaultValue)

getBoolean

protected static boolean getBoolean(javax.servlet.http.HttpServletRequest request,
                                    String key,
                                    boolean defaultValue)

获取request中，类型为Boolean的key的值，支持"true/1/on"。

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

defaultValue - 设置默认值

返回:

Boolean类型的属性值

从以下版本开始:

2013/7/30

getShort

protected static short getShort(javax.servlet.http.HttpServletRequest request,
                                String key,
                                short defaultValue)

获取request中，类型为Short的key的值

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

defaultValue - 设置默认值

返回:

Short类型的属性值

getInt

protected static int getInt(javax.servlet.http.HttpServletRequest request,
                            String key,
                            int defaultValue)

获取request中，类型为Int的key的值

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

defaultValue - 设置默认值

返回:

Int类型的属性值

getLong

protected static long getLong(javax.servlet.http.HttpServletRequest request,
                              String key,
                              long defaultValue)

获取request中，类型为Long的key的值

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

defaultValue - 设置默认值

返回:

Long类型的属性值

getDouble

protected static double getDouble(javax.servlet.http.HttpServletRequest request,
                                  String key,
                                  double defaultValue)

getString

protected static String getString(javax.servlet.http.HttpServletRequest request,
                                  String key,
                                  String defaultValue)

获取request中，类型为String的key的值

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

defaultValue - 设置默认值

返回:

String类型的属性值

getString

protected static String getString(javax.servlet.http.HttpServletRequest request,
                                  String key,
                                  String[] validValues,
                                  String defaultValue)

获取request中，类型为String的key，如果传入的值不在合法值集合中，则返回默认值

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

validValues - 合法值

defaultValue - 设置默认值

返回:

String类型的属性值

getString

protected static String getString(javax.servlet.http.HttpServletRequest request,
                                  String key,
                                  String[] validValues,
                                  String defaultValue,
                                  boolean caseSensitive)

获取request中，类型为String的key，如果传入的值不在合法值集合中，则返回默认值

参数:

request - 需要解析的HttpServletRequest

key - 需要取出的属性名

validValues - 可以使用的值

defaultValue - 合法值

caseSensitive - 大小写是否敏感

返回:

String类型的属性值

getLocalDate

protected static LocalDate getLocalDate(javax.servlet.http.HttpServletRequest request,
                                        String key,
                                        LocalDate defaultValue)

getLocalDateTime

protected static LocalDateTime getLocalDateTime(javax.servlet.http.HttpServletRequest request,
                                                String key,
                                                LocalDateTime defaultValue)

getYearMonth

protected static YearMonth getYearMonth(javax.servlet.http.HttpServletRequest request,
                                        String key,
                                        YearMonth defaultValue)

setCacheHeader

public static void setCacheHeader(javax.servlet.http.HttpServletResponse response,
                                  TimeUnit unit,
                                  long time)

设置缓存过期时间

参数:

response - 响应头

unit - 时间单元

time - 过期时间

setCacheHeader

public static void setCacheHeader(javax.servlet.http.HttpServletResponse response,
                                  long time)

设置过期时间，增加CDN和浏览器缓存策略

参数:

response - 响应头

time - 过期时间，单位秒

setNoCacheHeader

public static void setNoCacheHeader(javax.servlet.http.HttpServletResponse response)

设置Response头，加入no-cache属性

对于HTTP头HEADER会作如下处理：

• Expires: 0
• RHOST: 后端IP地址信息 IpAddressUtils.getAllLocalSiteAddress()
• Cache-Control: no-cache
• Pragma: no-cache

参数:

response - 响应头

writeJsonResponse

public static void writeJsonResponse(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     int code,
                                     String msg,
                                     Object data)
                              throws IOException

向Response写入数据，通常适用于写入字符串、Json数据、XML数据等，写入成功后会刷新输出流。

抛出:

IOException

另请参阅:

writeResponse(HttpServletRequest, HttpServletResponse, String)

writeJsonResponse

public static void writeJsonResponse(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     Object data)
                              throws IOException

抛出:

IOException

writeJsonResponse

public static void writeJsonResponse(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response,
                                     String obj)
                              throws IOException

写入JSON数据

参数:

obj - 字符串

抛出:

IOException

writeResponse

public static void writeResponse(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String obj)
                          throws IOException

向Response写入数据，通常适用于写入字符串、Json数据、XML数据等，写入成功后会刷新输出流。

此操作会写入如下信息：

1. 如果request中包含参数callback=doit，则写入格式为: callback(obj.toString());
2. 否则，写入格式为:obj.toString()

同时对于HTTP头HEADER会作如下处理：

• ContentType: text/html;charset=encoding （编码默认为UTF-8，会根据请求动态设置 ）
• Expires: 0
• RHOST: 后端IP地址信息 IpAddressUtils.getAllLocalSiteAddress()
• Cache-Control: no-cache
• Pragma: no-cache

参数:

request - HttpServletRequest

response - HttpServletResponse

obj - 要写入的对象，调用Object.toString()写入输出流

抛出:

IOException - 任何网络异常，IO异常

从以下版本开始:

2011-8-15

另请参阅:

}, IpAddressUtils#getAllLocalSiteAddress()}

writeResponse

public static void writeResponse(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 String obj,
                                 String contentType)
                          throws IOException

抛出:

IOException

isAjaxRequest

public static boolean isAjaxRequest(javax.servlet.http.HttpServletRequest request)

isSecurity

public static boolean isSecurity(String url)

URL是否是HTTPS请求

getRefer

@Deprecated
public static String getRefer(javax.servlet.http.HttpServletRequest request)

已过时。

getReferer

public static String getReferer(javax.servlet.http.HttpServletRequest request)

getRequestURL

public static String getRequestURL(javax.servlet.http.HttpServletRequest request)

获取当前请求的URL（包括schema/host/uri/querystring等)

参数:

request - Http请求

返回:

完整的URL地址（包括schema/host/uri/querystring等)

从以下版本开始:

2015年3月3日

createUrl

public static String createUrl(String uri,
                               String queryString)

encodeURL

public static String encodeURL(String url)

decodeURL

public static String decodeURL(String url)

writeCodeMsg

public static void writeCodeMsg(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                int code,
                                String msg)
                         throws IOException

抛出:

IOException

toCodeMsg

public static String toCodeMsg(int code,
                               String msg)

prepareHttpsAttribute

public static void prepareHttpsAttribute(javax.servlet.http.HttpServletRequest req)

isHttps

public static boolean isHttps(javax.servlet.http.HttpServletRequest request)

判断某个请求是否是HTTPS

getHttpsUrl

public static String getHttpsUrl(javax.servlet.http.HttpServletRequest request,
                                 String httpUrl)

自动转换http地址为https

getParameters

public static Map<String,String> getParameters(javax.servlet.http.HttpServletRequest req)