URLUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.net.URLEncodeUtil
- - cn.hutool.core.util.URLUtil

public class URLUtil
extends URLEncodeUtil

URL（Uniform Resource Locator）统一资源定位符相关工具类

统一资源定位符，描述了一台特定服务器上某资源的特定位置。

URL组成：

   协议://主机名[:端口]/ 路径/[:参数] [?查询]#Fragment
   protocol :// hostname[:port] / path / [:parameters][?query]#fragment

Author:: xiaoleilu

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLASSPATH_URL_PREFIX` 针对ClassPath路径的伪协议前缀（兼容Spring）: "classpath:"
`static String`	`FILE_URL_PREFIX` URL 前缀表示文件: "file:"
`static String`	`JAR_URL_PREFIX` URL 前缀表示jar: "jar:"
`static String`	`JAR_URL_SEPARATOR` Jar路径以及内部文件路径的分界符: "!
`static String`	`URL_PROTOCOL_FILE` URL 协议表示文件: "file"
`static String`	`URL_PROTOCOL_JAR` URL 协议表示Jar文件: "jar"
`static String`	`URL_PROTOCOL_VFS` URL 协议表示JBoss VFS资源: "vfs"
`static String`	`URL_PROTOCOL_VFSFILE` URL 协议表示JBoss文件: "vfsfile"
`static String`	`URL_PROTOCOL_VFSZIP` URL 协议表示JBoss zip文件: "vfszip"
`static String`	`URL_PROTOCOL_WSJAR` URL 协议表示WebSphere文件: "wsjar"
`static String`	`URL_PROTOCOL_ZIP` URL 协议表示zip文件: "zip"
`static String`	`WAR_URL_PREFIX` URL 前缀表示war: "war:"
`static String`	`WAR_URL_SEPARATOR` WAR路径及内部文件路径分界符

Constructor Summary

Constructors
Constructor and Description

URLUtil()

Constructors
Constructor and Description
`URLUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`buildQuery(Map<String,?> paramMap, Charset charset)` 将Map形式的Form表单数据转换为Url参数形式 paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）会自动url编码键和值 key1=v1&key2=&key3=v3
`static String`	`completeUrl(String baseUrl, String relativePath)` 补全相对路径
`static String`	`decode(String url)` 解码URL 将%开头的16进制表示的内容解码。
`static String`	`decode(String content, Charset charset)` 解码application/x-www-form-urlencoded字符将%开头的16进制表示的内容解码。
`static String`	`decode(String content, Charset charset, boolean isPlusToSpace)` 解码application/x-www-form-urlencoded字符将%开头的16进制表示的内容解码。
`static String`	`decode(String content, String charset)` 解码application/x-www-form-urlencoded字符将%开头的16进制表示的内容解码。
`static String`	`encodeBlank(CharSequence urlStr)` 单独编码URL中的空白符，空白符编码为%20
`static long`	`getContentLength(URL url)` 获取指定URL对应资源的内容长度，对于Http，其长度使用Content-Length头决定。
`static String`	`getDataUri(String mimeType, Charset charset, String encoding, String data)` Data URI Scheme封装。
`static String`	`getDataUri(String mimeType, String encoding, String data)` Data URI Scheme封装。
`static String`	`getDataUriBase64(String mimeType, String data)` Data URI Scheme封装，数据格式为Base64。
`static String`	`getDecodedPath(URL url)` 从URL对象中获取不被编码的路径Path 对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。
`static URI`	`getHost(URL url)` 获取URL中域名部分，只保留URL中的协议（Protocol）、Host，其它为null。
`static JarFile`	`getJarFile(URL url)` 从URL中获取JarFile
`static String`	`getPath(String uriStr)` 获得path部分
`static BufferedReader`	`getReader(URL url, Charset charset)` 获得Reader
`static InputStream`	`getStream(URL url)` 从URL中获取流
`static URI`	`getStringURI(CharSequence content)` 获取string协议的URL，类似于string:///xxxxx
`static URL`	`getURL(File file)` 获得URL，常用于使用绝对路径时的情况
`static URL`	`getURL(String pathBaseClassLoader)` 获得URL
`static URL`	`getURL(String path, Class<?> clazz)` 获得URL
`static URL[]`	`getURLs(File... files)` 获得URL，常用于使用绝对路径时的情况
`static boolean`	`isFileURL(URL url)` 提供的URL是否为文件文件协议包括"file", "vfsfile" 或 "vfs".
`static boolean`	`isJarFileURL(URL url)` 提供的URL是否为Jar文件URL 判断依据为file协议且扩展名为.jar
`static boolean`	`isJarURL(URL url)` 提供的URL是否为jar包URL 协议包括： "jar", "zip", "vfszip" 或 "wsjar".
`static String`	`normalize(String url)` 标准化URL字符串，包括：自动补齐“http://”头去除开头的\或者/ 替换\为/
`static String`	`normalize(String url, boolean isEncodePath)` 标准化URL字符串，包括：自动补齐“http://”头去除开头的\或者/ 替换\为/
`static String`	`normalize(String url, boolean isEncodePath, boolean replaceSlash)` 标准化URL字符串，包括：自动补齐“http://”头去除开头的\或者/ 替换\为/ 如果replaceSlash为true，则替换多个/为一个
`static long`	`size(URL url)` 获取URL对应数据长度如果URL为文件，转换为文件获取文件长度。
`static URI`	`toURI(String location)` 转字符串为URI
`static URI`	`toURI(String location, boolean isEncode)` 转字符串为URI
`static URI`	`toURI(URL url)` 转URL为URI
`static URI`	`toURI(URL url, boolean isEncode)` 转URL为URI
`static URL`	`toUrlForHttp(String urlStr)` 将URL字符串转换为URL对象，并做必要验证
`static URL`	`toUrlForHttp(String urlStr, URLStreamHandler handler)` 将URL字符串转换为URL对象，并做必要验证
`static URL`	`url(String url)` 通过一个字符串形式的URL地址创建URL对象
`static URL`	`url(String url, URLStreamHandler handler)` 通过一个字符串形式的URL地址创建URL对象
`static URL`	`url(URI uri)` 将`URI`转换为`URL`
`static void`	`useCachesIfNecessary(URLConnection con)` 如果连接为JNLP方式，则打开缓存

Methods inherited from class cn.hutool.core.net.URLEncodeUtil
encode, encode, encodeAll, encodeAll, encodeFragment, encodeFragment, encodePathSegment, encodePathSegment, encodeQuery, encodeQuery

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASSPATH_URL_PREFIX
```
public static final String CLASSPATH_URL_PREFIX
```
    针对ClassPath路径的伪协议前缀（兼容Spring）: "classpath:"
    
    See Also:
    
    Constant Field Values
  - FILE_URL_PREFIX
```
public static final String FILE_URL_PREFIX
```
    URL 前缀表示文件: "file:"
    
    See Also:
    
    Constant Field Values
  - JAR_URL_PREFIX
```
public static final String JAR_URL_PREFIX
```
    URL 前缀表示jar: "jar:"
    
    See Also:
    
    Constant Field Values
  - WAR_URL_PREFIX
```
public static final String WAR_URL_PREFIX
```
    URL 前缀表示war: "war:"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_FILE
```
public static final String URL_PROTOCOL_FILE
```
    URL 协议表示文件: "file"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_JAR
```
public static final String URL_PROTOCOL_JAR
```
    URL 协议表示Jar文件: "jar"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_ZIP
```
public static final String URL_PROTOCOL_ZIP
```
    URL 协议表示zip文件: "zip"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_WSJAR
```
public static final String URL_PROTOCOL_WSJAR
```
    URL 协议表示WebSphere文件: "wsjar"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_VFSZIP
```
public static final String URL_PROTOCOL_VFSZIP
```
    URL 协议表示JBoss zip文件: "vfszip"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_VFSFILE
```
public static final String URL_PROTOCOL_VFSFILE
```
    URL 协议表示JBoss文件: "vfsfile"
    
    See Also:
    
    Constant Field Values
  - URL_PROTOCOL_VFS
```
public static final String URL_PROTOCOL_VFS
```
    URL 协议表示JBoss VFS资源: "vfs"
    
    See Also:
    
    Constant Field Values
  - JAR_URL_SEPARATOR
```
public static final String JAR_URL_SEPARATOR
```
    Jar路径以及内部文件路径的分界符: "!/"
    
    See Also:
    
    Constant Field Values
  - WAR_URL_SEPARATOR
```
public static final String WAR_URL_SEPARATOR
```
    WAR路径及内部文件路径分界符
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - URLUtil
```
public URLUtil()
```
- Method Detail
  - url
```
public static URL url(URI uri)
               throws UtilException
```
    将URI转换为URL
    
    Parameters:
    
    uri - URI
    
    Returns:
    
    URL对象
    
    Throws:
    
    UtilException - MalformedURLException包装，URI格式有问题时抛出
    
    Since:
    
    5.7.21
    
    See Also:
    
    URI.toURL()
  - url
```
public static URL url(String url)
```
    通过一个字符串形式的URL地址创建URL对象
    
    Parameters:
    
    url - URL
    
    Returns:
    
    URL对象
  - url
```
public static URL url(String url,
                      URLStreamHandler handler)
```
    通过一个字符串形式的URL地址创建URL对象
    
    Parameters:
    
    url - URL
    
    handler - URLStreamHandler
    
    Returns:
    
    URL对象
    
    Since:
    
    4.1.1
  - getStringURI
```
public static URI getStringURI(CharSequence content)
```
    获取string协议的URL，类似于string:///xxxxx
    
    Parameters:
    
    content - 正文
    
    Returns:
    
    URL
    
    Since:
    
    5.5.2
  - toUrlForHttp
```
public static URL toUrlForHttp(String urlStr)
```
    将URL字符串转换为URL对象，并做必要验证
    
    Parameters:
    
    urlStr - URL字符串
    
    Returns:
    
    URL
    
    Since:
    
    4.1.9
  - toUrlForHttp
```
public static URL toUrlForHttp(String urlStr,
                               URLStreamHandler handler)
```
    将URL字符串转换为URL对象，并做必要验证
    
    Parameters:
    
    urlStr - URL字符串
    
    handler - URLStreamHandler
    
    Returns:
    
    URL
    
    Since:
    
    4.1.9
  - encodeBlank
```
public static String encodeBlank(CharSequence urlStr)
```
    单独编码URL中的空白符，空白符编码为%20
    
    Parameters:
    
    urlStr - URL字符串
    
    Returns:
    
    编码后的字符串
    
    Since:
    
    4.5.14
  - getURL
```
public static URL getURL(String pathBaseClassLoader)
```
    获得URL
    
    Parameters:
    
    pathBaseClassLoader - 相对路径（相对于classes）
    
    Returns:
    
    URL
    
    See Also:
    
    ResourceUtil.getResource(String)
  - getURL
```
public static URL getURL(String path,
                         Class<?> clazz)
```
    获得URL
    
    Parameters:
    
    path - 相对给定 class所在的路径
    
    clazz - 指定class
    
    Returns:
    
    URL
    
    See Also:
    
    ResourceUtil.getResource(String, Class)
  - getURL
```
public static URL getURL(File file)
```
    获得URL，常用于使用绝对路径时的情况
    
    Parameters:
    
    file - URL对应的文件对象
    
    Returns:
    
    URL
    
    Throws:
    
    UtilException - MalformedURLException
  - getURLs
```
public static URL[] getURLs(File... files)
```
    获得URL，常用于使用绝对路径时的情况
    
    Parameters:
    
    files - URL对应的文件对象
    
    Returns:
    
    URL
    
    Throws:
    
    UtilException - MalformedURLException
  - getHost
```
public static URI getHost(URL url)
```
    获取URL中域名部分，只保留URL中的协议（Protocol）、Host，其它为null。
    
    Parameters:
    
    url - URL
    
    Returns:
    
    域名的URI
    
    Since:
    
    4.6.9
  - completeUrl
```
public static String completeUrl(String baseUrl,
                                 String relativePath)
```
    补全相对路径
    
    Parameters:
    
    baseUrl - 基准URL
    
    relativePath - 相对URL
    
    Returns:
    
    相对路径
    
    Throws:
    
    UtilException - MalformedURLException
  - decode
```
public static String decode(String url)
                     throws UtilException
```
    解码URL
    将%开头的16进制表示的内容解码。
    
    Parameters:
    
    url - URL
    
    Returns:
    
    解码后的URL
    
    Throws:
    
    UtilException - UnsupportedEncodingException
    
    Since:
    
    3.1.2
  - decode
```
public static String decode(String content,
                            Charset charset)
```
    解码application/x-www-form-urlencoded字符
    将%开头的16进制表示的内容解码。
    规则见：https://url.spec.whatwg.org/#urlencoded-parsing
    
    Parameters:
    
    content - 被解码内容
    
    charset - 编码，null表示不解码
    
    Returns:
    
    编码后的字符
    
    Since:
    
    4.4.1
  - decode
```
public static String decode(String content,
                            Charset charset,
                            boolean isPlusToSpace)
```
    解码application/x-www-form-urlencoded字符
    将%开头的16进制表示的内容解码。
    
    Parameters:
    
    content - 被解码内容
    
    charset - 编码，null表示不解码
    
    isPlusToSpace - 是否+转换为空格
    
    Returns:
    
    编码后的字符
    
    Since:
    
    5.6.3
  - decode
```
public static String decode(String content,
                            String charset)
                     throws UtilException
```
    解码application/x-www-form-urlencoded字符
    将%开头的16进制表示的内容解码。
    
    Parameters:
    
    content - URL
    
    charset - 编码
    
    Returns:
    
    解码后的URL
    
    Throws:
    
    UtilException - UnsupportedEncodingException
  - getPath
```
public static String getPath(String uriStr)
```
    获得path部分
    
    Parameters:
    
    uriStr - URI路径
    
    Returns:
    
    path
    
    Throws:
    
    UtilException - 包装URISyntaxException
  - getDecodedPath
```
public static String getDecodedPath(URL url)
```
    从URL对象中获取不被编码的路径Path
    对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。
    此方法将URL转为URI后获取路径用于解决路径被编码的问题
    
    Parameters:
    
    url - URL
    
    Returns:
    
    路径
    
    Since:
    
    3.0.8
  - toURI
```
public static URI toURI(URL url)
                 throws UtilException
```
    转URL为URI
    
    Parameters:
    
    url - URL
    
    Returns:
    
    URI
    
    Throws:
    
    UtilException - 包装URISyntaxException
  - toURI
```
public static URI toURI(URL url,
                        boolean isEncode)
                 throws UtilException
```
    转URL为URI
    
    Parameters:
    
    url - URL
    
    isEncode - 是否编码参数中的特殊字符（默认UTF-8编码）
    
    Returns:
    
    URI
    
    Throws:
    
    UtilException - 包装URISyntaxException
    
    Since:
    
    4.6.9
  - toURI
```
public static URI toURI(String location)
                 throws UtilException
```
    转字符串为URI
    
    Parameters:
    
    location - 字符串路径
    
    Returns:
    
    URI
    
    Throws:
    
    UtilException - 包装URISyntaxException
  - toURI
```
public static URI toURI(String location,
                        boolean isEncode)
                 throws UtilException
```
    转字符串为URI
    
    Parameters:
    
    location - 字符串路径
    
    isEncode - 是否编码参数中的特殊字符（默认UTF-8编码）
    
    Returns:
    
    URI
    
    Throws:
    
    UtilException - 包装URISyntaxException
    
    Since:
    
    4.6.9
  - isFileURL
```
public static boolean isFileURL(URL url)
```
    提供的URL是否为文件
    文件协议包括"file", "vfsfile" 或 "vfs".
    
    Parameters:
    
    url - URL
    
    Returns:
    
    是否为文件
    
    Since:
    
    3.0.9
  - isJarURL
```
public static boolean isJarURL(URL url)
```
    提供的URL是否为jar包URL 协议包括： "jar", "zip", "vfszip" 或 "wsjar".
    
    Parameters:
    
    url - URL
    
    Returns:
    
    是否为jar包URL
  - isJarFileURL
```
public static boolean isJarFileURL(URL url)
```
    提供的URL是否为Jar文件URL 判断依据为file协议且扩展名为.jar
    
    Parameters:
    
    url - the URL to check
    
    Returns:
    
    whether the URL has been identified as a JAR file URL
    
    Since:
    
    4.1
  - getStream
```
public static InputStream getStream(URL url)
```
    从URL中获取流
    
    Parameters:
    
    url - URL
    
    Returns:
    
    InputStream流
    
    Since:
    
    3.2.1
  - getReader
```
public static BufferedReader getReader(URL url,
                                       Charset charset)
```
    获得Reader
    
    Parameters:
    
    url - URL
    
    charset - 编码
    
    Returns:
    
    BufferedReader
    
    Since:
    
    3.2.1
  - getJarFile
```
public static JarFile getJarFile(URL url)
```
    从URL中获取JarFile
    
    Parameters:
    
    url - URL
    
    Returns:
    
    JarFile
    
    Since:
    
    4.1.5
  - normalize
```
public static String normalize(String url)
```
    标准化URL字符串，包括：
    1. 自动补齐“http://”头
    2. 去除开头的\或者/
    3. 替换\为/
    Parameters:
    
    url - URL字符串
    
    Returns:
    
    标准化后的URL字符串
  - normalize
```
public static String normalize(String url,
                               boolean isEncodePath)
```
    标准化URL字符串，包括：
    1. 自动补齐“http://”头
    2. 去除开头的\或者/
    3. 替换\为/
    Parameters:
    
    url - URL字符串
    
    isEncodePath - 是否对URL中path部分的中文和特殊字符做转义（不包括 http:, /和域名部分）
    
    Returns:
    
    标准化后的URL字符串
    
    Since:
    
    4.4.1
  - normalize
```
public static String normalize(String url,
                               boolean isEncodePath,
                               boolean replaceSlash)
```
    标准化URL字符串，包括：
    1. 自动补齐“http://”头
    2. 去除开头的\或者/
    3. 替换\为/
    4. 如果replaceSlash为true，则替换多个/为一个
    Parameters:
    
    url - URL字符串
    
    isEncodePath - 是否对URL中path部分的中文和特殊字符做转义（不包括 http:, /和域名部分）
    
    replaceSlash - 是否替换url body中的 //
    
    Returns:
    
    标准化后的URL字符串
    
    Since:
    
    5.5.5
  - buildQuery
```
public static String buildQuery(Map<String,?> paramMap,
                                Charset charset)
```
    将Map形式的Form表单数据转换为Url参数形式
    paramMap中如果key为空（null和""）会被忽略，如果value为null，会被做为空白符（""）
    会自动url编码键和值
```
 key1=v1&key2=&key3=v3
 
```
    Parameters:
    
    paramMap - 表单数据
    
    charset - 编码，编码为null表示不编码
    
    Returns:
    
    url参数
  - getContentLength
```
public static long getContentLength(URL url)
                             throws IORuntimeException
```
    获取指定URL对应资源的内容长度，对于Http，其长度使用Content-Length头决定。
    
    Parameters:
    
    url - URL
    
    Returns:
    
    内容长度，未知返回-1
    
    Throws:
    
    IORuntimeException - IO异常
    
    Since:
    
    5.3.4
  - getDataUriBase64
```
public static String getDataUriBase64(String mimeType,
                                      String data)
```
    Data URI Scheme封装，数据格式为Base64。data URI scheme 允许我们使用内联（inline-code）的方式在网页中包含数据，
    目的是将一些小的数据，直接嵌入到网页中，从而不用再从外部文件载入。常用于将图片嵌入网页。
    Data URI的格式规范：
```
     data:[<mime type>][;charset=<charset>][;<encoding>],<encoded data>
 
```
    Parameters:
    
    mimeType - 可选项（null表示无），数据类型（image/png、text/plain等）
    
    data - 编码后的数据
    
    Returns:
    
    Data URI字符串
    
    Since:
    
    5.3.11
  - getDataUri
```
public static String getDataUri(String mimeType,
                                String encoding,
                                String data)
```
    Data URI Scheme封装。data URI scheme 允许我们使用内联（inline-code）的方式在网页中包含数据，
    目的是将一些小的数据，直接嵌入到网页中，从而不用再从外部文件载入。常用于将图片嵌入网页。
    Data URI的格式规范：
```
     data:[<mime type>][;charset=<charset>][;<encoding>],<encoded data>
 
```
    Parameters:
    
    mimeType - 可选项（null表示无），数据类型（image/png、text/plain等）
    
    encoding - 数据编码方式（US-ASCII，BASE64等）
    
    data - 编码后的数据
    
    Returns:
    
    Data URI字符串
    
    Since:
    
    5.3.6
  - getDataUri
```
public static String getDataUri(String mimeType,
                                Charset charset,
                                String encoding,
                                String data)
```
    Data URI Scheme封装。data URI scheme 允许我们使用内联（inline-code）的方式在网页中包含数据，
    目的是将一些小的数据，直接嵌入到网页中，从而不用再从外部文件载入。常用于将图片嵌入网页。
    Data URI的格式规范：
```
     data:[<mime type>][;charset=<charset>][;<encoding>],<encoded data>
 
```
    Parameters:
    
    mimeType - 可选项（null表示无），数据类型（image/png、text/plain等）
    
    charset - 可选项（null表示无），源文本的字符集编码方式
    
    encoding - 数据编码方式（US-ASCII，BASE64等）
    
    data - 编码后的数据
    
    Returns:
    
    Data URI字符串
    
    Since:
    
    5.3.6
  - size
```
public static long size(URL url)
```
    获取URL对应数据长度
    - 如果URL为文件，转换为文件获取文件长度。
    - 其它情况获取URLConnection.getContentLengthLong()
    Parameters:
    
    url - URL
    
    Returns:
    
    长度
    
    Since:
    
    6.0.0
  - useCachesIfNecessary
```
public static void useCachesIfNecessary(URLConnection con)
```
    如果连接为JNLP方式，则打开缓存
    
    Parameters:
    
    con - URLConnection
    
    Since:
    
    6.0.0

Class URLUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class cn.hutool.core.net.URLEncodeUtil

Methods inherited from class java.lang.Object

Field Detail

CLASSPATH_URL_PREFIX

FILE_URL_PREFIX

JAR_URL_PREFIX

WAR_URL_PREFIX

URL_PROTOCOL_FILE

URL_PROTOCOL_JAR

URL_PROTOCOL_ZIP

URL_PROTOCOL_WSJAR

URL_PROTOCOL_VFSZIP

URL_PROTOCOL_VFSFILE

URL_PROTOCOL_VFS

JAR_URL_SEPARATOR

WAR_URL_SEPARATOR

Constructor Detail

URLUtil

Method Detail

url

url

url

getStringURI

toUrlForHttp

toUrlForHttp

encodeBlank

getURL

getURL

getURL

getURLs

getHost

completeUrl

decode

decode

decode

decode

getPath

getDecodedPath

toURI

toURI

toURI

toURI

isFileURL

isJarURL

isJarFileURL

getStream

getReader

getJarFile

normalize

normalize

normalize

buildQuery

getContentLength

getDataUriBase64

getDataUri

getDataUri

size

useCachesIfNecessary