类加载工具 - ClassLoaderUtil

简介

ClassLoaderUtil 是 Hutool 提供的一个用于处理类加载的工具类。它封装了一些与 ClassLoader 相关的常用操作，例如获取当前线程的 ClassLoader、加载类、检查类是否存在等。通过这些方法，可以更灵活地进行类的加载和处理。

1. 获取 ClassLoader

ClassLoaderUtil 提供了获取当前线程的 ClassLoader 和系统默认 ClassLoader 的方法。使用这些方法可以确保获取到正确的 ClassLoader，避免在复杂环境下出现类加载问题。

import cn.hutool.core.util.ClassLoaderUtil;

public class ClassLoaderUtilExample {
    public static void main(String[] args) {
        // 获取当前线程的 ContextClassLoader
        ClassLoader contextClassLoader = ClassLoaderUtil.getContextClassLoader();
        System.out.println("当前线程的 ContextClassLoader: " + contextClassLoader);

        // 按规则获取 ClassLoader
        ClassLoader classLoader = ClassLoaderUtil.getClassLoader();
        System.out.println("获取的 ClassLoader: " + classLoader);
    }
}

• getContextClassLoader()：获取当前线程的 ContextClassLoader，实际上调用的是 Thread.currentThread().getContextClassLoader()。
• getClassLoader()：按照以下顺序规则查找获取 ClassLoader：
  1. 获取当前线程的 ContextClassLoader。
  2. 获取 ClassLoaderUtil 类对应的 ClassLoader。
  3. 获取系统 ClassLoader (ClassLoader.getSystemClassLoader())。

作用： 在复杂的类加载环境中，确保获取到正确的 ClassLoader，避免由于 ClassLoader 不一致导致的问题。

实际开发场景： 在需要动态加载类或者操作资源文件时，可以使用这些方法获取合适的 ClassLoader。

2. 加载 Class

ClassLoaderUtil 封装了类加载的方法，使得加载类更加方便。它支持加载原始类型、数组类型、内部类等多种形式的类名，并提供检查类是否存在的方法。

import cn.hutool.core.util.ClassLoaderUtil;

public class ClassLoaderUtilExample {
    public static void main(String[] args) {
        try {
            // 加载一个类
            Class<?> clazz = ClassLoaderUtil.loadClass("java.lang.String");
            System.out.println("加载的类: " + clazz.getName());

            // 加载原始类型
            Class<?> intClass = ClassLoaderUtil.loadClass("int");
            System.out.println("加载的原始类型: " + intClass.getName());

            // 加载数组类型
            Class<?> stringArrayClass = ClassLoaderUtil.loadClass("java.lang.String[]");
            System.out.println("加载的数组类型: " + stringArrayClass.getName());

            // 加载内部类
            Class<?> innerClass = ClassLoaderUtil.loadClass("java.util.Map.Entry");
            System.out.println("加载的内部类: " + innerClass.getName());
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

• loadClass(String className)：根据类名加载类，支持以下几类类名的加载：

  1. 原始类型，例如：int。
  2. 数组类型，例如：int[]、Long[]、String[]。
  3. 内部类，例如：java.lang.Thread.State 会被转为 java.lang.Thread$State 加载。

• loadPrimitiveClass(String className)：用于加载原始类型的类，包括原始类型、原始类型数组和 void。

作用： 提供了一种统一的类加载方式，简化了不同类型类的加载操作，避免直接使用 Class.forName 的繁琐。

实际开发场景： 在需要动态加载类名不确定的类时，可以使用该方法进行加载，例如在插件系统、反射调用等场景中。

3. 检查类是否存在

ClassLoaderUtil 提供了 isPresent 方法，用于检查指定类是否存在。它通过尝试加载类，如果加载失败（例如类不存在或关联类不存在），则返回 false。

import cn.hutool.core.util.ClassLoaderUtil;

public class ClassLoaderUtilExample {
    public static void main(String[] args) {
        // 检查一个类是否存在
        boolean isPresent = ClassLoaderUtil.isPresent("java.lang.String");
        System.out.println("类 java.lang.String 是否存在: " + isPresent); // true

        // 检查一个不存在的类
        boolean isNotPresent = ClassLoaderUtil.isPresent("com.example.NonExistentClass");
        System.out.println("类 com.example.NonExistentClass 是否存在: " + isNotPresent); // false
    }
}

• isPresent(String className)：指定类是否存在，通过调用 loadClass 方法尝试加载指定类名的类，如果加载失败则返回 false。

作用： 在动态加载类之前，可以通过该方法检查类是否存在，避免在后续使用中发生 ClassNotFoundException。

实际开发场景： 在插件系统、动态模块加载中，可以使用该方法预先检查依赖的类是否存在，从而提高系统的稳定性。

总结

ClassLoaderUtil 是一个方便且实用的类加载工具类，它封装了与 ClassLoader 相关的常用操作，适用于需要动态加载类、处理资源文件和检查类存在性的场景。通过它的封装，可以更安全、简洁地进行类加载操作，避免手动处理类加载时的繁琐细节。