HttpUtil (hutool-http 4.6.2 API)

java.lang.Object
- cn.hutool.http.HttpUtil

```
public class HttpUtil
extends Object
```
Http请求工具类

作者:

xiaoleilu

字段概要

字段
限定符和类型	字段和说明
`static Pattern`	`CHARSET_PATTERN` 正则：Content-Type中的编码信息
`static Pattern`	`META_CHARSET_PATTERN` 正则：匹配meta标签的编码信息

构造器概要

构造器
构造器和说明

HttpUtil()

构造器
构造器和说明
`HttpUtil()`

方法概要

方法
限定符和类型	方法和说明
`static HttpRequest`	`createGet(String url)` 创建Http GET请求对象
`static HttpRequest`	`createPost(String url)` 创建Http POST请求对象
`static HttpRequest`	`createRequest(Method method, String url)` 创建Http请求对象
`static HashMap<String,String>`	`decodeParamMap(String paramsStr, String charset)` 将URL参数解析为Map（也可以解析Post中的键值对参数）
`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, int timeout)` 下载远程文件
`static long`	`downloadFile(String url, File destFile, int timeout, StreamProgress streamProgress)` 下载远程文件
`static long`	`downloadFile(String url, File destFile, StreamProgress streamProgress)` 下载远程文件
`static long`	`downloadFile(String url, String dest)` 下载远程文件
`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`	`encodeParams(String paramsStr, Charset charset)` 对URL参数做编码，只编码键和值提供的值可以是url附带参数，但是不能只是url 注意，此方法只能标准化整个URL，并不适合于单独编码参数值
`static String`	`get(String urlString)` 发送get请求
`static String`	`get(String urlString, Charset customCharset)` 发送get请求
`static String`	`get(String urlString, int timeout)` 发送get请求
`static String`	`get(String urlString, Map<String,Object> paramMap)` 发送get请求
`static String`	`get(String urlString, Map<String,Object> paramMap, int timeout)` 发送get请求
`static String`	`getCharset(HttpURLConnection conn)` 从Http连接的头信息中获得字符集从ContentType中获取
`static String`	`getContentTypeByRequestBody(String body)` 从请求参数的body中判断请求的Content-Type类型，支持的类型有： 1. application/json 1. application/xml
`static String`	`getMimeType(String filePath)` 根据文件扩展名获得MimeType
`static String`	`getString(byte[] contentBytes, Charset charset, boolean isGetCharsetFromContent)` 从流中读取内容首先尝试使用charset编码读取内容（如果为空默认UTF-8），如果isGetCharsetFromContent为true，则通过正则在正文中获取编码信息，转换为指定编码；
`static String`	`getString(InputStream in, Charset charset, boolean isGetCharsetFromContent)` 从流中读取内容首先尝试使用charset编码读取内容（如果为空默认UTF-8），如果isGetCharsetFromContent为true，则通过正则在正文中获取编码信息，转换为指定编码；
`static boolean`	`isHttps(String url)` 检测是否https
`static String`	`normalizeParams(String paramPart, Charset charset)` 标准化参数字符串，即URL中？
`static String`	`post(String urlString, Map<String,Object> paramMap)` 发送post请求
`static String`	`post(String urlString, Map<String,Object> paramMap, int timeout)` 发送post请求
`static String`	`post(String urlString, String body)` 发送post请求请求体body参数支持两种类型： 1.
`static String`	`post(String urlString, String body, int timeout)` 发送post请求请求体body参数支持两种类型： 1.
`static String`	`toParams(Map<String,?> paramMap)` 将Map形式的Form表单数据转换为Url参数形式，不做编码
`static String`	`toParams(Map<String,?> paramMap, Charset charset)` 将Map形式的Form表单数据转换为Url参数形式 paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）会自动url编码键和值 key1=v1&key2=&key3=v3
`static String`	`toParams(Map<String,Object> paramMap, String charsetName)` 将Map形式的Form表单数据转换为Url参数形式编码键和值对
`static String`	`urlWithForm(String url, Map<String,Object> form, Charset charset, boolean isEncodeParams)` 将表单数据加到URL中（用于GET表单提交）表单的键值对会被url编码，但是url中原参数不会被编码
`static String`	`urlWithForm(String url, String queryString, Charset charset, boolean isEncode)` 将表单数据字符串加到URL中（用于GET表单提交）

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CHARSET_PATTERN
```
public static final Pattern CHARSET_PATTERN
```
    正则：Content-Type中的编码信息
  - META_CHARSET_PATTERN
```
public static final Pattern META_CHARSET_PATTERN
```
    正则：匹配meta标签的编码信息
- 构造器详细资料
  - HttpUtil
```
public HttpUtil()
```
- 方法详细资料
  - isHttps
```
public static boolean isHttps(String url)
```
    检测是否https
    
    参数:
    url - URL
    
    返回:
    是否https
  - createRequest
```
public static HttpRequest createRequest(Method method,
                        String url)
```
    创建Http请求对象
    
    参数:
    method - 方法枚举Method
    url - 请求的URL，可以使HTTP或者HTTPS
    
    返回:
    HttpRequest
    从以下版本开始:
    
    3.0.9
  - createGet
```
public static HttpRequest createGet(String url)
```
    创建Http GET请求对象
    
    参数:
    url - 请求的URL，可以使HTTP或者HTTPS
    
    返回:
    HttpRequest
    从以下版本开始:
    
    3.2.0
  - createPost
```
public static HttpRequest createPost(String url)
```
    创建Http POST请求对象
    
    参数:
    url - 请求的URL，可以使HTTP或者HTTPS
    
    返回:
    HttpRequest
    从以下版本开始:
    
    3.2.0
  - get
```
public static String get(String urlString,
         Charset customCharset)
```
    发送get请求
    
    参数:
    urlString - 网址
    customCharset - 自定义请求字符集，如果字符集获取不到，使用此字符集
    
    返回:
    返回内容，如果只检查状态码，正常只返回 ""，不正常返回 null
  - get
```
public static String get(String urlString)
```
    发送get请求
    
    参数:
    urlString - 网址
    
    返回:
    返回内容，如果只检查状态码，正常只返回 ""，不正常返回 null
  - get
```
public static String get(String urlString,
         int timeout)
```
    发送get请求
    
    参数:
    urlString - 网址
    timeout - 超时时长，-1表示默认超时，单位毫秒
    
    返回:
    返回内容，如果只检查状态码，正常只返回 ""，不正常返回 null
    从以下版本开始:
    
    3.2.0
  - get
```
public static String get(String urlString,
         Map<String,Object> paramMap)
```
    发送get请求
    
    参数:
    urlString - 网址
    paramMap - post表单数据
    
    返回:
    返回数据
  - get
```
public static String get(String urlString,
         Map<String,Object> paramMap,
         int timeout)
```
    发送get请求
    
    参数:
    urlString - 网址
    paramMap - post表单数据
    timeout - 超时时长，-1表示默认超时，单位毫秒
    
    返回:
    返回数据
    从以下版本开始:
    
    3.3.0
  - post
```
public static String post(String urlString,
          Map<String,Object> paramMap)
```
    发送post请求
    
    参数:
    urlString - 网址
    paramMap - post表单数据
    
    返回:
    返回数据
  - post
```
public static String post(String urlString,
          Map<String,Object> paramMap,
          int timeout)
```
    发送post请求
    
    参数:
    urlString - 网址
    paramMap - post表单数据
    timeout - 超时时长，-1表示默认超时，单位毫秒
    
    返回:
    返回数据
    从以下版本开始:
    
    3.2.0
  - post
```
public static String post(String urlString,
          String body)
```
    发送post请求
    请求体body参数支持两种类型：
```
 1. 标准参数，例如 a=1&b=2 这种格式
 2. Rest模式，此时body需要传入一个JSON或者XML字符串，Hutool会自动绑定其对应的Content-Type
 
```
    参数:
    urlString - 网址
    body - post表单数据
    
    返回:
    返回数据
  - post
```
public static String post(String urlString,
          String body,
          int timeout)
```
    发送post请求
    请求体body参数支持两种类型：
```
 1. 标准参数，例如 a=1&b=2 这种格式
 2. Rest模式，此时body需要传入一个JSON或者XML字符串，Hutool会自动绑定其对应的Content-Type
 
```
    参数:
    urlString - 网址
    body - post表单数据
    timeout - 超时时长，-1表示默认超时，单位毫秒
    
    返回:
    返回数据
    从以下版本开始:
    
    3.2.0
  - downloadString
```
public static String downloadString(String url,
                    String customCharsetName)
```
    下载远程文本
    
    参数:
    url - 请求的url
    customCharsetName - 自定义的字符集
    
    返回:
    文本
  - downloadString
```
public static String downloadString(String url,
                    Charset customCharset)
```
    下载远程文本
    
    参数:
    url - 请求的url
    customCharset - 自定义的字符集，可以使用CharsetUtil.charset(java.lang.String) 方法转换
    
    返回:
    文本
  - downloadString
```
public static String downloadString(String url,
                    Charset customCharset,
                    StreamProgress streamPress)
```
    下载远程文本
    
    参数:
    url - 请求的url
    customCharset - 自定义的字符集，可以使用CharsetUtil.charset(java.lang.String) 方法转换
    streamPress - 进度条 StreamProgress
    
    返回:
    文本
  - downloadFile
```
public static long downloadFile(String url,
                String dest)
```
    下载远程文件
    
    参数:
    url - 请求的url
    dest - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名
    
    返回:
    文件大小
  - downloadFile
```
public static long downloadFile(String url,
                File destFile)
```
    下载远程文件
    
    参数:
    url - 请求的url
    destFile - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名
    
    返回:
    文件大小
  - downloadFile
```
public static long downloadFile(String url,
                File destFile,
                int timeout)
```
    下载远程文件
    
    参数:
    url - 请求的url
    destFile - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名
    timeout - 超时，单位毫秒，-1表示默认超时
    
    返回:
    文件大小
    从以下版本开始:
    
    4.0.4
  - downloadFile
```
public static long downloadFile(String url,
                File destFile,
                StreamProgress streamProgress)
```
    下载远程文件
    
    参数:
    url - 请求的url
    destFile - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名
    streamProgress - 进度条
    
    返回:
    文件大小
  - downloadFile
```
public static long downloadFile(String url,
                File destFile,
                int timeout,
                StreamProgress streamProgress)
```
    下载远程文件
    
    参数:
    url - 请求的url
    destFile - 目标文件或目录，当为目录时，取URL中的文件名，取不到使用编码后的URL做为文件名
    timeout - 超时，单位毫秒，-1表示默认超时
    streamProgress - 进度条
    
    返回:
    文件大小
    从以下版本开始:
    
    4.0.4
  - download
```
public static long download(String url,
            OutputStream out,
            boolean isCloseOut)
```
    下载远程文件
    
    参数:
    url - 请求的url
    out - 将下载内容写到输出流中 OutputStream
    isCloseOut - 是否关闭输出流
    
    返回:
    文件大小
  - download
```
public static long download(String url,
            OutputStream out,
            boolean isCloseOut,
            StreamProgress streamProgress)
```
    下载远程文件
    
    参数:
    url - 请求的url
    out - 将下载内容写到输出流中 OutputStream
    isCloseOut - 是否关闭输出流
    streamProgress - 进度条
    
    返回:
    文件大小
  - toParams
```
public static String toParams(Map<String,?> 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,?> paramMap,
              Charset charset)
```
    将Map形式的Form表单数据转换为Url参数形式
    paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）
    会自动url编码键和值
```
 key1=v1&key2=&key3=v3
 
```
    参数:
    paramMap - 表单数据
    charset - 编码
    
    返回:
    url参数
  - encodeParams
```
public static String encodeParams(String paramsStr,
                  Charset charset)
```
    对URL参数做编码，只编码键和值
    提供的值可以是url附带参数，但是不能只是url
    注意，此方法只能标准化整个URL，并不适合于单独编码参数值
    
    参数:
    paramsStr - url参数，可以包含url本身
    charset - 编码
    
    返回:
    编码后的url和参数
    从以下版本开始:
    
    4.0.1
  - normalizeParams
```
public static String normalizeParams(String paramPart,
                     Charset charset)
```
    标准化参数字符串，即URL中？后的部分
    注意，此方法只能标准化整个URL，并不适合于单独编码参数值
    
    参数:
    paramPart - 参数字符串
    charset - 编码
    
    返回:
    标准化的参数字符串
    从以下版本开始:
    
    4.5.2
  - decodeParamMap
```
public static HashMap<String,String> decodeParamMap(String paramsStr,
                                    String charset)
```
    将URL参数解析为Map（也可以解析Post中的键值对参数）
    
    参数:
    paramsStr - 参数字符串（或者带参数的Path）
    charset - 字符集
    
    返回:
    参数Map
    从以下版本开始:
    
    4.0.2
  - 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,
                 Charset charset,
                 boolean isEncodeParams)
```
    将表单数据加到URL中（用于GET表单提交）
    表单的键值对会被url编码，但是url中原参数不会被编码
    
    参数:
    url - URL
    form - 表单数据
    charset - 编码
    isEncodeParams - 是否对键和值做转义处理
    
    返回:
    合成后的URL
  - urlWithForm
```
public static String urlWithForm(String url,
                 String queryString,
                 Charset charset,
                 boolean isEncode)
```
    将表单数据字符串加到URL中（用于GET表单提交）
    
    参数:
    url - URL
    queryString - 表单数据字符串
    charset - 编码
    isEncode - 是否对键和值做转义处理
    
    返回:
    拼接后的字符串
  - getCharset
```
public static String getCharset(HttpURLConnection conn)
```
    从Http连接的头信息中获得字符集
    从ContentType中获取
    
    参数:
    conn - HTTP连接对象
    
    返回:
    字符集
  - getString
```
public static String getString(InputStream in,
               Charset charset,
               boolean isGetCharsetFromContent)
                        throws IOException
```
    从流中读取内容
    首先尝试使用charset编码读取内容（如果为空默认UTF-8），如果isGetCharsetFromContent为true，则通过正则在正文中获取编码信息，转换为指定编码；
    
    参数:
    in - 输入流
    charset - 字符集
    isGetCharsetFromContent - 是否从返回内容中获得编码信息
    
    返回:
    内容
    
    抛出:
    
    IOException - IO异常
  - getString
```
public static String getString(byte[] contentBytes,
               Charset charset,
               boolean isGetCharsetFromContent)
```
    从流中读取内容
    首先尝试使用charset编码读取内容（如果为空默认UTF-8），如果isGetCharsetFromContent为true，则通过正则在正文中获取编码信息，转换为指定编码；
    
    参数:
    contentBytes - 内容byte数组
    charset - 字符集
    isGetCharsetFromContent - 是否从返回内容中获得编码信息
    
    返回:
    内容
  - getMimeType
```
public static String getMimeType(String filePath)
```
    根据文件扩展名获得MimeType
    
    参数:
    filePath - 文件路径或文件名
    
    返回:
    MimeType
    另请参阅:
    FileUtil.getMimeType(String)
  - getContentTypeByRequestBody
```
public static String getContentTypeByRequestBody(String body)
```
    从请求参数的body中判断请求的Content-Type类型，支持的类型有：
```
 1. application/json
 1. application/xml
 
```
    参数:
    body - 请求参数体
    
    返回:
    Content-Type类型，如果无法判断返回null
    从以下版本开始:
    
    3.2.0
    
    另请参阅:
    ContentType.get(String)

类 HttpUtil

字段概要

构造器概要

方法概要

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

字段详细资料

CHARSET_PATTERN

META_CHARSET_PATTERN

构造器详细资料

HttpUtil

方法详细资料

isHttps

createRequest

createGet

createPost

get

get

get

get

get

post

post

post

post

downloadString

downloadString

downloadString

downloadFile

downloadFile

downloadFile

downloadFile

downloadFile

download

download

toParams

toParams

toParams

encodeParams

normalizeParams

decodeParamMap

decodeParams

urlWithForm

urlWithForm

getCharset

getString

getString

getMimeType

getContentTypeByRequestBody