URLUtils (bus-core 3.0.9 API)

java.lang.Object
- org.aoju.bus.core.utils.URLUtils

```
public class URLUtils
extends Object
```
统一资源定位符相关工具类

Since:

JDK 1.8

Version:

3.0.9

Author:

Kimi Liu

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

URLUtils()

Constructors
Constructor and Description
`URLUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`complateUrl(String baseUrl, String relativePath)` 补全相对路径
`static String`	`decode(String url)` 解码URL 将%开头的16进制表示的内容解码。
`static String`	`decode(String url, String charset)` 解码URL 将%开头的16进制表示的内容解码。
`static String`	`encode(String url)` 编码URL，默认使用UTF-8编码将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
`static String`	`encode(String url, String charset)` 编码URL 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
`static String`	`formatUrl(String url)` 格式化URL链接
`static String`	`getDecodedPath(URL url)` 从URL对象中获取不被编码的路径Path 对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。此方法将URL转为URI后获取路径用于解决路径被编码的问题
`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 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字符串，包括：
`static URI`	`toURI(String location)` 转字符串为URI
`static URI`	`toURI(URL url)` 转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对象

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
  - URLUtils
```
public URLUtils()
```
- Method Detail
  - 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
  - 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
  - getURL
```
public static URL getURL(String pathBaseClassLoader)
```
    获得URL
    
    Parameters:
    
    pathBaseClassLoader - 相对路径（相对于classes）
    
    Returns:
    
    URL
    
    See Also:
    
    ResourceUtils.getResource(String)
  - getURL
```
public static URL getURL(String path,
                         Class<?> clazz)
```
    获得URL
    
    Parameters:
    
    path - 相对给定 class所在的路径
    
    clazz - 指定class
    
    Returns:
    
    URL
    
    See Also:
    
    ResourceUtils.getResource(String, Class)
  - getURL
```
public static URL getURL(File file)
```
    获得URL，常用于使用绝对路径时的情况
    
    Parameters:
    
    file - URL对应的文件对象
    
    Returns:
    
    URL
    
    Throws:
    
    CommonException - MalformedURLException
  - getURLs
```
public static URL[] getURLs(File... files)
```
    获得URL，常用于使用绝对路径时的情况
    
    Parameters:
    
    files - URL对应的文件对象
    
    Returns:
    
    URL
    
    Throws:
    
    CommonException - MalformedURLException
  - formatUrl
```
public static String formatUrl(String url)
```
    格式化URL链接
    
    Parameters:
    
    url - 需要格式化的URL
    
    Returns:
    
    格式化后的URL，如果提供了null或者空串，返回null
    
    See Also:
    
    normalize(String)
  - complateUrl
```
public static String complateUrl(String baseUrl,
                                 String relativePath)
```
    补全相对路径
    
    Parameters:
    
    baseUrl - 基准URL
    
    relativePath - 相对URL
    
    Returns:
    
    相对路径
    
    Throws:
    
    CommonException - MalformedURLException
  - encode
```
public static String encode(String url)
                     throws CommonException
```
    编码URL，默认使用UTF-8编码将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
    
    Parameters:
    
    url - URL
    
    Returns:
    
    编码后的URL
    
    Throws:
    
    CommonException - UnsupportedEncodingException
    
    Since:
    
    3.1.2
  - encode
```
public static String encode(String url,
                            String charset)
                     throws CommonException
```
    编码URL 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
    
    Parameters:
    
    url - URL
    
    charset - 编码
    
    Returns:
    
    编码后的URL
    
    Throws:
    
    CommonException - UnsupportedEncodingException
  - decode
```
public static String decode(String url)
                     throws CommonException
```
    解码URL 将%开头的16进制表示的内容解码。
    
    Parameters:
    
    url - URL
    
    Returns:
    
    解码后的URL
    
    Throws:
    
    CommonException - UnsupportedEncodingException
    
    Since:
    
    3.1.2
  - decode
```
public static String decode(String url,
                            String charset)
                     throws CommonException
```
    解码URL 将%开头的16进制表示的内容解码。
    
    Parameters:
    
    url - URL
    
    charset - 编码
    
    Returns:
    
    解码后的URL
    
    Throws:
    
    CommonException - UnsupportedEncodingException
  - getPath
```
public static String getPath(String uriStr)
```
    获得path部分
    
    Parameters:
    
    uriStr - URI路径
    
    Returns:
    
    path
    
    Throws:
    
    CommonException - 包装URISyntaxException
  - getDecodedPath
```
public static String getDecodedPath(URL url)
```
    从URL对象中获取不被编码的路径Path 对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。此方法将URL转为URI后获取路径用于解决路径被编码的问题
    
    Parameters:
    
    url - URL
    
    Returns:
    
    路径
  - toURI
```
public static URI toURI(URL url)
                 throws CommonException
```
    转URL为URI
    
    Parameters:
    
    url - URL
    
    Returns:
    
    URI
    
    Throws:
    
    CommonException - 包装URISyntaxException
  - toURI
```
public static URI toURI(String location)
                 throws CommonException
```
    转字符串为URI
    
    Parameters:
    
    location - 字符串路径
    
    Returns:
    
    URI
    
    Throws:
    
    CommonException - 包装URISyntaxException
  - 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. 多个/替换为一个
 
```
    Parameters:
    
    url - URL字符串
    
    Returns:
    
    标准化后的URL字符串

Class URLUtils

Field Summary

Constructor Summary

Method Summary

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

URLUtils

Method Detail

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