com.dahuatech.hutool.core.util.ClassUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-sdk-common Show documentation
Show all versions of java-sdk-common Show documentation
Dahua ICC Open API SDK for Java
package com.dahuatech.hutool.core.util;
import com.dahuatech.hutool.core.convert.BasicType;
import com.dahuatech.hutool.core.exceptions.UtilException;
import com.dahuatech.hutool.core.io.FileUtil;
import com.dahuatech.hutool.core.io.IORuntimeException;
import com.dahuatech.hutool.core.io.resource.ResourceUtil;
import com.dahuatech.hutool.core.lang.Assert;
import com.dahuatech.hutool.core.lang.ClassScanner;
import com.dahuatech.hutool.core.lang.Filter;
import com.dahuatech.hutool.core.lang.Singleton;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Type;
import java.net.URI;
import java.net.URL;
import java.util.*;
/**
* 类工具类
*
* @author xiaoleilu
*/
public class ClassUtil {
/**
* {@code null}安全的获取对象类型
*
* @param 对象类型
* @param obj 对象，如果为{@code null} 返回{@code null}
* @return 对象类型，提供对象如果为{@code null} 返回{@code null}
*/
@SuppressWarnings("unchecked")
public static Class getClass(T obj) {
return ((null == obj) ? null : (Class) obj.getClass());
}
/**
* 获得外围类
* 返回定义此类或匿名类所在的类，如果类本身是在包中定义的，返回{@code null}
*
* @param clazz 类
* @return 外围类
* @since 4.5.7
*/
public static Class getEnclosingClass(Class clazz) {
return null == clazz ? null : clazz.getEnclosingClass();
}
/**
* 是否为顶层类，即定义在包中的类，而非定义在类中的内部类
*
* @param clazz 类
* @return 是否为顶层类
* @since 4.5.7
*/
public static boolean isTopLevelClass(Class clazz) {
if (null == clazz) {
return false;
}
return null == getEnclosingClass(clazz);
}
/**
* 获取类名
*
* @param obj 获取类名对象
* @param isSimple 是否简单类名，如果为true，返回不带包名的类名
* @return 类名
* @since 3.0.7
*/
public static String getClassName(Object obj, boolean isSimple) {
if (null == obj) {
return null;
}
final Class clazz = obj.getClass();
return getClassName(clazz, isSimple);
}
/**
* 获取类名
* 类名并不包含“.class”这个扩展名
* 例如：ClassUtil这个类
*
*
* isSimple为false: "com.xiaoleilu.hutool.util.ClassUtil"
* isSimple为true: "ClassUtil"
*
*
* @param clazz 类
* @param isSimple 是否简单类名，如果为true，返回不带包名的类名
* @return 类名
* @since 3.0.7
*/
public static String getClassName(Class clazz, boolean isSimple) {
if (null == clazz) {
return null;
}
return isSimple ? clazz.getSimpleName() : clazz.getName();
}
/**
* 获取完整类名的短格式如：
* com.dahuatech.hutool.core.util.StrUtil -》c.h.c.u.StrUtil
*
* @param className 类名
* @return 短格式类名
* @since 4.1.9
*/
public static String getShortClassName(String className) {
final List packages = StrUtil.split(className, CharUtil.DOT);
if (null == packages || packages.size() < 2) {
return className;
}
final int size = packages.size();
final StringBuilder result = StrUtil.builder();
result.append(packages.get(0).charAt(0));
for (int i = 1; i < size - 1; i++) {
result.append(CharUtil.DOT).append(packages.get(i).charAt(0));
}
result.append(CharUtil.DOT).append(packages.get(size - 1));
return result.toString();
}
/**
* 获得对象数组的类数组
*
* @param objects 对象数组，如果数组中存在{@code null}元素，则此元素被认为是Object类型
* @return 类数组
*/
public static Class[] getClasses(Object... objects) {
Class[] classes = new Class[objects.length];
Object obj;
for (int i = 0; i < objects.length; i++) {
obj = objects[i];
classes[i] = (null == obj) ? Object.class : obj.getClass();
}
return classes;
}
/**
* 指定类是否与给定的类名相同
*
* @param clazz 类
* @param className 类名，可以是全类名（包含包名），也可以是简单类名（不包含包名）
* @param ignoreCase 是否忽略大小写
* @return 指定类是否与给定的类名相同
* @since 3.0.7
*/
public static boolean equals(Class clazz, String className, boolean ignoreCase) {
if (null == clazz || StrUtil.isBlank(className)) {
return false;
}
if (ignoreCase) {
return className.equalsIgnoreCase(clazz.getName())
|| className.equalsIgnoreCase(clazz.getSimpleName());
} else {
return className.equals(clazz.getName()) || className.equals(clazz.getSimpleName());
}
}
// ----------------------------------------------------------------------------------------- Scan
// classes
/**
* 扫描指定包路径下所有包含指定注解的类
*
* @param packageName 包路径
* @param annotationClass 注解类
* @return 类集合
* @see ClassScanner#scanPackageByAnnotation(String, Class)
*/
public static Set> scanPackageByAnnotation(
String packageName, final Class annotationClass) {
return ClassScanner.scanPackageByAnnotation(packageName, annotationClass);
}
/**
* 扫描指定包路径下所有指定类或接口的子类或实现类
*
* @param packageName 包路径
* @param superClass 父类或接口
* @return 类集合
* @see ClassScanner#scanPackageBySuper(String, Class)
*/
public static Set> scanPackageBySuper(String packageName, final Class superClass) {
return ClassScanner.scanPackageBySuper(packageName, superClass);
}
/**
* 扫面该包路径下所有class文件
*
* @return 类集合
* @see ClassScanner#scanPackage()
*/
public static Set> scanPackage() {
return ClassScanner.scanPackage();
}
/**
* 扫面该包路径下所有class文件
*
* @param packageName 包路径 com | com. | com.abs | com.abs.
* @return 类集合
* @see ClassScanner#scanPackage(String)
*/
public static Set> scanPackage(String packageName) {
return ClassScanner.scanPackage(packageName);
}
/**
* 扫面包路径下满足class过滤器条件的所有class文件，
* 如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException
* 因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理,有可能是一个不完善的地方，以后需要进行修改
*
* @param packageName 包路径 com | com. | com.abs | com.abs.
* @param classFilter class过滤器，过滤掉不需要的class
* @return 类集合
*/
public static Set> scanPackage(String packageName, Filter> classFilter) {
return ClassScanner.scanPackage(packageName, classFilter);
}
// -----------------------------------------------------------------------------------------
// Method
/**
* 获得指定类中的Public方法名
* 去重重载的方法
*
* @param clazz 类
* @return 方法名Set
*/
public static Set getPublicMethodNames(Class clazz) {
return ReflectUtil.getPublicMethodNames(clazz);
}
/**
* 获得本类及其父类所有Public方法
*
* @param clazz 查找方法的类
* @return 过滤后的方法列表
*/
public static Method[] getPublicMethods(Class clazz) {
return ReflectUtil.getPublicMethods(clazz);
}
/**
* 获得指定类过滤后的Public方法列表
*
* @param clazz 查找方法的类
* @param filter 过滤器
* @return 过滤后的方法列表
*/
public static List getPublicMethods(Class clazz, Filter filter) {
return ReflectUtil.getPublicMethods(clazz, filter);
}
/**
* 获得指定类过滤后的Public方法列表
*
* @param clazz 查找方法的类
* @param excludeMethods 不包括的方法
* @return 过滤后的方法列表
*/
public static List getPublicMethods(Class clazz, Method... excludeMethods) {
return ReflectUtil.getPublicMethods(clazz, excludeMethods);
}
/**
* 获得指定类过滤后的Public方法列表
*
* @param clazz 查找方法的类
* @param excludeMethodNames 不包括的方法名列表
* @return 过滤后的方法列表
*/
public static List getPublicMethods(Class clazz, String... excludeMethodNames) {
return ReflectUtil.getPublicMethods(clazz, excludeMethodNames);
}
/**
* 查找指定Public方法 如果找不到对应的方法或方法不为public的则返回null
*
* @param clazz 类
* @param methodName 方法名
* @param paramTypes 参数类型
* @return 方法
* @throws SecurityException 无权访问抛出异常
*/
public static Method getPublicMethod(Class clazz, String methodName, Class... paramTypes)
throws SecurityException {
return ReflectUtil.getPublicMethod(clazz, methodName, paramTypes);
}
/**
* 获得指定类中的Public方法名
* 去重重载的方法
*
* @param clazz 类
* @return 方法名Set
*/
public static Set getDeclaredMethodNames(Class clazz) {
return ReflectUtil.getMethodNames(clazz);
}
/**
* 获得声明的所有方法，包括本类及其父类和接口的所有方法和Object类的方法
*
* @param clazz 类
* @return 方法数组
*/
public static Method[] getDeclaredMethods(Class clazz) {
return ReflectUtil.getMethods(clazz);
}
/**
* 查找指定对象中的所有方法（包括非public方法），也包括父对象和Object类的方法
*
* @param obj 被查找的对象
* @param methodName 方法名
* @param args 参数
* @return 方法
* @throws SecurityException 无访问权限抛出异常
*/
public static Method getDeclaredMethodOfObj(Object obj, String methodName, Object... args)
throws SecurityException {
return getDeclaredMethod(obj.getClass(), methodName, getClasses(args));
}
/**
* 查找指定类中的所有方法（包括非public方法），也包括父类和Object类的方法 找不到方法会返回null
*
* @param clazz 被查找的类
* @param methodName 方法名
* @param parameterTypes 参数类型
* @return 方法
* @throws SecurityException 无访问权限抛出异常
*/
public static Method getDeclaredMethod(
Class clazz, String methodName, Class... parameterTypes) throws SecurityException {
return ReflectUtil.getMethod(clazz, methodName, parameterTypes);
}
// ----------------------------------------------------------------------------------------- Field
/**
* 查找指定类中的所有字段（包括非public字段）， 字段不存在则返回null
*
* @param clazz 被查找字段的类
* @param fieldName 字段名
* @return 字段
* @throws SecurityException 安全异常
*/
public static Field getDeclaredField(Class clazz, String fieldName) throws SecurityException {
if (null == clazz || StrUtil.isBlank(fieldName)) {
return null;
}
try {
return clazz.getDeclaredField(fieldName);
} catch (NoSuchFieldException e) {
// e.printStackTrace();
}
return null;
}
/**
* 查找指定类中的所有字段（包括非public字段)
*
* @param clazz 被查找字段的类
* @return 字段
* @throws SecurityException 安全异常
*/
public static Field[] getDeclaredFields(Class clazz) throws SecurityException {
if (null == clazz) {
return null;
}
return clazz.getDeclaredFields();
}
// -----------------------------------------------------------------------------------------
// Classpath
/**
* 获得ClassPath，不解码路径中的特殊字符（例如空格和中文）
*
* @return ClassPath集合
*/
public static Set getClassPathResources() {
return getClassPathResources(false);
}
/**
* 获得ClassPath
*
* @param isDecode 是否解码路径中的特殊字符（例如空格和中文）
* @return ClassPath集合
* @since 4.0.11
*/
public static Set getClassPathResources(boolean isDecode) {
return getClassPaths(StrUtil.EMPTY, isDecode);
}
/**
* 获得ClassPath，不解码路径中的特殊字符（例如空格和中文）
*
* @param packageName 包名称
* @return ClassPath路径字符串集合
*/
public static Set getClassPaths(String packageName) {
return getClassPaths(packageName, false);
}
/**
* 获得ClassPath
*
* @param packageName 包名称
* @param isDecode 是否解码路径中的特殊字符（例如空格和中文）
* @return ClassPath路径字符串集合
* @since 4.0.11
*/
public static Set getClassPaths(String packageName, boolean isDecode) {
String packagePath = packageName.replace(StrUtil.DOT, StrUtil.SLASH);
Enumeration resources;
try {
resources = getClassLoader().getResources(packagePath);
} catch (IOException e) {
throw new UtilException(e, "Loading classPath [{}] error!", packagePath);
}
final Set paths = new HashSet<>();
String path;
while (resources.hasMoreElements()) {
path = resources.nextElement().getPath();
paths.add(isDecode ? URLUtil.decode(path, CharsetUtil.systemCharsetName()) : path);
}
return paths;
}
/**
* 获得ClassPath，将编码后的中文路径解码为原字符
* 这个ClassPath路径会文件路径被标准化处理
*
* @return ClassPath
*/
public static String getClassPath() {
return getClassPath(false);
}
/**
* 获得ClassPath，这个ClassPath路径会文件路径被标准化处理
*
* @param isEncoded 是否编码路径中的中文
* @return ClassPath
* @since 3.2.1
*/
public static String getClassPath(boolean isEncoded) {
final URL classPathURL = getClassPathURL();
String url = isEncoded ? classPathURL.getPath() : URLUtil.getDecodedPath(classPathURL);
return FileUtil.normalize(url);
}
/**
* 获得ClassPath URL
*
* @return ClassPath URL
*/
public static URL getClassPathURL() {
return getResourceURL(StrUtil.EMPTY);
}
/**
* 获得资源的URL
* 路径用/分隔，例如:
*
*
* config/a/db.config
* spring/xml/test.xml
*
*
* @param resource 资源（相对Classpath的路径）
* @return 资源URL
* @see ResourceUtil#getResource(String)
*/
public static URL getResourceURL(String resource) throws IORuntimeException {
return ResourceUtil.getResource(resource);
}
/**
* 获取指定路径下的资源列表
* 路径格式必须为目录格式,用/分隔，例如:
*
*
* config/a
* spring/xml
*
*
* @param resource 资源路径
* @return 资源列表
* @see ResourceUtil#getResources(String)
*/
public static List getResources(String resource) {
return ResourceUtil.getResources(resource);
}
/**
* 获得资源相对路径对应的URL
*
* @param resource 资源相对路径
* @param baseClass 基准Class，获得的相对路径相对于此Class所在路径，如果为{@code null}则相对ClassPath
* @return {@link URL}
* @see ResourceUtil#getResource(String, Class)
*/
public static URL getResourceUrl(String resource, Class baseClass) {
return ResourceUtil.getResource(resource, baseClass);
}
/** @return 获得Java ClassPath路径，不包括 jre */
public static String[] getJavaClassPaths() {
return System.getProperty("java.class.path").split(System.getProperty("path.separator"));
}
/**
* 获取当前线程的{@link ClassLoader}
*
* @return 当前线程的class loader
* @see ClassLoaderUtil#getClassLoader()
*/
public static ClassLoader getContextClassLoader() {
return ClassLoaderUtil.getContextClassLoader();
}
/**
* 获取{@link ClassLoader}
* 获取顺序如下：
*
*
* 1、获取当前线程的ContextClassLoader
* 2、获取{@link ClassUtil}类对应的ClassLoader
* 3、获取系统ClassLoader（{@link ClassLoader#getSystemClassLoader()}）
*
*
* @return 类加载器
*/
public static ClassLoader getClassLoader() {
return ClassLoaderUtil.getClassLoader();
}
/**
* 比较判断types1和types2两组类，如果types1中所有的类都与types2对应位置的类相同，或者是其父类或接口，则返回true
*
* @param types1 类组1
* @param types2 类组2
* @return 是否相同、父类或接口
*/
public static boolean isAllAssignableFrom(Class[] types1, Class[] types2) {
if (ArrayUtil.isEmpty(types1) && ArrayUtil.isEmpty(types2)) {
return true;
}
if (null == types1 || null == types2) {
// 任何一个为null不相等（之前已判断两个都为null的情况）
return false;
}
if (types1.length != types2.length) {
return false;
}
Class type1;
Class type2;
for (int i = 0; i < types1.length; i++) {
type1 = types1[i];
type2 = types2[i];
if (isBasicType(type1) && isBasicType(type2)) {
// 原始类型和包装类型存在不一致情况
if (BasicType.unWrap(type1) != BasicType.unWrap(type2)) {
return false;
}
} else if (false == type1.isAssignableFrom(type2)) {
return false;
}
}
return true;
}
/**
* 加载类
*
* @param 对象类型
* @param className 类名
* @param isInitialized 是否初始化
* @return 类
*/
@SuppressWarnings("unchecked")
public static Class loadClass(String className, boolean isInitialized) {
return (Class) ClassLoaderUtil.loadClass(className, isInitialized);
}
/**
* 加载类并初始化
*
* @param 对象类型
* @param className 类名
* @return 类
*/
public static Class loadClass(String className) {
return loadClass(className, true);
}
// ---------------------------------------------------------------------------------------------------- Invoke start
/**
* 执行方法
* 可执行Private方法，也可执行static方法
* 执行非static方法时，必须满足对象有默认构造方法
* 非单例模式，如果是非静态方法，每次创建一个新对象
*
* @param 对象类型
* @param classNameWithMethodName 类名和方法名表达式，类名与方法名用.或#连接
* 例如：com.xiaoleilu.hutool.StrUtil.isEmpty 或 com.xiaoleilu.hutool.StrUtil#isEmpty
* @param args 参数，必须严格对应指定方法的参数类型和数量
* @return 返回结果
*/
public static T invoke(String classNameWithMethodName, Object[] args) {
return invoke(classNameWithMethodName, false, args);
}
/**
* 执行方法
* 可执行Private方法，也可执行static方法
* 执行非static方法时，必须满足对象有默认构造方法
*
* @param 对象类型
* @param classNameWithMethodName
* 类名和方法名表达式，例如：com.xiaoleilu.hutool.StrUtil#isEmpty或com.xiaoleilu.hutool.StrUtil.isEmpty
* @param isSingleton 是否为单例对象，如果此参数为false，每次执行方法时创建一个新对象
* @param args 参数，必须严格对应指定方法的参数类型和数量
* @return 返回结果
*/
public static T invoke(String classNameWithMethodName, boolean isSingleton, Object... args) {
if (StrUtil.isBlank(classNameWithMethodName)) {
throw new UtilException("Blank classNameDotMethodName!");
}
int splitIndex = classNameWithMethodName.lastIndexOf('#');
if (splitIndex <= 0) {
splitIndex = classNameWithMethodName.lastIndexOf('.');
}
if (splitIndex <= 0) {
throw new UtilException("Invalid classNameWithMethodName [{}]!", classNameWithMethodName);
}
final String className = classNameWithMethodName.substring(0, splitIndex);
final String methodName = classNameWithMethodName.substring(splitIndex + 1);
return invoke(className, methodName, isSingleton, args);
}
/**
* 执行方法
* 可执行Private方法，也可执行static方法
* 执行非static方法时，必须满足对象有默认构造方法
* 非单例模式，如果是非静态方法，每次创建一个新对象
*
* @param 对象类型
* @param className 类名，完整类路径
* @param methodName 方法名
* @param args 参数，必须严格对应指定方法的参数类型和数量
* @return 返回结果
*/
public static T invoke(String className, String methodName, Object[] args) {
return invoke(className, methodName, false, args);
}
/**
* 执行方法
* 可执行Private方法，也可执行static方法
* 执行非static方法时，必须满足对象有默认构造方法
*
* @param 对象类型
* @param className 类名，完整类路径
* @param methodName 方法名
* @param isSingleton 是否为单例对象，如果此参数为false，每次执行方法时创建一个新对象
* @param args 参数，必须严格对应指定方法的参数类型和数量
* @return 返回结果
*/
public static T invoke(
String className, String methodName, boolean isSingleton, Object... args) {
Class