URLUtil (hutool-core 4.1.17 API)

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

```
public class URLUtil
extends java.lang.Object
```
统一资源定位符相关工具类

作者:

xiaoleilu

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`CLASSPATH_URL_PREFIX` 针对ClassPath路径的伪协议前缀（兼容Spring）: "classpath:"
`static java.lang.String`	`FILE_URL_PREFIX` URL 前缀表示文件: "file:"
`static java.lang.String`	`JAR_URL_PREFIX` URL 前缀表示jar: "jar:"
`static java.lang.String`	`JAR_URL_SEPARATOR` Jar路径以及内部文件路径的分界符: "!
`static java.lang.String`	`URL_PROTOCOL_FILE` URL 协议表示文件: "file"
`static java.lang.String`	`URL_PROTOCOL_JAR` URL 协议表示Jar文件: "jar"
`static java.lang.String`	`URL_PROTOCOL_VFS` URL 协议表示JBoss VFS资源: "vfs"
`static java.lang.String`	`URL_PROTOCOL_VFSFILE` URL 协议表示JBoss文件: "vfsfile"
`static java.lang.String`	`URL_PROTOCOL_VFSZIP` URL 协议表示JBoss zip文件: "vfszip"
`static java.lang.String`	`URL_PROTOCOL_WSJAR` URL 协议表示WebSphere文件: "wsjar"
`static java.lang.String`	`URL_PROTOCOL_ZIP` URL 协议表示zip文件: "zip"
`static java.lang.String`	`WAR_URL_PREFIX` URL 前缀表示war: "war:"
`static java.lang.String`	`WAR_URL_SEPARATOR` WAR路径及内部文件路径分界符

构造器概要

构造器
构造器和说明

URLUtil()

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

方法概要

方法
限定符和类型	方法和说明
`static java.lang.String`	`complateUrl(java.lang.String baseUrl, java.lang.String relativePath)` 补全相对路径
`static java.lang.String`	`decode(java.lang.String url)` 解码URL 将%开头的16进制表示的内容解码。
`static java.lang.String`	`decode(java.lang.String url, java.lang.String charset)` 解码URL 将%开头的16进制表示的内容解码。
`static java.lang.String`	`encode(java.lang.String url)` 编码URL，默认使用UTF-8编码将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
`static java.lang.String`	`encode(java.lang.String url, java.lang.String charset)` 编码URL 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
`static java.lang.String`	`formatUrl(java.lang.String url)` 格式化URL链接
`static java.lang.String`	`getDecodedPath(java.net.URL url)` 从URL对象中获取不被编码的路径Path 对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。
`static java.util.jar.JarFile`	`getJarFile(java.net.URL url)` 从URL中获取JarFile
`static java.lang.String`	`getPath(java.lang.String uriStr)` 获得path部分
`static java.io.BufferedReader`	`getReader(java.net.URL url, java.nio.charset.Charset charset)` 获得Reader
`static java.io.InputStream`	`getStream(java.net.URL url)` 从URL中获取流
`static java.net.URL`	`getURL(java.io.File file)` 获得URL，常用于使用绝对路径时的情况
`static java.net.URL`	`getURL(java.lang.String pathBaseClassLoader)` 获得URL
`static java.net.URL`	`getURL(java.lang.String path, java.lang.Class<?> clazz)` 获得URL
`static java.net.URL[]`	`getURLs(java.io.File... files)` 获得URL，常用于使用绝对路径时的情况
`static boolean`	`isFileURL(java.net.URL url)` 提供的URL是否为文件文件协议包括"file", "vfsfile" 或 "vfs".
`static boolean`	`isJarFileURL(java.net.URL url)` 提供的URL是否为Jar文件URL 判断依据为file协议且扩展名为.jar
`static boolean`	`isJarURL(java.net.URL url)` 提供的URL是否为jar包URL 协议包括： "jar", "zip", "vfszip" 或 "wsjar".
`static java.lang.String`	`normalize(java.lang.String url)` 标准化URL字符串，包括： 1.
`static java.net.URI`	`toURI(java.lang.String location)` 转字符串为URI
`static java.net.URI`	`toURI(java.net.URL url)` 转URL为URI
`static java.net.URL`	`toUrlForHttp(java.lang.String urlStr)` 将URL字符串转换为URL对象，并做必要验证
`static java.net.URL`	`toUrlForHttp(java.lang.String urlStr, java.net.URLStreamHandler handler)` 将URL字符串转换为URL对象，并做必要验证
`static java.net.URL`	`url(java.lang.String url)` 通过一个字符串形式的URL地址创建URL对象
`static java.net.URL`	`url(java.lang.String url, java.net.URLStreamHandler handler)` 通过一个字符串形式的URL地址创建URL对象

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

- 字段详细资料
  - CLASSPATH_URL_PREFIX
```
public static final java.lang.String CLASSPATH_URL_PREFIX
```
    针对ClassPath路径的伪协议前缀（兼容Spring）: "classpath:"
    
    另请参阅:
    常量字段值
  - FILE_URL_PREFIX
```
public static final java.lang.String FILE_URL_PREFIX
```
    URL 前缀表示文件: "file:"
    
    另请参阅:
    常量字段值
  - JAR_URL_PREFIX
```
public static final java.lang.String JAR_URL_PREFIX
```
    URL 前缀表示jar: "jar:"
    
    另请参阅:
    常量字段值
  - WAR_URL_PREFIX
```
public static final java.lang.String WAR_URL_PREFIX
```
    URL 前缀表示war: "war:"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_FILE
```
public static final java.lang.String URL_PROTOCOL_FILE
```
    URL 协议表示文件: "file"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_JAR
```
public static final java.lang.String URL_PROTOCOL_JAR
```
    URL 协议表示Jar文件: "jar"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_ZIP
```
public static final java.lang.String URL_PROTOCOL_ZIP
```
    URL 协议表示zip文件: "zip"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_WSJAR
```
public static final java.lang.String URL_PROTOCOL_WSJAR
```
    URL 协议表示WebSphere文件: "wsjar"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_VFSZIP
```
public static final java.lang.String URL_PROTOCOL_VFSZIP
```
    URL 协议表示JBoss zip文件: "vfszip"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_VFSFILE
```
public static final java.lang.String URL_PROTOCOL_VFSFILE
```
    URL 协议表示JBoss文件: "vfsfile"
    
    另请参阅:
    常量字段值
  - URL_PROTOCOL_VFS
```
public static final java.lang.String URL_PROTOCOL_VFS
```
    URL 协议表示JBoss VFS资源: "vfs"
    
    另请参阅:
    常量字段值
  - JAR_URL_SEPARATOR
```
public static final java.lang.String JAR_URL_SEPARATOR
```
    Jar路径以及内部文件路径的分界符: "!/"
    
    另请参阅:
    常量字段值
  - WAR_URL_SEPARATOR
```
public static final java.lang.String WAR_URL_SEPARATOR
```
    WAR路径及内部文件路径分界符
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - URLUtil
```
public URLUtil()
```
- 方法详细资料
  - url
```
public static java.net.URL url(java.lang.String url)
```
    通过一个字符串形式的URL地址创建URL对象
    
    参数:
    url - URL
    
    返回:
    URL对象
  - url
```
public static java.net.URL url(java.lang.String url,
               java.net.URLStreamHandler handler)
```
    通过一个字符串形式的URL地址创建URL对象
    
    参数:
    url - URL
    handler - URLStreamHandler
    
    返回:
    URL对象
    从以下版本开始:
    
    4.1.1
  - toUrlForHttp
```
public static java.net.URL toUrlForHttp(java.lang.String urlStr)
```
    将URL字符串转换为URL对象，并做必要验证
    
    参数:
    urlStr - URL字符串
    
    返回:
    URL
    从以下版本开始:
    
    4.1.9
  - toUrlForHttp
```
public static java.net.URL toUrlForHttp(java.lang.String urlStr,
                        java.net.URLStreamHandler handler)
```
    将URL字符串转换为URL对象，并做必要验证
    
    参数:
    urlStr - URL字符串
    handler - URLStreamHandler
    
    返回:
    URL
    从以下版本开始:
    
    4.1.9
  - getURL
```
public static java.net.URL getURL(java.lang.String pathBaseClassLoader)
```
    获得URL
    
    参数:
    pathBaseClassLoader - 相对路径（相对于classes）
    
    返回:
    URL
    另请参阅:
    ResourceUtil.getResource(String)
  - getURL
```
public static java.net.URL getURL(java.lang.String path,
                  java.lang.Class<?> clazz)
```
    获得URL
    
    参数:
    path - 相对给定 class所在的路径
    clazz - 指定class
    
    返回:
    URL
    另请参阅:
    ResourceUtil.getResource(String, Class)
  - getURL
```
public static java.net.URL getURL(java.io.File file)
```
    获得URL，常用于使用绝对路径时的情况
    
    参数:
    file - URL对应的文件对象
    
    返回:
    URL
    
    抛出:
    
    UtilException - MalformedURLException
  - getURLs
```
public static java.net.URL[] getURLs(java.io.File... files)
```
    获得URL，常用于使用绝对路径时的情况
    
    参数:
    files - URL对应的文件对象
    
    返回:
    URL
    
    抛出:
    
    UtilException - MalformedURLException
  - formatUrl
```
public static java.lang.String formatUrl(java.lang.String url)
```
    格式化URL链接
    
    参数:
    url - 需要格式化的URL
    
    返回:
    格式化后的URL，如果提供了null或者空串，返回null
    另请参阅:
    normalize(String)
  - complateUrl
```
public static java.lang.String complateUrl(java.lang.String baseUrl,
                           java.lang.String relativePath)
```
    补全相对路径
    
    参数:
    baseUrl - 基准URL
    relativePath - 相对URL
    
    返回:
    相对路径
    
    抛出:
    
    UtilException - MalformedURLException
  - encode
```
public static java.lang.String encode(java.lang.String url)
                               throws UtilException
```
    编码URL，默认使用UTF-8编码
    将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
    
    参数:
    url - URL
    
    返回:
    编码后的URL
    
    抛出:
    
    UtilException - UnsupportedEncodingException
    从以下版本开始:
    
    3.1.2
  - encode
```
public static java.lang.String encode(java.lang.String url,
                      java.lang.String charset)
                               throws UtilException
```
    编码URL
    将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
    
    参数:
    url - URL
    charset - 编码
    
    返回:
    编码后的URL
    
    抛出:
    
    UtilException - UnsupportedEncodingException
  - decode
```
public static java.lang.String decode(java.lang.String url)
                               throws UtilException
```
    解码URL
    将%开头的16进制表示的内容解码。
    
    参数:
    url - URL
    
    返回:
    解码后的URL
    
    抛出:
    
    UtilException - UnsupportedEncodingException
    从以下版本开始:
    
    3.1.2
  - decode
```
public static java.lang.String decode(java.lang.String url,
                      java.lang.String charset)
                               throws UtilException
```
    解码URL
    将%开头的16进制表示的内容解码。
    
    参数:
    url - URL
    charset - 编码
    
    返回:
    解码后的URL
    
    抛出:
    
    UtilException - UnsupportedEncodingException
  - getPath
```
public static java.lang.String getPath(java.lang.String uriStr)
```
    获得path部分
    
    参数:
    uriStr - URI路径
    
    返回:
    path
    
    抛出:
    
    UtilException - 包装URISyntaxException
  - getDecodedPath
```
public static java.lang.String getDecodedPath(java.net.URL url)
```
    从URL对象中获取不被编码的路径Path
    对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。
    此方法将URL转为URI后获取路径用于解决路径被编码的问题
    
    参数:
    url - URL
    
    返回:
    路径
    从以下版本开始:
    
    3.0.8
  - toURI
```
public static java.net.URI toURI(java.net.URL url)
                          throws UtilException
```
    转URL为URI
    
    参数:
    url - URL
    
    返回:
    URI
    
    抛出:
    
    UtilException - 包装URISyntaxException
  - toURI
```
public static java.net.URI toURI(java.lang.String location)
                          throws UtilException
```
    转字符串为URI
    
    参数:
    location - 字符串路径
    
    返回:
    URI
    
    抛出:
    
    UtilException - 包装URISyntaxException
  - isFileURL
```
public static boolean isFileURL(java.net.URL url)
```
    提供的URL是否为文件
    文件协议包括"file", "vfsfile" 或 "vfs".
    
    参数:
    url - URL
    
    返回:
    是否为文件
    从以下版本开始:
    
    3.0.9
  - isJarURL
```
public static boolean isJarURL(java.net.URL url)
```
    提供的URL是否为jar包URL 协议包括： "jar", "zip", "vfszip" 或 "wsjar".
    
    参数:
    url - URL
    
    返回:
    是否为jar包URL
  - isJarFileURL
```
public static boolean isJarFileURL(java.net.URL url)
```
    提供的URL是否为Jar文件URL 判断依据为file协议且扩展名为.jar
    
    参数:
    url - the URL to check
    
    返回:
    whether the URL has been identified as a JAR file URL
    从以下版本开始:
    
    4.1
  - getStream
```
public static java.io.InputStream getStream(java.net.URL url)
```
    从URL中获取流
    
    参数:
    url - URL
    
    返回:
    InputStream流
    从以下版本开始:
    
    3.2.1
  - getReader
```
public static java.io.BufferedReader getReader(java.net.URL url,
                               java.nio.charset.Charset charset)
```
    获得Reader
    
    参数:
    url - URL
    charset - 编码
    
    返回:
    BufferedReader
    从以下版本开始:
    
    3.2.1
  - getJarFile
```
public static java.util.jar.JarFile getJarFile(java.net.URL url)
```
    从URL中获取JarFile
    
    参数:
    url - URL
    
    返回:
    JarFile
    从以下版本开始:
    
    4.1.5
  - normalize
```
public static java.lang.String normalize(java.lang.String url)
```
    标准化URL字符串，包括：
```
 1. 多个/替换为一个
 
```
    参数:
    url - URL字符串
    
    返回:
    标准化后的URL字符串

类 URLUtil

字段概要

构造器概要

方法概要

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

字段详细资料

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

构造器详细资料

URLUtil

方法详细资料

url

url

toUrlForHttp

toUrlForHttp

getURL

getURL

getURL

getURLs

formatUrl

complateUrl

encode

encode

decode

decode

getPath

getDecodedPath

toURI

toURI

isFileURL

isJarURL

isJarFileURL

getStream

getReader

getJarFile

normalize