net.ymate.platform.webmvc.util

Class WebUtils

java.lang.Object

net.ymate.platform.webmvc.util.WebUtils

public class WebUtils
extends Object

Web通用工具类

Since:

2.0.6

Author:

刘镇 (suninformation@163.com) on 14-7-6

Constructor Summary

Constructors

Constructor and Description
WebUtils()

Method Summary

Modifier and Type	Method and Description
static String	appendQueryStr(HttpServletRequest request, boolean encode)
static String	baseUrl(HttpServletRequest request)
static IView	buildErrorView(IWebMvc owner, ErrorCode errorCode)
static IView	buildErrorView(IWebMvc owner, ErrorCode errorCode, String redirectUrl, int timeInterval)
static IView	buildErrorView(IWebMvc owner, int code, String msg)
static IView	buildErrorView(IWebMvc owner, int code, String msg, String redirectUrl, int timeInterval)
static IView	buildErrorView(IWebMvc owner, int code, String msg, String redirectUrl, int timeInterval, Map<String,Object> data)
static IView	buildErrorView(IWebMvc owner, String resourceName, ErrorCode errorCode)
static IView	buildErrorView(IWebMvc owner, String resourceName, ErrorCode errorCode, String redirectUrl, int timeInterval)
static IView	buildErrorView(IWebMvc owner, String resourceName, int code, String msg, String redirectUrl, int timeInterval, Map<String,Object> data)
static IView	buildErrorView(IWebMvc owner, String resourceName, String code, String msg, String redirectUrl, int timeInterval, Map<String,Object> data)
static String	buildRedirectUrl(IContext context, HttpServletRequest request, String redirectUrl, boolean needPrefix)
static String	buildUrl(HttpServletRequest request, String requestPath, boolean withBasePath)
static String	decodeUrl(String url)
static byte[]	decryptStr(HttpServletRequest request, byte[] bytes)
static String	decryptStr(HttpServletRequest request, String dataStr) 内容解密(基于客户端IP和浏览器类型)
static String	encodeUrl(String url)
static String	encryptStr(HttpServletRequest request, byte[] bytes)
static String	encryptStr(HttpServletRequest request, String dataStr) 内容加密(基于客户端IP和浏览器类型)
static String	errorCodeI18n(IWebMvc owner, IExceptionProcessor.Result result)
static String	errorCodeI18n(IWebMvc owner, int code, String defaultValue)
static String	errorCodeI18n(IWebMvc owner, String resourceName, IExceptionProcessor.Result result)
static String	errorCodeI18n(IWebMvc owner, String resourceName, int code, String defaultValue)
static String	errorCodeI18n(IWebMvc owner, String code, String defaultValue)
static String	errorCodeI18n(IWebMvc owner, String resourceName, String code, String defaultValue)
static String	fixUrl(String url, boolean needStartWith, boolean needEndWith) Deprecated.
static String	fixUrlWithProtocol(String url, boolean needEndWith) Deprecated.
static String	getContextParamValue(IContext context, String paramName, String defaultValue)
static IWebMvc	getOwner()
static String	getRemoteAddress(HttpServletRequest request)
static String[]	getRemoteAddresses(HttpServletRequest request)
static String	httpStatusI18n(IWebMvc owner, int code)
static String	httpStatusI18n(IWebMvc owner, String resourceName, int code)
static String	i18nStr(IWebMvc owner, String resourceKey) 加载i18n资源键值
static String	i18nStr(IWebMvc owner, String resourceKey, String defaultValue) 加载i18n资源键值
static String	i18nStr(IWebMvc owner, String resourceName, String resourceKey, String defaultValue)
static String	includeJsp(HttpServletRequest request, HttpServletResponse response, String jspFile, String charsetEncoding)
static void	includeJsp(HttpServletRequest request, HttpServletResponse response, String jspFile, String charsetEncoding, OutputStream outputStream)
static boolean	isAccepted(HttpServletRequest request, String contentType)
static boolean	isAjax(HttpServletRequest request)
static boolean	isCorsOptionsRequest(HttpServletRequest request)
static boolean	isCorsRequest(HttpServletRequest request)
static boolean	isJsonAccepted(HttpServletRequest request)
static boolean	isJsonAccepted(HttpServletRequest request, String paramFormat)
static boolean	isJsonFormat(HttpServletRequest request)
static boolean	isJsonFormat(HttpServletRequest request, String paramFormat)
static boolean	isPost(HttpServletRequest request)
static boolean	isWebSocket(HttpServletRequest request)
static boolean	isXmlAccepted(HttpServletRequest request)
static boolean	isXmlAccepted(HttpServletRequest request, String paramFormat)
static boolean	isXmlFormat(HttpServletRequest request)
static boolean	isXmlFormat(HttpServletRequest request, String paramFormat)
static String	messageWithTemplate(IApplication owner, Collection<ValidateResult> messages)
static String	messageWithTemplate(IApplication owner, String message)
static String	messageWithTemplate(IApplication owner, String title, Collection<ValidateResult> messages)
static String	messageWithTemplate(IApplication owner, String name, String message)
static String	redirectHeaderLocation(HttpServletResponse response, String url)
static String	redirectHeaderRefresh(HttpServletResponse response, String templateUrl, int time, String url)
static String	redirectJavaScript(String url)
static String	replaceRegClear(String source)
static String	replaceRegText(String source, String key, String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebUtils

public WebUtils()

Method Detail

getOwner

public static IWebMvc getOwner()

buildUrl

public static String buildUrl(HttpServletRequest request,
                              String requestPath,
                              boolean withBasePath)

Parameters:

request - HttpServletRequest对象

requestPath - 控制器路径

withBasePath - 是否采用完整路径（即非相对路径）

Returns:

构建控制器URL访问路径

baseUrl

public static String baseUrl(HttpServletRequest request)

Parameters:

request - HttpServletRequest对象

Returns:

获取当前站点基准URL

appendQueryStr

public static String appendQueryStr(HttpServletRequest request,
                                    boolean encode)

Parameters:

request - HttpServletRequest对象

encode - 是否编码

Returns:

拼装当前URL请求地址(含QueryString串)

encodeUrl

public static String encodeUrl(String url)

decodeUrl

public static String decodeUrl(String url)

fixUrl

@Deprecated
public static String fixUrl(String url,
                                        boolean needStartWith,
                                        boolean needEndWith)

Deprecated.

Parameters:

url - URL地址

needStartWith - 是否以'/'开始

needEndWith - 是否以'/'结束

Returns:

返回修正后的URL地址

See Also:

ParamUtils.fixUrl(String, boolean, boolean)

fixUrlWithProtocol

@Deprecated
public static String fixUrlWithProtocol(String url,
                                                    boolean needEndWith)

Deprecated.

Parameters:

url - URL地址

needEndWith - 是否必须以分隔符结束

Returns:

返回修正后的URL地址

See Also:

ParamUtils.fixUrlWithProtocol(String, boolean)

isAjax

public static boolean isAjax(HttpServletRequest request)

Parameters:

request - HttpServletRequest对象

Returns:

是否AJAX请求（需要在使用Ajax请求时设置请求头）

isWebSocket

public static boolean isWebSocket(HttpServletRequest request)

isCorsRequest

public static boolean isCorsRequest(HttpServletRequest request)

isCorsOptionsRequest

public static boolean isCorsOptionsRequest(HttpServletRequest request)

isAccepted

public static boolean isAccepted(HttpServletRequest request,
                                 String contentType)

isJsonAccepted

public static boolean isJsonAccepted(HttpServletRequest request)

isJsonAccepted

public static boolean isJsonAccepted(HttpServletRequest request,
                                     String paramFormat)

isJsonFormat

public static boolean isJsonFormat(HttpServletRequest request)

isJsonFormat

public static boolean isJsonFormat(HttpServletRequest request,
                                   String paramFormat)

isXmlAccepted

public static boolean isXmlAccepted(HttpServletRequest request)

isXmlAccepted

public static boolean isXmlAccepted(HttpServletRequest request,
                                    String paramFormat)

isXmlFormat

public static boolean isXmlFormat(HttpServletRequest request)

isXmlFormat

public static boolean isXmlFormat(HttpServletRequest request,
                                  String paramFormat)

isPost

public static boolean isPost(HttpServletRequest request)

Parameters:

request - HttpServletRequest对象

Returns:

判断当前请求是否采用POST方式提交

redirectJavaScript

public static String redirectJavaScript(String url)

Parameters:

url - 目标URL地址

Returns:

执行JS方式的页面跳转

redirectHeaderLocation

public static String redirectHeaderLocation(HttpServletResponse response,
                                            String url)

Parameters:

response - HttpServletResponse对象

url - 目标URL地址

Returns:

通过设置Header的Location属性执行页面跳转

redirectHeaderRefresh

public static String redirectHeaderRefresh(HttpServletResponse response,
                                           String templateUrl,
                                           int time,
                                           String url)

Parameters:

response - HttpServletResponse对象

templateUrl - JSP等模板文件URL

time - 间隔时间

url - 页面URL地址，空为当前页面

Returns:

通过设置Header的Refresh属性执行页面刷新或跳转，若url参数为空，则仅向Header添加time时间后自动刷新当前页面

getRemoteAddress

public static String getRemoteAddress(HttpServletRequest request)

Parameters:

request - HttpServletRequest对象

Returns:

获取用户IP地址(当存在多个IP地址时仅返回第一个)

getRemoteAddresses

public static String[] getRemoteAddresses(HttpServletRequest request)

Parameters:

request - HttpServletRequest对象

Returns:

获取用户IP地址(以数组的形式返回所有IP)

getContextParamValue

public static String getContextParamValue(IContext context,
                                          String paramName,
                                          String defaultValue)

replaceRegText

public static String replaceRegText(String source,
                                    String key,
                                    String value)

Parameters:

source - 源字符串

key - 键

value - 值

Returns:

占位符替换

replaceRegClear

public static String replaceRegClear(String source)

includeJsp

public static String includeJsp(HttpServletRequest request,
                                HttpServletResponse response,
                                String jspFile,
                                String charsetEncoding)
                         throws ServletException,
                                IOException

Parameters:

request - HttpServletRequest对象

response - HttpServletResponse对象

jspFile - JSP文件路径

charsetEncoding - 字符编码

Returns:

执行JSP并返回HTML源码

Throws:

ServletException - 可能产生的异常

IOException - 可能产生的异常

includeJsp

public static void includeJsp(HttpServletRequest request,
                              HttpServletResponse response,
                              String jspFile,
                              String charsetEncoding,
                              OutputStream outputStream)
                       throws ServletException,
                              IOException

Throws:

ServletException

IOException

encryptStr

public static String encryptStr(HttpServletRequest request,
                                String dataStr)
                         throws Exception

内容加密(基于客户端IP和浏览器类型)

Parameters:

request - HttpServletRequest对象

dataStr - 待加密的内容

Returns:

加密后的内容

Throws:

Exception - 可能产生的异常

encryptStr

public static String encryptStr(HttpServletRequest request,
                                byte[] bytes)
                         throws Exception

Throws:

Exception

decryptStr

public static String decryptStr(HttpServletRequest request,
                                String dataStr)
                         throws Exception

内容解密(基于客户端IP和浏览器类型)

Parameters:

request - HttpServletRequest对象

dataStr - 待解密的内容

Returns:

解密后的内容

Throws:

Exception - 可能产生的异常

decryptStr

public static byte[] decryptStr(HttpServletRequest request,
                                byte[] bytes)
                         throws Exception

Throws:

Exception

messageWithTemplate

public static String messageWithTemplate(IApplication owner,
                                         String message)

messageWithTemplate

public static String messageWithTemplate(IApplication owner,
                                         String name,
                                         String message)

messageWithTemplate

public static String messageWithTemplate(IApplication owner,
                                         Collection<ValidateResult> messages)

messageWithTemplate

public static String messageWithTemplate(IApplication owner,
                                         String title,
                                         Collection<ValidateResult> messages)

buildRedirectUrl

public static String buildRedirectUrl(IContext context,
                                      HttpServletRequest request,
                                      String redirectUrl,
                                      boolean needPrefix)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   int code,
                                   String msg)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   ErrorCode errorCode)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   String resourceName,
                                   ErrorCode errorCode)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   int code,
                                   String msg,
                                   String redirectUrl,
                                   int timeInterval)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   ErrorCode errorCode,
                                   String redirectUrl,
                                   int timeInterval)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   String resourceName,
                                   ErrorCode errorCode,
                                   String redirectUrl,
                                   int timeInterval)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   int code,
                                   String msg,
                                   String redirectUrl,
                                   int timeInterval,
                                   Map<String,Object> data)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   String resourceName,
                                   int code,
                                   String msg,
                                   String redirectUrl,
                                   int timeInterval,
                                   Map<String,Object> data)

buildErrorView

public static IView buildErrorView(IWebMvc owner,
                                   String resourceName,
                                   String code,
                                   String msg,
                                   String redirectUrl,
                                   int timeInterval,
                                   Map<String,Object> data)

i18nStr

public static String i18nStr(IWebMvc owner,
                             String resourceKey)

加载i18n资源键值

Parameters:

owner - 所属容器

resourceKey - 键

Returns:

返回resourceKey指定的键值

i18nStr

public static String i18nStr(IWebMvc owner,
                             String resourceKey,
                             String defaultValue)

加载i18n资源键值

Parameters:

owner - 所属容器

resourceKey - 键

defaultValue - 默认值

Returns:

返回resourceKey指定的键值

i18nStr

public static String i18nStr(IWebMvc owner,
                             String resourceName,
                             String resourceKey,
                             String defaultValue)

httpStatusI18n

public static String httpStatusI18n(IWebMvc owner,
                                    int code)

httpStatusI18n

public static String httpStatusI18n(IWebMvc owner,
                                    String resourceName,
                                    int code)

errorCodeI18n

public static String errorCodeI18n(IWebMvc owner,
                                   int code,
                                   String defaultValue)

errorCodeI18n

public static String errorCodeI18n(IWebMvc owner,
                                   String code,
                                   String defaultValue)

errorCodeI18n

public static String errorCodeI18n(IWebMvc owner,
                                   String resourceName,
                                   int code,
                                   String defaultValue)

errorCodeI18n

public static String errorCodeI18n(IWebMvc owner,
                                   String resourceName,
                                   String code,
                                   String defaultValue)

errorCodeI18n

public static String errorCodeI18n(IWebMvc owner,
                                   IExceptionProcessor.Result result)

errorCodeI18n

public static String errorCodeI18n(IWebMvc owner,
                                   String resourceName,
                                   IExceptionProcessor.Result result)