ClassUtil (hutool 6.0.0-M20 API)

java.lang.Object
- org.dromara.hutool.core.reflect.ClassUtil

```
public class ClassUtil
extends Object
```
类工具类

Author:

Looly

Constructor Summary

Constructors
Constructor and Description

ClassUtil()

Constructors
Constructor and Description
`ClassUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`equals(Class<?> clazz, String className, boolean ignoreCase)` 指定类是否与给定的类名相同
`static Class<?>`	`forName(String name, boolean isInitialized, ClassLoader loader)` 加载指定名称的类，支持：替换"/"为"."
`static <T> Class<T>`	`getClass(T obj)` `null`安全的获取对象类型
`static Class<?>[]`	`getClasses(Object... objects)` 获得对象数组的类数组
`static String`	`getClassName(Class<?> clazz, boolean isSimple)` 获取类名类名并不包含“.class”这个扩展名例如：ClassUtil这个类 isSimple为false: "org.dromara.hutool.core.reflect.ClassUtil" isSimple为true: "ClassUtil"
`static String`	`getClassName(Object obj, boolean isSimple)` 获取类名
`static String`	`getClassPath()` 获得ClassPath，将编码后的中文路径解码为原字符这个ClassPath路径会文件路径被标准化处理
`static String`	`getClassPath(boolean isEncoded)` 获得ClassPath，这个ClassPath路径会文件路径被标准化处理
`static Set<String>`	`getClassPathResources()` 获得ClassPath，不解码路径中的特殊字符（例如空格和中文）
`static Set<String>`	`getClassPathResources(boolean isDecode)` 获得ClassPath
`static Set<String>`	`getClassPaths(String packageName)` 获得ClassPath，不解码路径中的特殊字符（例如空格和中文）
`static Set<String>`	`getClassPaths(String packageName, boolean isDecode)` 获得ClassPath
`static Object`	`getDefaultValue(Class<?> clazz)` 获取指定类型分的默认值默认值规则为： 1、如果为原始类型，返回0 2、非原始类型返回 `null`
`static Object[]`	`getDefaultValues(Class<?>... classes)` 获得默认值列表
`static Class<?>`	`getEnclosingClass(Class<?> clazz)` 获得外围类返回定义此类或匿名类所在的类，如果类本身是在包中定义的，返回`null`
`static List<Class<?>>`	`getInterfaces(Class<?> cls)` 获取指定类及其父类所有的实现接口。
`static URL`	`getLocation(Class<?> clazz)` 获取class类路径URL, 不管是否在jar包中都会返回文件夹的路径 class在jar包中返回jar所在文件夹,class不在jar中返回文件夹目录 jdk中的类不能使用此方法
`static String`	`getLocationPath(Class<?> clazz)` 获取class类路径, 不管是否在jar包中都会返回文件夹的路径 class在jar包中返回jar所在文件夹,class不在jar中返回文件夹目录 jdk中的类不能使用此方法
`static String`	`getPackage(Class<?> clazz)` 获得给定类所在包的名称例如： org.dromara.hutool.core.reflect.ClassUtil =》 org.dromara.hutool.core.reflect
`static String`	`getPackagePath(Class<?> clazz)` 获得给定类所在包的路径例如： org.dromara.hutool.core.reflect.ClassUtil =》 org/dromara/hutool/core/reflect
`static Object`	`getPrimitiveDefaultValue(Class<?> clazz)` 获取指定原始类型分的默认值默认值规则为： 1、如果为原始类型，返回0 2、非原始类型返回 `null`
`static String`	`getShortClassName(String className)` 获取完整类名的短格式如： text.org.dromara.hutool.core.StrUtil -》c.h.c.u.StrUtil
`static List<Class<?>>`	`getSuperClasses(Class<?> clazz)` 获取指定类的所有父类，结果不包括指定类本身如果无父类，返回一个空的列表
`static Class<?>`	`getTypeArgument(Class<?> clazz)` 获得给定类的第一个泛型参数
`static Class<?>`	`getTypeArgument(Class<?> clazz, int index)` 获得给定类的泛型参数
`static boolean`	`isAllAssignableFrom(Class<?>[] types1, Class<?>[] types2)` 比较判断types1和types2两组类，如果types1中所有的类都与types2对应位置的类相同，或者是其父类或接口，则返回`true`
`static boolean`	`isAssignable(Class<?> targetType, Class<?> sourceType)` 检查目标类是否可以从原类转化转化包括： 1、原类是对象，目标类型是原类型实现的接口 2、目标类型是原类型的父类 3、两者是原始类型或者包装类型（相互转换）
`static boolean`	`isBasicType(Class<?> clazz)` 是否为基本类型（包括包装类和原始类）
`static boolean`	`isClassExists(String className, ClassLoader loader)` 判断指定类名的类是否存在
`static boolean`	`isEnum(Class<?> clazz)` 判断类是否为枚举类型
`static boolean`	`isJdkClass(Class<?> clazz)` 是否为JDK中定义的类或接口，判断依据： 1、以java.
`static boolean`	`isNormalClass(Class<?> clazz)` 是否为标准的类这个类必须： 1、非接口 2、非抽象类 3、非Enum枚举 4、非数组 5、非注解 6、非原始类型（int, long等）
`static boolean`	`isPrimitiveWrapper(Class<?> clazz)` 是否为包装类型
`static boolean`	`isSerializable(Class<?> clazz)` 给定类是否实现了序列化接口`Serializable`
`static boolean`	`isSimpleTypeOrArray(Class<?> clazz)` 是否为简单值类型或简单值类型的数组
`static boolean`	`isSimpleValueType(Class<?> clazz)` 是否为简单值类型包括：原始类型枚举 String、other CharSequence Number Date URI URL Locale Class jdk8时间相关类型
`static boolean`	`isTopLevelClass(Class<?> clazz)` 是否为顶层类，即定义在包中的类，而非定义在类中的内部类
`static Set<Class<?>>`	`scanPackage()` 扫描该包路径下所有class文件
`static Set<Class<?>>`	`scanPackage(String packageName)` 扫描该包路径下所有class文件
`static Set<Class<?>>`	`scanPackage(String packageName, Predicate<Class<?>> classFilter)` 扫描包路径下满足class过滤器条件的所有class文件，如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException 因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理,有可能是一个不完善的地方，以后需要进行修改
`static Set<Class<?>>`	`scanPackageByAnnotation(String packageName, Class<? extends Annotation> annotationClass)` 扫描指定包路径下所有包含指定注解的类
`static Set<Class<?>>`	`scanPackageBySuper(String packageName, Class<?> superClass)` 扫描指定包路径下所有指定类或接口的子类或实现类
`static void`	`traverseTypeHierarchy(Class<?> root, Predicate<Class<?>> filter, Consumer<Class<?>> consumer, boolean includeRoot)` 按广度优先遍历包括`root`在内，其层级结构中的所有类和接口。
`static void`	`traverseTypeHierarchyWhile(Class<?> root, Predicate<Class<?>> terminator)` 按广度优先遍历包括`root`在内，其层级结构中的所有类和接口，直到`terminator`返回`false`
`static void`	`traverseTypeHierarchyWhile(Class<?> root, Predicate<Class<?>> filter, Predicate<Class<?>> terminator)` 按广度优先遍历包括`root`在内，其层级结构中的所有类和接口，直到`terminator`返回`false`

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

- Constructor Detail
  - ClassUtil
```
public ClassUtil()
```
- Method Detail
  - getClass
```
public static <T> Class<T> getClass(T obj)
```
    null安全的获取对象类型
    
    Type Parameters:
    
    T - 对象类型
    
    Parameters:
    
    obj - 对象，如果为null 返回null
    
    Returns:
    
    对象类型，提供对象如果为null 返回null
  - getEnclosingClass
```
public static Class<?> getEnclosingClass(Class<?> clazz)
```
    获得外围类
    返回定义此类或匿名类所在的类，如果类本身是在包中定义的，返回null
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    外围类
    
    Since:
    
    4.5.7
  - isTopLevelClass
```
public static boolean isTopLevelClass(Class<?> clazz)
```
    是否为顶层类，即定义在包中的类，而非定义在类中的内部类
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为顶层类
    
    Since:
    
    4.5.7
  - getClassName
```
public static String getClassName(Object obj,
                                  boolean isSimple)
```
    获取类名
    
    Parameters:
    
    obj - 获取类名对象
    
    isSimple - 是否简单类名，如果为true，返回不带包名的类名
    
    Returns:
    
    类名
    
    Since:
    
    3.0.7
  - getClassName
```
public static String getClassName(Class<?> clazz,
                                  boolean isSimple)
```
    获取类名
    类名并不包含“.class”这个扩展名
    例如：ClassUtil这个类
```
 isSimple为false: "org.dromara.hutool.core.reflect.ClassUtil"
 isSimple为true: "ClassUtil"
 
```
    Parameters:
    
    clazz - 类
    
    isSimple - 是否简单类名，如果为true，返回不带包名的类名
    
    Returns:
    
    类名
    
    Since:
    
    3.0.7
  - getShortClassName
```
public static String getShortClassName(String className)
```
    获取完整类名的短格式如：
    text.org.dromara.hutool.core.StrUtil -》c.h.c.u.StrUtil
    
    Parameters:
    
    className - 类名
    
    Returns:
    
    短格式类名
    
    Since:
    
    4.1.9
  - getClasses
```
public static Class<?>[] getClasses(Object... objects)
```
    获得对象数组的类数组
    
    Parameters:
    
    objects - 对象数组，如果数组中存在null元素，则此元素被认为是Object类型
    
    Returns:
    
    类数组
  - equals
```
public static boolean equals(Class<?> clazz,
                             String className,
                             boolean ignoreCase)
```
    指定类是否与给定的类名相同
    
    Parameters:
    
    clazz - 类
    
    className - 类名，可以是全类名（包含包名），也可以是简单类名（不包含包名）
    
    ignoreCase - 是否忽略大小写
    
    Returns:
    
    指定类是否与给定的类名相同
    
    Since:
    
    3.0.7
  - scanPackageByAnnotation
```
public static Set<Class<?>> scanPackageByAnnotation(String packageName,
                                                    Class<? extends Annotation> annotationClass)
```
    扫描指定包路径下所有包含指定注解的类
    
    Parameters:
    
    packageName - 包路径
    
    annotationClass - 注解类
    
    Returns:
    
    类集合
    
    See Also:
    
    ClassScanner.scanPackageByAnnotation(String, Class)
  - scanPackageBySuper
```
public static Set<Class<?>> scanPackageBySuper(String packageName,
                                               Class<?> superClass)
```
    扫描指定包路径下所有指定类或接口的子类或实现类
    
    Parameters:
    
    packageName - 包路径
    
    superClass - 父类或接口
    
    Returns:
    
    类集合
    
    See Also:
    
    ClassScanner.scanPackageBySuper(String, Class)
  - scanPackage
```
public static Set<Class<?>> scanPackage()
```
    扫描该包路径下所有class文件
    
    Returns:
    
    类集合
    
    See Also:
    
    ClassScanner.scanPackage()
  - scanPackage
```
public static Set<Class<?>> scanPackage(String packageName)
```
    扫描该包路径下所有class文件
    
    Parameters:
    
    packageName - 包路径 com | com. | com.abs | com.abs.
    
    Returns:
    
    类集合
    
    See Also:
    
    ClassScanner.scanPackage(String)
  - scanPackage
```
public static Set<Class<?>> scanPackage(String packageName,
                                        Predicate<Class<?>> classFilter)
```
    扫描包路径下满足class过滤器条件的所有class文件，
    如果包路径为 com.abs + A.class 但是输入 abs会产生classNotFoundException
    因为className 应该为 com.abs.A 现在却成为abs.A,此工具类对该异常进行忽略处理,有可能是一个不完善的地方，以后需要进行修改
    
    Parameters:
    
    packageName - 包路径 com | com. | com.abs | com.abs.
    
    classFilter - class过滤器，过滤掉不需要的class
    
    Returns:
    
    类集合
  - getClassPathResources
```
public static Set<String> getClassPathResources()
```
    获得ClassPath，不解码路径中的特殊字符（例如空格和中文）
    
    Returns:
    
    ClassPath集合
  - getClassPathResources
```
public static Set<String> getClassPathResources(boolean isDecode)
```
    获得ClassPath
    
    Parameters:
    
    isDecode - 是否解码路径中的特殊字符（例如空格和中文）
    
    Returns:
    
    ClassPath集合
    
    Since:
    
    4.0.11
  - getClassPaths
```
public static Set<String> getClassPaths(String packageName)
```
    获得ClassPath，不解码路径中的特殊字符（例如空格和中文）
    
    Parameters:
    
    packageName - 包名称
    
    Returns:
    
    ClassPath路径字符串集合
  - getClassPaths
```
public static Set<String> getClassPaths(String packageName,
                                        boolean isDecode)
```
    获得ClassPath
    
    Parameters:
    
    packageName - 包名称
    
    isDecode - 是否解码路径中的特殊字符（例如空格和中文）
    
    Returns:
    
    ClassPath路径字符串集合
    
    Since:
    
    4.0.11
  - getClassPath
```
public static String getClassPath()
```
    获得ClassPath，将编码后的中文路径解码为原字符
    这个ClassPath路径会文件路径被标准化处理
    
    Returns:
    
    ClassPath
  - getClassPath
```
public static String getClassPath(boolean isEncoded)
```
    获得ClassPath，这个ClassPath路径会文件路径被标准化处理
    
    Parameters:
    
    isEncoded - 是否编码路径中的中文
    
    Returns:
    
    ClassPath
    
    Since:
    
    3.2.1
  - isAllAssignableFrom
```
public static boolean isAllAssignableFrom(Class<?>[] types1,
                                          Class<?>[] types2)
```
    比较判断types1和types2两组类，如果types1中所有的类都与types2对应位置的类相同，或者是其父类或接口，则返回true
    
    Parameters:
    
    types1 - 类组1
    
    types2 - 类组2
    
    Returns:
    
    是否相同、父类或接口
  - isPrimitiveWrapper
```
public static boolean isPrimitiveWrapper(Class<?> clazz)
```
    是否为包装类型
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为包装类型
  - isBasicType
```
public static boolean isBasicType(Class<?> clazz)
```
    是否为基本类型（包括包装类和原始类）
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为基本类型
  - isSimpleTypeOrArray
```
public static boolean isSimpleTypeOrArray(Class<?> clazz)
```
    是否为简单值类型或简单值类型的数组
    
    Parameters:
    
    clazz - 属性类
    
    Returns:
    
    是否为简单值类型或简单值类型的数组
    
    See Also:
    
    isSimpleValueType(Class)
  - isSimpleValueType
```
public static boolean isSimpleValueType(Class<?> clazz)
```
    是否为简单值类型
    包括：
```
     原始类型
     枚举
     String、other CharSequence
     Number
     Date
     URI
     URL
     Locale
     Class
     jdk8时间相关类型
 
```
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为简单值类型
  - isAssignable
```
public static boolean isAssignable(Class<?> targetType,
                                   Class<?> sourceType)
```
    检查目标类是否可以从原类转化
    转化包括：
    1、原类是对象，目标类型是原类型实现的接口
    2、目标类型是原类型的父类
    3、两者是原始类型或者包装类型（相互转换）
    
    Parameters:
    
    targetType - 目标类型
    
    sourceType - 原类型
    
    Returns:
    
    是否可转化
  - isSerializable
```
public static boolean isSerializable(Class<?> clazz)
```
    给定类是否实现了序列化接口Serializable
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否实现序列化接口Serializable
    
    Since:
    
    6.0.0
  - isNormalClass
```
public static boolean isNormalClass(Class<?> clazz)
```
    是否为标准的类
    这个类必须：
```
 1、非接口
 2、非抽象类
 3、非Enum枚举
 4、非数组
 5、非注解
 6、非原始类型（int, long等）
 
```
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为标准类
  - isEnum
```
public static boolean isEnum(Class<?> clazz)
```
    判断类是否为枚举类型
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    是否为枚举类型
    
    Since:
    
    3.2.0
  - getTypeArgument
```
public static Class<?> getTypeArgument(Class<?> clazz)
```
    获得给定类的第一个泛型参数
    
    Parameters:
    
    clazz - 被检查的类，必须是已经确定泛型类型的类
    
    Returns:
    
    Class
  - getTypeArgument
```
public static Class<?> getTypeArgument(Class<?> clazz,
                                       int index)
```
    获得给定类的泛型参数
    
    Parameters:
    
    clazz - 被检查的类，必须是已经确定泛型类型的类
    
    index - 泛型类型的索引号，即第几个泛型类型
    
    Returns:
    
    Class
  - getPackage
```
public static String getPackage(Class<?> clazz)
```
    获得给定类所在包的名称
    例如：
    org.dromara.hutool.core.reflect.ClassUtil =》 org.dromara.hutool.core.reflect
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    包名
  - getPackagePath
```
public static String getPackagePath(Class<?> clazz)
```
    获得给定类所在包的路径
    例如：
    org.dromara.hutool.core.reflect.ClassUtil =》 org/dromara/hutool/core/reflect
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    包名
  - getDefaultValue
```
public static Object getDefaultValue(Class<?> clazz)
```
    获取指定类型分的默认值
    默认值规则为：
```
 1、如果为原始类型，返回0
 2、非原始类型返回 null
 
```
    Parameters:
    
    clazz - 类
    
    Returns:
    
    默认值
    
    Since:
    
    3.0.8
  - getPrimitiveDefaultValue
```
public static Object getPrimitiveDefaultValue(Class<?> clazz)
```
    获取指定原始类型分的默认值
    默认值规则为：
```
 1、如果为原始类型，返回0
 2、非原始类型返回 null
 
```
    Parameters:
    
    clazz - 类
    
    Returns:
    
    默认值
    
    Since:
    
    5.8.0
  - getDefaultValues
```
public static Object[] getDefaultValues(Class<?>... classes)
```
    获得默认值列表
    
    Parameters:
    
    classes - 值类型
    
    Returns:
    
    默认值列表
    
    Since:
    
    3.0.9
  - isJdkClass
```
public static boolean isJdkClass(Class<?> clazz)
```
    是否为JDK中定义的类或接口，判断依据：
```
 1、以java.、javax.开头的包名
 2、ClassLoader为null
 
```
    Parameters:
    
    clazz - 被检查的类
    
    Returns:
    
    是否为JDK中定义的类或接口
    
    Since:
    
    4.6.5
  - getLocation
```
public static URL getLocation(Class<?> clazz)
```
    获取class类路径URL, 不管是否在jar包中都会返回文件夹的路径
    class在jar包中返回jar所在文件夹,class不在jar中返回文件夹目录
    jdk中的类不能使用此方法
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    URL
    
    Since:
    
    5.2.4
  - getLocationPath
```
public static String getLocationPath(Class<?> clazz)
```
    获取class类路径, 不管是否在jar包中都会返回文件夹的路径
    class在jar包中返回jar所在文件夹,class不在jar中返回文件夹目录
    jdk中的类不能使用此方法
    
    Parameters:
    
    clazz - 类
    
    Returns:
    
    class路径
    
    Since:
    
    5.2.4
  - isClassExists
```
public static boolean isClassExists(String className,
                                    ClassLoader loader)
```
    判断指定类名的类是否存在
    
    Parameters:
    
    className - 全类名
    
    loader - ClassLoader
    
    Returns:
    
    类名的类是否存在
  - forName
```
public static Class<?> forName(String name,
                               boolean isInitialized,
                               ClassLoader loader)
```
    加载指定名称的类，支持：
    - 替换"/"为"."
    - 自动查找内部类，如java.lang.Thread.State =》java.lang.Thread$State
    Parameters:
    
    name - 类名
    
    isInitialized - 是否初始化
    
    loader - ClassLoader，null表示默认
    
    Returns:
    
    指定名称对应的类，如果不存在类，返回null
    
    See Also:
    
    Class.forName(String, boolean, ClassLoader)
  - getSuperClasses
```
public static List<Class<?>> getSuperClasses(Class<?> clazz)
```
    获取指定类的所有父类，结果不包括指定类本身
    如果无父类，返回一个空的列表
    
    Parameters:
    
    clazz - 类, 可以为null
    
    Returns:
    
    指定类的所有父类列表，如果无父类，返回一个空的列表
  - getInterfaces
```
public static List<Class<?>> getInterfaces(Class<?> cls)
```
    获取指定类及其父类所有的实现接口。
    结果顺序取决于查找顺序，当前类在前，父类的接口在后。
    
    Parameters:
    
    cls - 被查找的类
    
    Returns:
    
    接口列表，若提供的查找类为null，则返回空列表
  - traverseTypeHierarchyWhile
```
public static void traverseTypeHierarchyWhile(Class<?> root,
                                              Predicate<Class<?>> terminator)
```
    按广度优先遍历包括root在内，其层级结构中的所有类和接口，直到terminator返回false
    
    Parameters:
    
    root - 根类
    
    terminator - 对遍历到的每个类与接口执行的校验，若为false则立刻中断遍历
  - traverseTypeHierarchyWhile
```
public static void traverseTypeHierarchyWhile(Class<?> root,
                                              Predicate<Class<?>> filter,
                                              Predicate<Class<?>> terminator)
```
    按广度优先遍历包括root在内，其层级结构中的所有类和接口，直到terminator返回false
    
    Parameters:
    
    root - 根类
    
    filter - 过滤器，被过滤的类及其层级结构中的类与接口将被忽略
    
    terminator - 对遍历到的每个类与接口执行的校验，若为false则立刻中断遍历
  - traverseTypeHierarchy
```
public static void traverseTypeHierarchy(Class<?> root,
                                         Predicate<Class<?>> filter,
                                         Consumer<Class<?>> consumer,
                                         boolean includeRoot)
```
    按广度优先遍历包括root在内，其层级结构中的所有类和接口。
    类遍历顺序如下：
    - 离type距离越近，则顺序越靠前；
    - 与type距离相同，则父类优先于接口；
    - 与type距离相同的接口，则顺序遵循接口在Class.getInterfaces()的顺序；
    Parameters:
    
    root - 根类
    
    filter - 过滤器，被过滤的类及其层级结构中的类与接口将被忽略
    
    consumer - 对遍历到的每个类与接口执行的操作，每个类和接口都只会被访问一次
    
    includeRoot - 是否包括根类

Class ClassUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClassUtil

Method Detail

getClass

getEnclosingClass

isTopLevelClass

getClassName

getClassName

getShortClassName

getClasses

equals

scanPackageByAnnotation

scanPackageBySuper

scanPackage

scanPackage

scanPackage

getClassPathResources

getClassPathResources

getClassPaths

getClassPaths

getClassPath

getClassPath

isAllAssignableFrom

isPrimitiveWrapper

isBasicType

isSimpleTypeOrArray

isSimpleValueType

isAssignable

isSerializable

isNormalClass

isEnum

getTypeArgument

getTypeArgument

getPackage

getPackagePath

getDefaultValue

getPrimitiveDefaultValue

getDefaultValues

isJdkClass

getLocation

getLocationPath

isClassExists

forName

getSuperClasses

getInterfaces

traverseTypeHierarchyWhile

traverseTypeHierarchyWhile

traverseTypeHierarchy