com.xiaoleilu.hutool.http

类 HttpUtil

java.lang.Object

com.xiaoleilu.hutool.http.HttpUtil

public class HttpUtil
extends Object

Http请求工具类

作者:

xiaoleilu

字段概要

字段

限定符和类型	字段和说明
static Pattern	CHARSET_PATTERN

构造器概要

构造器

构造器和说明
HttpUtil()

方法概要

方法

限定符和类型	方法和说明
static String	decode(String content, Charset charset) 解码application/x-www-form-urlencoded字符
static String	decode(String content, String charsetStr) 解码application/x-www-form-urlencoded字符
static Map<String,List<String>>	decodeParams(String paramsStr, String charset) 将URL参数解析为Map（也可以解析Post中的键值对参数）
static long	download(String url, OutputStream out, boolean isCloseOut) 下载远程文件
static long	download(String url, OutputStream out, boolean isCloseOut, StreamProgress streamProgress) 下载远程文件
static long	downloadFile(String url, File destFile) 下载远程文件
static long	downloadFile(String url, File destFile, StreamProgress streamProgress) 下载远程文件
static String	downloadString(String url, Charset customCharset) 下载远程文本
static String	downloadString(String url, Charset customCharset, StreamProgress streamPress) 下载远程文本
static String	downloadString(String url, String customCharsetName) 下载远程文本
static String	encode(String content, Charset charset) 编码字符为 application/x-www-form-urlencoded
static String	encode(String content, String charsetStr) 编码字符为 application/x-www-form-urlencoded
static String	get(String urlString) 发送get请求
static String	get(String urlString, Map<String,Object> paramMap) 发送get请求
static String	get(String urlString, String customCharset) 发送get请求
static String	getCharset(HttpURLConnection conn) 从Http连接的头信息中获得字符集 从ContentType中获取
static String	getClientIP(javax.servlet.http.HttpServletRequest request, String... otherHeaderNames) 获取客户端IP 默认检测的Header： 1、X-Forwarded-For 2、X-Real-IP 3、Proxy-Client-IP 4、WL-Proxy-Client-IP otherHeaderNames参数用于自定义检测的Header
static String	getMimeType(String filePath) 根据文件扩展名获得MimeType
static String	getMultistageReverseProxyIp(String ip) 从多级反向代理中获得第一个非unknown IP地址
static String	getString(InputStream in, String charset, boolean isGetCharsetFromContent) 从流中读取内容
static boolean	isHttps(String url) 检测是否https
static boolean	isUnknow(String checkString) 检测给定字符串是否为未知，多用于检测HTTP请求相关
static String	post(String urlString, Map<String,Object> paramMap) 发送post请求
static String	post(String urlString, String params) 发送post请求
static String	toParams(Map<String,Object> paramMap) 将Map形式的Form表单数据转换为Url参数形式，不做编码
static String	toParams(Map<String,Object> paramMap, Charset charset) 将Map形式的Form表单数据转换为Url参数形式 编码键和值对
static String	toParams(Map<String,Object> paramMap, String charsetName) 将Map形式的Form表单数据转换为Url参数形式 编码键和值对
static String	urlWithForm(String url, Map<String,Object> form) 将表单数据加到URL中（用于GET表单提交）
static String	urlWithForm(String url, String queryString) 将表单数据字符串加到URL中（用于GET表单提交）

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

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

字段详细资料

CHARSET_PATTERN

public static final Pattern CHARSET_PATTERN

构造器详细资料

HttpUtil

public HttpUtil()

方法详细资料

encode

public static String encode(String content,
            Charset charset)

编码字符为 application/x-www-form-urlencoded

参数:

content - 被编码内容

charset - 编码

返回:

编码后的字符

encode

public static String encode(String content,
            String charsetStr)

编码字符为 application/x-www-form-urlencoded

参数:

content - 被编码内容

charsetStr - 编码

返回:

编码后的字符

decode

public static String decode(String content,
            Charset charset)

解码application/x-www-form-urlencoded字符

参数:

content - 被解码内容

charset - 编码

返回:

编码后的字符

decode

public static String decode(String content,
            String charsetStr)

解码application/x-www-form-urlencoded字符

参数:

content - 被解码内容

charsetStr - 编码

返回:

编码后的字符

getClientIP

public static String getClientIP(javax.servlet.http.HttpServletRequest request,
                 String... otherHeaderNames)

获取客户端IP
默认检测的Header：
1、X-Forwarded-For
2、X-Real-IP
3、Proxy-Client-IP
4、WL-Proxy-Client-IP
otherHeaderNames参数用于自定义检测的Header

参数:

request - 请求对象

otherHeaderNames - 其他自定义头文件

返回:

IP地址

isHttps

public static boolean isHttps(String url)

检测是否https

参数:

url - URL

返回:

是否https

get

public static String get(String urlString,
         String customCharset)

发送get请求

参数:

urlString - 网址

customCharset - 自定义请求字符集，如果字符集获取不到，使用此字符集

返回:

返回内容，如果只检查状态码，正常只返回 ""，不正常返回 null

抛出:

IOException

get

public static String get(String urlString)

发送get请求

参数:

urlString - 网址

返回:

返回内容，如果只检查状态码，正常只返回 ""，不正常返回 null

抛出:

IOException

get

public static String get(String urlString,
         Map<String,Object> paramMap)

发送get请求

参数:

urlString - 网址

paramMap - post表单数据

返回:

返回数据

抛出:

IOException

post

public static String post(String urlString,
          Map<String,Object> paramMap)

发送post请求

参数:

urlString - 网址

paramMap - post表单数据

返回:

返回数据

抛出:

IOException

post

public static String post(String urlString,
          String params)

发送post请求

参数:

urlString - 网址

params - post表单数据

返回:

返回数据

抛出:

IOException

downloadString

public static String downloadString(String url,
                    String customCharsetName)

下载远程文本

参数:

url - 请求的url

customCharsetName - 自定义的字符集

返回:

文本

抛出:

IOException

downloadString

public static String downloadString(String url,
                    Charset customCharset)

下载远程文本

参数:

url - 请求的url

customCharset - 自定义的字符集，可以使用CharsetUtil.charset(java.lang.String) 方法转换

返回:

文本

抛出:

IOException

downloadString

public static String downloadString(String url,
                    Charset customCharset,
                    StreamProgress streamPress)

下载远程文本

参数:

url - 请求的url

customCharset - 自定义的字符集，可以使用CharsetUtil.charset(java.lang.String) 方法转换

streamPress - 进度条 StreamProgress

返回:

文本

抛出:

IOException

downloadFile

public static long downloadFile(String url,
                File destFile)

下载远程文件

参数:

url - 请求的url

destFile - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名

返回:

文件大小

抛出:

IOException

downloadFile

public static long downloadFile(String url,
                File destFile,
                StreamProgress streamProgress)

下载远程文件

参数:

url - 请求的url

destFile - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名

streamProgress - 进度条

返回:

文件大小

抛出:

IOException

download

public static long download(String url,
            OutputStream out,
            boolean isCloseOut)

下载远程文件

参数:

url - 请求的url

out - 将下载内容写到输出流中 OutputStream

isCloseOut - 是否关闭输出流

返回:

文件大小

抛出:

IOException

download

public static long download(String url,
            OutputStream out,
            boolean isCloseOut,
            StreamProgress streamProgress)

下载远程文件

参数:

url - 请求的url

out - 将下载内容写到输出流中 OutputStream

isCloseOut - 是否关闭输出流

streamProgress - 进度条

返回:

文件大小

抛出:

IOException

toParams

public static String toParams(Map<String,Object> paramMap)

将Map形式的Form表单数据转换为Url参数形式，不做编码

参数:

paramMap - 表单数据

返回:

url参数

toParams

public static String toParams(Map<String,Object> paramMap,
              String charsetName)

将Map形式的Form表单数据转换为Url参数形式
编码键和值对

参数:

paramMap - 表单数据

charsetName - 编码

返回:

url参数

toParams

public static String toParams(Map<String,Object> paramMap,
              Charset charset)

将Map形式的Form表单数据转换为Url参数形式
编码键和值对

参数:

paramMap - 表单数据

charset - 编码

返回:

url参数

decodeParams

public static Map<String,List<String>> decodeParams(String paramsStr,
                                    String charset)

将URL参数解析为Map（也可以解析Post中的键值对参数）

参数:

paramsStr - 参数字符串（或者带参数的Path）

charset - 字符集

返回:

参数Map

urlWithForm

public static String urlWithForm(String url,
                 Map<String,Object> form)

将表单数据加到URL中（用于GET表单提交）

参数:

url - URL

form - 表单数据

返回:

合成后的URL

urlWithForm

public static String urlWithForm(String url,
                 String queryString)

将表单数据字符串加到URL中（用于GET表单提交）

参数:

url - URL

queryString - 表单数据字符串

返回:

拼接后的字符串

getCharset

public static String getCharset(HttpURLConnection conn)

从Http连接的头信息中获得字符集
从ContentType中获取

参数:

conn - HTTP连接对象

返回:

字符集

getMultistageReverseProxyIp

public static String getMultistageReverseProxyIp(String ip)

从多级反向代理中获得第一个非unknown IP地址

参数:

ip - 获得的IP地址

返回:

第一个非unknown IP地址

isUnknow

public static boolean isUnknow(String checkString)

检测给定字符串是否为未知，多用于检测HTTP请求相关

参数:

checkString - 被检测的字符串

返回:

是否未知

getString

public static String getString(InputStream in,
               String charset,
               boolean isGetCharsetFromContent)
                        throws IOException

从流中读取内容

参数:

in - 输入流

charset - 字符集

返回:

内容

抛出:

IOException

getMimeType

public static String getMimeType(String filePath)

根据文件扩展名获得MimeType

参数:

filePath - 文件路径或文件名

返回:

MimeType