自定義Classloader致使ClassCastException

背景

java.lang.ClassCastException: cn.com.nightfield.Plugin cannot be cast to cn.com.nightfield.Plugin

相同的class，居然不能cast？這是什麼鬼？

問題描述

自定義類加載器(Classloader)是很常見的，它可讓咱們從自定義的文件系統目錄，網絡甚至是數據庫的各類文件類型(jar, war, zip等)中加載class文件。 咱們項目中使用了一個開源的類管理工具PF4J，來加載指定目錄下的class文件。但奇怪的是，當咱們把class加載進來以後，將它強轉爲目標類型，卻報了java.lang.ClassCastException，二者明明是同一個class！

問題分析

先說明，錯誤是跟自定義類加載器有關。上一個小demo來模擬一下上述錯誤：

package cn.com.nightfield.jvm.classloader;
// 在class path下定義一個類
public class Plugin {}

package cn.com.nightfield.jvm.classloader;

import java.net.URL;
import java.net.URLClassLoader;
// 自定義一個類加載器
public class CustomizedClassLoader extends URLClassLoader {

    public CustomizedClassLoader(URL[] urls) {
        super(urls);
    }

    protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
        synchronized (getClassLoadingLock(name)) {
            // 若是不是自定義目錄下的class，統一委託給AppClassloader去加載
            if (!name.startsWith("cn.com.nightfield.jvm.classloader")) {
                return super.loadClass(name, resolve);
            }
            // 若是是自定義目錄下的class，直接加載，此處違反了雙親委派模型
            else {
                Class<?> c = findClass(name);
                if (resolve) {
                    resolveClass(c);
                }
                return c;
            }
        }
    }
}

package cn.com.nightfield.jvm.classloader;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;

public class ClassLoaderTest {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, MalformedURLException {
        // 指定類加載器的加載路徑
        URL url = new File("/Users/zhochi/demo/target/classes").toURI().toURL();
        ClassLoader customizedClassLoader = new CustomizedClassLoader(new URL[]{url});
        // 用自定義類加載器加載Plugin class
        Class clz = customizedClassLoader.loadClass("cn.com.nightfield.jvm.classloader.Plugin");
        System.out.println(clz.getClassLoader());
        Object pluginInstance = clz.newInstance();
        // pluginInstance instanceof Plugin」輸出false
        System.out.println("pluginInstance instanceof Plugin: " + (pluginInstance instanceof Plugin));
        // 報java.lang.ClassCastException錯誤
        Plugin plugin = (Plugin) clz.newInstance();
    }
}

控制檯輸出以下：

cn.com.nightfield.jvm.classloader.CustomizedClassLoader@60e53b93
pluginInstance instanceof Plugin: false
Exception in thread "main" java.lang.ClassCastException: cn.com.nightfield.jvm.classloader.Plugin cannot be cast to cn.com.nightfield.jvm.classloader.Plugin
	at cn.com.nightfield.jvm.classloader.ClassLoaderTest.main(ClassLoaderTest.java:19)

要想知道錯誤的根源，須要瞭解對象能夠被cast的前提：對象必須是目標類的實例。從上述輸出也能夠看到，instance instanceof Plugin的結果是false，爲何呢？由於對於任意一個類，都須要由它的類加載器和這個類自己，共同確立其在JVM中的惟一性，也就是說，JVM中兩個類是否相等，首先要看它們是否是由同一個類加載器加載的。若是不是的話，即便這兩個類來自於同一個class文件，它們也不相等。

上例中，Plugin類處於class path下，默認是由AppClassloader來加載的；可是pluginInstance倒是由CustomizedClassLoader加載出來的class的實例。JVM嘗試將CustomizedClassLoader.Plugin轉成AppClassloader.Plugin，必然會報錯。

問題解決

其實究其緣由，是咱們在自定義類加載器CustomizedClassLoader中，違反了雙親委派模型。 咱們都知道，Java中有三大類加載器：BootstrapClassLoader，ExtClassLoader和AppClassLoader，它們在組合上構成父子關係，前者是後者的"父親"，而且有各自的「領地」：BootstrapClassLoader負責加載 Java核心類庫如JRE中的rt.jar，resource.jar；ExtClassLoader負責加載{java.home}/lib/ext和java.ext.dirs系統目錄下的class；AppClassLoader則是加載class path路徑下，也就是咱們本身寫的class文件。 所謂雙親委派模型，指的是當Classloader收到一個加載class請求的時候，首先會委託給其父親去加載，若是父親加載不成功，本身才會嘗試去加載。雙親委派的機制是JVM中類的安全性的一大保障：就算有人惡意自定義了一個String.class，最終由類加載器加載到的依然是rt.jar中的String。如下是loadClass的部分源碼：

public abstract class ClassLoader {
    protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
        synchronized (getClassLoadingLock(name)) {
            // 1. 若是類已經被加載過了，直接返回
            Class<?> c = findLoadedClass(name);
            if (c == null) {
                try {
                    // 2. 委託父類去加載
                    if (parent != null) {
                        c = parent.loadClass(name, false);
                    } else {
                        // 這種狀況指的就是委託BootstrapClassLoader去加載
                        c = findBootstrapClassOrNull(name);
                    }
                } catch (ClassNotFoundException e) {
                    // ClassNotFoundException thrown if class not found
                    // from the non-null parent class loader
                }

                if (c == null) {
                    // 3. 嘗試本身加載
                    c = findClass(name);
                }
            }
            if (resolve) {
                resolveClass(c);
            }
            return c;
        }
    }

不過，雙親委派模型並非一個強制的約束，而是Java推薦的模式，因此咱們在自定義類加載器的時候，推薦重寫findClass()方法，而不是loadClass()方法。

回到最開始的問題，分析了一下PF4J的源碼，能夠猜到，它也定義了本身的類加載器PluginClassLoader，且它重寫的loadClass()方法的默認實現，爲了防止class的版本問題，違反了雙親委派模型。

總結

Java中的類加載器，至關因而其加載的class的命名空間，兩個類相等，首先要保證它們是由同一個類加載器加載的。 在實現自定義類加載器的時候，除非你對類加載機制有着深入的認知且知道本身在作什麼，不然不要違反雙親委派模型。