com.xiaoleilu.hutool.util.URLUtil Maven / Gradle / Ivy
package com.xiaoleilu.hutool.util;
import java.io.File;
import java.io.UnsupportedEncodingException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLDecoder;
import java.net.URLEncoder;
import com.xiaoleilu.hutool.exceptions.UtilException;
import com.xiaoleilu.hutool.io.FileUtil;
import com.xiaoleilu.hutool.io.resource.ResourceUtil;
import com.xiaoleilu.hutool.lang.Assert;
/**
* 统一资源定位符相关工具类
*
* @author xiaoleilu
*
*/
public class URLUtil {
/** 针对ClassPath路径的伪协议前缀（兼容Spring）: "classpath:" */
public static final String CLASSPATH_URL_PREFIX = "classpath:";
/** URL 前缀表示文件: "file:" */
public static final String FILE_URL_PREFIX = "file:";
/** URL 前缀表示jar: "jar:" */
public static final String JAR_URL_PREFIX = "jar:";
/** URL 前缀表示war: "war:" */
public static final String WAR_URL_PREFIX = "war:";
/** URL 协议表示文件: "file" */
public static final String URL_PROTOCOL_FILE = "file";
/** URL 协议表示Jar文件: "jar" */
public static final String URL_PROTOCOL_JAR = "jar";
/** URL 协议表示zip文件: "zip" */
public static final String URL_PROTOCOL_ZIP = "zip";
/** URL 协议表示WebSphere文件: "wsjar" */
public static final String URL_PROTOCOL_WSJAR = "wsjar";
/** URL 协议表示JBoss zip文件: "vfszip" */
public static final String URL_PROTOCOL_VFSZIP = "vfszip";
/** URL 协议表示JBoss文件: "vfsfile" */
public static final String URL_PROTOCOL_VFSFILE = "vfsfile";
/** URL 协议表示JBoss VFS资源: "vfs" */
public static final String URL_PROTOCOL_VFS = "vfs";
/** Jar路径以及内部文件路径的分界符: "!/" */
public static final String JAR_URL_SEPARATOR = "!/";
/** WAR路径及内部文件路径分界符 */
public static final String WAR_URL_SEPARATOR = "*/";
/**
* 通过一个字符串形式的URL地址创建URL对象
*
* @param url URL
* @return URL对象
*/
public static URL url(String url) {
Assert.notNull(url, "URL must not be null");
// 兼容Spring的ClassPath路径
if (url.startsWith(CLASSPATH_URL_PREFIX)) {
url = url.substring(CLASSPATH_URL_PREFIX.length());
return ClassLoaderUtil.getClassLoader().getResource(url);
}
try {
return new URL(url);
} catch (MalformedURLException e) {
// 尝试文件路径
try {
return new File(url).toURI().toURL();
} catch (MalformedURLException ex2) {
throw new UtilException(e);
}
}
}
/**
* 获得URL
*
* @param pathBaseClassLoader 相对路径（相对于classes）
* @return URL
* @see ResourceUtil#getResource(String)
*/
public static URL getURL(String pathBaseClassLoader) {
return ResourceUtil.getResource(pathBaseClassLoader);
}
/**
* 获得URL
*
* @param path 相对给定 class所在的路径
* @param clazz 指定class
* @return URL
* @see ResourceUtil#getResource(String, Class)
*/
public static URL getURL(String path, Class clazz) {
return ResourceUtil.getResource(path, clazz);
}
/**
* 获得URL，常用于使用绝对路径时的情况
*
* @param file URL对应的文件对象
* @return URL
* @exception UtilException MalformedURLException
*/
public static URL getURL(File file) {
Assert.notNull(file, "File is null !");
try {
return file.toURI().toURL();
} catch (MalformedURLException e) {
throw new UtilException("Error occured when get URL!", e);
}
}
/**
* 获得URL，常用于使用绝对路径时的情况
*
* @param files URL对应的文件对象
* @return URL
* @exception UtilException MalformedURLException
*/
public static URL[] getURLs(File... files) {
final URL[] urls = new URL[files.length];
try {
for (int i = 0; i < files.length; i++) {
urls[i] = files[i].toURI().toURL();
}
} catch (MalformedURLException e) {
throw new UtilException("Error occured when get URL!", e);
}
return urls;
}
/**
* 格式化URL链接
*
* @param url 需要格式化的URL
* @return 格式化后的URL，如果提供了null或者空串，返回null
*/
public static String formatUrl(String url) {
if (StrUtil.isBlank(url)) {
return null;
}
if (url.startsWith("http://") || url.startsWith("https://")) {
return url;
}
return "http://" + url;
}
/**
* 补全相对路径
*
* @param baseUrl 基准URL
* @param relativePath 相对URL
* @return 相对路径
* @exception UtilException MalformedURLException
*/
public static String complateUrl(String baseUrl, String relativePath) {
baseUrl = formatUrl(baseUrl);
if (StrUtil.isBlank(baseUrl)) {
return null;
}
try {
final URL absoluteUrl = new URL(baseUrl);
final URL parseUrl = new URL(absoluteUrl, relativePath);
return parseUrl.toString();
} catch (MalformedURLException e) {
throw new UtilException(e);
}
}
/**
* 编码URL，默认使用UTF-8编码
* 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
*
* @param url URL
* @return 编码后的URL
* @exception UtilException UnsupportedEncodingException
* @since 3.1.2
*/
public static String encode(String url) throws UtilException{
return encode(url, CharsetUtil.UTF_8);
}
/**
* 编码URL
* 将需要转换的内容（ASCII码形式之外的内容），用十六进制表示法转换出来，并在之前加上%开头。
*
* @param url URL
* @param charset 编码
* @return 编码后的URL
* @exception UtilException UnsupportedEncodingException
*/
public static String encode(String url, String charset) throws UtilException{
try {
return URLEncoder.encode(url, charset);
} catch (UnsupportedEncodingException e) {
throw new UtilException(e);
}
}
/**
* 解码URL
* 将%开头的16进制表示的内容解码。
*
* @param url URL
* @return 解码后的URL
* @exception UtilException UnsupportedEncodingException
* @since 3.1.2
*/
public static String decode(String url) throws UtilException{
return decode(url, CharsetUtil.UTF_8);
}
/**
* 解码URL
* 将%开头的16进制表示的内容解码。
*
* @param url URL
* @param charset 编码
* @return 解码后的URL
* @exception UtilException UnsupportedEncodingException
*/
public static String decode(String url, String charset) throws UtilException{
try {
return URLDecoder.decode(url, charset);
} catch (UnsupportedEncodingException e) {
throw new UtilException(e);
}
}
/**
* 获得path部分
*
* @param uriStr URI路径
* @return path
* @exception UtilException 包装URISyntaxException
*/
public static String getPath(String uriStr) {
URI uri = null;
try {
uri = new URI(uriStr);
} catch (URISyntaxException e) {
throw new UtilException(e);
}
return uri.getPath();
}
/**
* 从URL对象中获取不被编码的路径Path
* 对于本地路径，URL对象的getPath方法对于包含中文或空格时会被编码，导致本读路径读取错误。
* 此方法将URL转为URI后获取路径用于解决路径被编码的问题
*
* @param url {@link URL}
* @return 路径
* @since 3.0.8
*/
public static String getDecodedPath(URL url) {
String path = null;
try {
// URL对象的getPath方法对于包含中文或空格的问题
path = URLUtil.toURI(url).getPath();
} catch (UtilException e) {
// ignore
}
return (null != path) ? path : url.getPath();
}
/**
* 转URL为URI
*
* @param url URL
* @return URI
* @exception UtilException 包装URISyntaxException
*/
public static URI toURI(URL url) throws UtilException {
if (null == url) {
return null;
}
try {
return url.toURI();
} catch (URISyntaxException e) {
throw new UtilException(e);
}
}
/**
* 转字符串为URI
*
* @param location 字符串路径
* @return URI
* @exception UtilException 包装URISyntaxException
*/
public static URI toURI(String location) throws UtilException {
try {
return new URI(location.replace(" ", "%20"));
} catch (URISyntaxException e) {
throw new UtilException(e);
}
}
/**
* 提供的URL是否为文件
* 文件协议包括"file", "vfsfile" 或 "vfs".
*
* @param url {@link URL}
* @return 是否为文件
* @since 3.0.9
*/
public static boolean isFileURL(URL url) {
String protocol = url.getProtocol();
return (URL_PROTOCOL_FILE.equals(protocol) || //
URL_PROTOCOL_VFSFILE.equals(protocol) || //
URL_PROTOCOL_VFS.equals(protocol));
}
/**
* 提供的URL是否为jar包URL
* 协议包括： "jar", "zip", "vfszip" 或 "wsjar".
* @param url {@link URL}
* @return 是否为jar包URL
*/
public static boolean isJarURL(URL url) {
final String protocol = url.getProtocol();
return (URL_PROTOCOL_JAR.equals(protocol) || //
URL_PROTOCOL_ZIP.equals(protocol) || //
URL_PROTOCOL_VFSZIP.equals(protocol) || //
URL_PROTOCOL_WSJAR.equals(protocol));
}
/**
* 提供的URL是否为Jar文件URL
* 判断依据为file协议且扩展名为.jar
* @param url the URL to check
* @return whether the URL has been identified as a JAR file URL
* @since 4.1
*/
public static boolean isJarFileURL(URL url) {
return (URL_PROTOCOL_FILE.equals(url.getProtocol()) && //
url.getPath().toLowerCase().endsWith(FileUtil.JAR_FILE_EXT));
}
}