com.easycodebox.common.net

类 HttpUtils

java.lang.Object

com.easycodebox.common.net.HttpUtils

public class HttpUtils
extends Object

作者:

WangXiaoJin

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HttpUtils.Request

构造器概要

构造器

构造器和说明
HttpUtils()

方法概要

限定符和类型	方法和说明
static void	addCookie(String name, String value, javax.servlet.http.HttpServletResponse response) 不存储cookie，浏览器关闭则删除cookie
static void	addCookie(String name, String value, Integer maxAge, javax.servlet.http.HttpServletResponse response)
static String	addParams2Url(String url, String params) 给指定的url增加参数字符窜，根据url的“？”
static String	assembleParams(Map<?,?> params, Collection<?> jsonKeys, String... excludeKeys) 把参数转换成url中的键值对
static Map<String,String>	convertQueryParams2Map(String query)
static void	download(File srcFile, String filename, javax.servlet.http.HttpServletResponse response) 下载文件
static void	download(InputStream inputStream, String filename, javax.servlet.http.HttpServletResponse response) 下载文件
static String	getBasePath(javax.servlet.http.HttpServletRequest request) 获取请求的根路径 http://www.xx.com ==> http://www.xx.com http://www.xx.com/a/b.html ==> http://www.xx.com http://localhost:8080/test/a/b.html ==> http://localhost:8080/test
static javax.servlet.http.Cookie	getCookie(String cookieName, javax.servlet.http.HttpServletRequest request)
static String	getCookieVal(String cookieName, javax.servlet.http.HttpServletRequest request)
static <T> T	getCookieVal(String cookieName, javax.servlet.http.HttpServletRequest request, Class<T> clazz)
static String	getFullRequestUri(javax.servlet.http.HttpServletRequest request, boolean encode, String... excludeKeys) 获取请求地址信息，包含参数。
static String	getFullRequestUrl(javax.servlet.http.HttpServletRequest request, boolean encode, String... excludeKeys) 获取请求地址信息，包含参数。
static String	getIpAddr(javax.servlet.http.HttpServletRequest request) 获得客户端ip
static String	getParticularPath(javax.servlet.http.HttpServletRequest request) 获取请求特有的path http://www.xx.com ==> "" http://www.xx.com/a/b.html ==> /a/b.html http://localhost:8080/test/a/b.html ==> /a/b.html
static String[]	getParticularPaths(javax.servlet.http.HttpServletRequest request) http://www.xxx.com/shop/list.do ==> [shop, list] http://www.xxx.com/js/util.js ==> [js, util]
static String	getRequestParams(javax.servlet.http.HttpServletRequest request, boolean encode, String... excludeKeys) 获取请求的参数 例：name=wangxj&shop=wxj
static String	getRequestUrlAndParams(javax.servlet.http.HttpServletRequest request) 获取请求地址信息，包含参数 数组会转换成[1,2]形式
static String	getShortPath(javax.servlet.http.HttpServletRequest request) 获取简短的请求路径 http://www.xx.com ==> "" http://www.xx.com/a/b.html ==> /a/b http://localhost:8080/test/a/b.html ==> /a/b
static boolean	isAjaxRequest(javax.servlet.http.HttpServletRequest request) 判断是否为ajax请求
static boolean	isResponseHtml(javax.servlet.http.HttpServletRequest request) 判断是否为ajax请求
static boolean	isResponseJson(javax.servlet.http.HttpServletRequest request) 判断是否为ajax请求
static void	outHtml(Object obj, javax.servlet.http.HttpServletResponse response) 以HTML格式输出
static void	outHtml(String str, javax.servlet.http.HttpServletResponse response) 以HTML格式输出
static void	outHtmlJs(String str, javax.servlet.http.HttpServletResponse response) 以HTML格式输出JS,给str 头尾自动加上<script type="text/javascript"> </script>
static void	outJs(Object obj, javax.servlet.http.HttpServletResponse response) 以js格式输出
static void	outJs(String str, javax.servlet.http.HttpServletResponse response) 以js格式输出
static void	outJson(Object obj, javax.servlet.http.HttpServletResponse response) 以Json格式输出
static void	outJson(String str, javax.servlet.http.HttpServletResponse response) 以Json格式输出
static void	outObject(Object obj, javax.servlet.http.HttpServletResponse response) 把对象输出到客户端
static void	outPlainString(Object obj, javax.servlet.http.HttpServletResponse response) 以文本的格式输出
static void	outPlainString(String str, javax.servlet.http.HttpServletResponse response) 以文本的格式输出
static void	outString(String str, javax.servlet.http.HttpServletResponse response) 把字符输出到客户端
static void	outXml(Object obj, javax.servlet.http.HttpServletResponse response) 以XML格式输出
static void	outXml(String str, javax.servlet.http.HttpServletResponse response) 以XML格式输出
static void	removeCookie(String cookieName, javax.servlet.http.HttpServletResponse response)

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

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

构造器详细资料

HttpUtils

public HttpUtils()

方法详细资料

getIpAddr

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

获得客户端ip

参数:

request -

返回:

getRequestUrlAndParams

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

获取请求地址信息，包含参数 数组会转换成[1,2]形式

convertQueryParams2Map

public static Map<String,String> convertQueryParams2Map(String query)

getFullRequestUri

public static String getFullRequestUri(javax.servlet.http.HttpServletRequest request,
                                       boolean encode,
                                       String... excludeKeys)
                                throws UnsupportedEncodingException

获取请求地址信息，包含参数。例：/backend/group/list.html?name=xxx 直接封装成有效的请求地址

参数:

encode - 编码参数

抛出:

UnsupportedEncodingException

getFullRequestUrl

public static String getFullRequestUrl(javax.servlet.http.HttpServletRequest request,
                                       boolean encode,
                                       String... excludeKeys)
                                throws UnsupportedEncodingException

获取请求地址信息，包含参数。例：http://localhost:8080/backend/group/list.html?name=xxx 直接封装成有效的请求地址

参数:

encode - 编码参数

抛出:

UnsupportedEncodingException

getParticularPath

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

获取请求特有的path
http://www.xx.com ==> ""
http://www.xx.com/a/b.html ==> /a/b.html
http://localhost:8080/test/a/b.html ==> /a/b.html

参数:

request -

返回:

getShortPath

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

获取简短的请求路径
http://www.xx.com ==> ""
http://www.xx.com/a/b.html ==> /a/b
http://localhost:8080/test/a/b.html ==> /a/b

参数:

request -

返回:

getBasePath

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

获取请求的根路径 http://www.xx.com ==> http://www.xx.com http://www.xx.com/a/b.html ==> http://www.xx.com http://localhost:8080/test/a/b.html ==> http://localhost:8080/test

参数:

request -

返回:

getParticularPaths

public static String[] getParticularPaths(javax.servlet.http.HttpServletRequest request)

http://www.xxx.com/shop/list.do ==> [shop, list] http://www.xxx.com/js/util.js ==> [js, util]

参数:

request -

返回:

getRequestParams

public static String getRequestParams(javax.servlet.http.HttpServletRequest request,
                                      boolean encode,
                                      String... excludeKeys)
                               throws UnsupportedEncodingException

获取请求的参数 例：name=wangxj&shop=wxj

参数:

request -

返回:

抛出:

UnsupportedEncodingException

assembleParams

public static String assembleParams(Map<?,?> params,
                                    Collection<?> jsonKeys,
                                    String... excludeKeys)
                             throws com.fasterxml.jackson.core.JsonGenerationException,
                                    com.fasterxml.jackson.databind.JsonMappingException,
                                    IOException

把参数转换成url中的键值对

参数:

params -

jsonKeys - 指定哪些key的值用json解析

excludeKeys - 排除的key

返回:

抛出:

IOException

com.fasterxml.jackson.databind.JsonMappingException

com.fasterxml.jackson.core.JsonGenerationException

addParams2Url

public static String addParams2Url(String url,
                                   String params)

给指定的url增加参数字符窜，根据url的“？”字符返回相对应的格式字符窜

参数:

url -

params -

返回:

isAjaxRequest

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

判断是否为ajax请求

参数:

request -

返回:

isResponseJson

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

判断是否为ajax请求

参数:

request -

返回:

isResponseHtml

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

判断是否为ajax请求

参数:

request -

返回:

addCookie

public static void addCookie(String name,
                             String value,
                             javax.servlet.http.HttpServletResponse response)

不存储cookie，浏览器关闭则删除cookie

参数:

name -

value -

response -

addCookie

public static void addCookie(String name,
                             String value,
                             Integer maxAge,
                             javax.servlet.http.HttpServletResponse response)

参数:

name -

value -

maxAge - 单位/秒

response -

getCookie

public static javax.servlet.http.Cookie getCookie(String cookieName,
                                                  javax.servlet.http.HttpServletRequest request)

getCookieVal

public static String getCookieVal(String cookieName,
                                  javax.servlet.http.HttpServletRequest request)

getCookieVal

public static <T> T getCookieVal(String cookieName,
                                 javax.servlet.http.HttpServletRequest request,
                                 Class<T> clazz)

removeCookie

public static void removeCookie(String cookieName,
                                javax.servlet.http.HttpServletResponse response)

outString

public static void outString(String str,
                             javax.servlet.http.HttpServletResponse response)

把字符输出到客户端

outObject

public static void outObject(Object obj,
                             javax.servlet.http.HttpServletResponse response)

把对象输出到客户端

outPlainString

public static void outPlainString(String str,
                                  javax.servlet.http.HttpServletResponse response)

以文本的格式输出

outPlainString

public static void outPlainString(Object obj,
                                  javax.servlet.http.HttpServletResponse response)

以文本的格式输出

outJs

public static void outJs(String str,
                         javax.servlet.http.HttpServletResponse response)

以js格式输出

outJs

public static void outJs(Object obj,
                         javax.servlet.http.HttpServletResponse response)

以js格式输出

outXml

public static void outXml(String str,
                          javax.servlet.http.HttpServletResponse response)

以XML格式输出

outXml

public static void outXml(Object obj,
                          javax.servlet.http.HttpServletResponse response)

以XML格式输出

outHtml

public static void outHtml(String str,
                           javax.servlet.http.HttpServletResponse response)

以HTML格式输出

outHtmlJs

public static void outHtmlJs(String str,
                             javax.servlet.http.HttpServletResponse response)

以HTML格式输出JS,给str 头尾自动加上<script type="text/javascript"> </script>

outHtml

public static void outHtml(Object obj,
                           javax.servlet.http.HttpServletResponse response)

以HTML格式输出

outJson

public static void outJson(String str,
                           javax.servlet.http.HttpServletResponse response)

以Json格式输出

outJson

public static void outJson(Object obj,
                           javax.servlet.http.HttpServletResponse response)

以Json格式输出

download

public static void download(File srcFile,
                            String filename,
                            javax.servlet.http.HttpServletResponse response)
                     throws IOException

下载文件

参数:

srcFile - 下载的源文件

filename - 下载到客户端的文件名

response -

抛出:

IOException

download

public static void download(InputStream inputStream,
                            String filename,
                            javax.servlet.http.HttpServletResponse response)
                     throws IOException

下载文件

参数:

inputStream - 输入流，此流需要自己关闭，此方法不会帮你关闭

filename - 下载到客户端的文件名

抛出:

IOException