package cn.wisenergy.common.utils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.Assert;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.nio.charset.Charset;
import java.util.HashMap;
import java.util.Map;
public class WebUtils {
// 注入日志类
private static Logger log = LoggerFactory.getLogger(WebUtils.class);
/**
* 不可实例化
*/
private WebUtils() {
}
/**
* 添加cookie
*
* @param request HttpServletRequest
* @param response HttpServletResponse
* @param name cookie名称
* @param value cookie值
* @param maxAge 有效期(单位: 秒)
* @param path 路径
* @param domain 域
* @param secure 是否启用加密
*/
public static void addCookie(HttpServletRequest request, HttpServletResponse response, String name, String value, Integer maxAge, String path, String domain, Boolean secure, Boolean httpOnly) {
Assert.notNull(request, "request请求为空");
Assert.notNull(response, "response响应为空");
Assert.hasText(name, "cookie名称为空");
try {
name = URLEncoder.encode(name, "UTF-8");
value = URLEncoder.encode(value, "UTF-8");
Cookie cookie = new Cookie(name, value);
if (maxAge != null) {
cookie.setMaxAge(maxAge);
}
if (StringUtils.isNotEmpty(path)) {
cookie.setPath(path);
}
if (StringUtils.isNotEmpty(domain)) {
cookie.setDomain(domain);
}
if (secure != null) {
cookie.setSecure(secure);
}
if (httpOnly != null) {
cookie.setHttpOnly(httpOnly);
}
response.addCookie(cookie);
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
}
/**
* 添加cookie
*
* @param request HttpServletRequest
* @param response HttpServletResponse
* @param name cookie名称
* @param value cookie值
* @param maxAge 有效期(单位: 秒)
*/
public static void addCookie(HttpServletRequest request, HttpServletResponse response, String name, String value, Integer maxAge) {
addCookie(request, response, name, value, maxAge, "/", "", null, null);
}
/**
* 添加cookie【根路径】
*
* @param request
* @param response
* @param name
* @param value
* @param httpOnly
*/
public static void addCookie(HttpServletRequest request, HttpServletResponse response, String name, String value, Boolean httpOnly) {
addCookie(request, response, name, value, null, "/", "", null, httpOnly);
}
/**
* 添加cookie
*
* @param request HttpServletRequest
* @param response HttpServletResponse
* @param name cookie名称
* @param value cookie值
*/
public static void addCookie(HttpServletRequest request, HttpServletResponse response, String name, String value) {
addCookie(request, response, name, value, null, "/", "", null, null);
}
/**
* 获取cookie
*
* @param request HttpServletRequest
* @param name cookie名称
* @return 若不存在则返回null
*/
public static String getCookie(HttpServletRequest request, String name) {
Assert.notNull(request, "Request is null when receiving cookie");
Assert.hasText(name, "The name of cookie is null when receiving cookie");
Cookie[] cookies = request.getCookies();
if (cookies != null) {
try {
name = URLEncoder.encode(name, "UTF-8");
for (Cookie cookie : cookies) {
if (StringUtils.equals(name, cookie.getName())) {
return URLDecoder.decode(cookie.getValue(), "UTF-8");
}
}
} catch (UnsupportedEncodingException e) {
log.error("从Request中获取Cookie出错：{}", ExceptionUtils.getStackTrace(e));
}
}
return null;
}
/**
* 移除cookie
*
* @param request HttpServletRequest
* @param response HttpServletResponse
* @param name cookie名称
* @param path 路径
* @param domain 域
*/
public static void removeCookie(HttpServletRequest request, HttpServletResponse response, String name, String path, String domain) {
Assert.notNull(request, "Request is Null when Removing Cookie");
Assert.notNull(response, "Response is null when removing Cookie");
Assert.hasText(name, "The name of cookie is null when removing cookie");
try {
// 初始化响应Cookie对象
name = URLEncoder.encode(name, "UTF-8");
Cookie cookie = new Cookie(name, null);
cookie.setMaxAge(0); // -1 表示关闭浏览器失效 0: 立即失效 >0: 单位是秒, 多少秒后失效
if (StringUtils.isNotEmpty(path)) {
cookie.setPath(path);
}
if (StringUtils.isNotEmpty(domain)) {
cookie.setDomain(domain);
}
response.addCookie(cookie);
} catch (Exception e) {
log.error("从Request中移除Cookie出错：{}", ExceptionUtils.getStackTrace(e));
}
}
/**
* 移除cookie
*
* @param request HttpServletRequest
* @param response HttpServletResponse
* @param name cookie名称
*/
public static void removeCookie(HttpServletRequest request, HttpServletResponse response, String name) {
removeCookie(request, response, name, "/", "");
}
/**
* 获取参数
*
* @param queryString 查询字符串
* @param encoding 编码格式
* @param name 参数名称
* @return 参数
*/
public static String getParameter(String queryString, String encoding, String name) {
String[] parameterValues = getParameterMap(queryString, encoding).get(name);
return parameterValues != null && parameterValues.length > 0 ? parameterValues[0] : null;
}
/**
* 获取参数
*
* @param queryString 查询字符串
* @param encoding 编码格式
* @param name 参数名称
* @return 参数
*/
public static String[] getParameterValues(String queryString, String encoding, String name) {
return getParameterMap(queryString, encoding).get(name);
}
/**
* 获取参数
*
* @param queryString 查询字符串
* @param encoding 编码格式
* @return 参数
*/
public static Map<String, String[]> getParameterMap(String queryString, String encoding) {
Map<String, String[]> parameterMap = new HashMap<String, String[]>();
Charset charset = Charset.forName(encoding);
if (StringUtils.isNotEmpty(queryString)) {
byte[] bytes = queryString.getBytes(charset);
if (bytes != null && bytes.length > 0) {
int ix = 0;
int ox = 0;
String key = null;
String value = null;
while (ix < bytes.length) {
byte c = bytes[ix++];
switch ((char) c) {
case '&':
value = new String(bytes, 0, ox, charset);
if (key != null) {
putMapEntry(parameterMap, key, value);
key = null;
}
ox = 0;
break;
case '=':
if (key == null) {
key = new String(bytes, 0, ox, charset);
ox = 0;
} else {
bytes[ox++] = c;
}
break;
case '+':
bytes[ox++] = (byte) ' ';
break;
case '%':
bytes[ox++] = (byte) ((convertHexDigit(bytes[ix++]) << 4) + convertHexDigit(bytes[ix++]));
break;
default:
bytes[ox++] = c;
}
}
if (key != null) {
value = new String(bytes, 0, ox, charset);
putMapEntry(parameterMap, key, value);
}
}
}
return parameterMap;
}
private static void putMapEntry(Map<String, String[]> map, String name, String value) {
String[] newValues = null;
String[] oldValues = map.get(name);
if (oldValues == null) {
newValues = new String[]{value};
} else {
newValues = new String[oldValues.length + 1];
System.arraycopy(oldValues, 0, newValues, 0, oldValues.length);
newValues[oldValues.length] = value;
}
map.put(name, newValues);
}
private static byte convertHexDigit(byte b) {
if ((b >= '0') && (b <= '9')) {
return (byte) (b - '0');
}
if ((b >= 'a') && (b <= 'f')) {
return (byte) (b - 'a' + 10);
}
if ((b >= 'A') && (b <= 'F')) {
return (byte) (b - 'A' + 10);
}
throw new IllegalArgumentException();
}
}