Java類加載器( 死磕9)

【正文】Java類加載器( CLassLoader ) 死磕9:

上下文加載器原理和案例

本小節目錄

9.1. 父加載器不能訪問子加載器的類
9.2. 一個寵物工廠接口
9.3. 一個寵物工廠管理類
9.4 APPClassLoader不能訪問子加載器中的類
9.5. 線程上下文類加載器

類加載器的代理模式並不能解決 Java 應用開發中會遇到的類加載器的全部問題。Java 提供了很多服務提供者接口（Service Provider Interface，SPI），允許第三方爲這些接口提供實現。常見的 SPI 有 JDBC、JCE、JNDI、JAXP 和 JBI 等。這些 SPI 的接口由 Java 核心庫來提供，如 JAXP 的 SPI 接口定義包含在 javax.xml.parsers包中。這些 SPI 的實現代碼很可能是作爲 Java 應用所依賴的 jar 包被包含進來，可以通過類路徑（CLASSPATH）來找到，如實現了 JAXP SPI 的 Apache Xerces所包含的 jar 包。SPI 接口中的代碼經常需要加載具體的實現類。如 JAXP 中的 javax.xml.parsers.DocumentBuilderFactory類中的 newInstance()方法用來生成一個新的 DocumentBuilderFactory的實例。這裏的實例的真正的類是繼承自 javax.xml.parsers.DocumentBuilderFactory，由 SPI 的實現所提供的。如在 Apache Xerces 中，實現的類是 org.apache.xerces.jaxp.DocumentBuilderFactoryImpl。而問題在於，SPI 的接口是 Java 核心庫的一部分，是由引導類加載器來加載的；SPI 實現的 Java 類一般是由系統類加載器來加載的。引導類加載器是無法找到 SPI 的實現類的，因爲它只加載 Java 的核心庫。它也不能代理給系統類加載器，因爲它是系統類加載器的祖先類加載器。也就是說，類加載器的代理模式無法解決這個問題。

線程上下文類加載器（context class loader）是從 JDK 1.2 開始引入的。

在類java.lang.Thread中的方法 getContextClassLoader()和 setContextClassLoader(ClassLoader cl)用來獲取和設置線程的上下文類加載器。

如果沒有通過 setContextClassLoader(ClassLoader cl)方法進行設置的話，線程將繼承其父線程的上下文類加載器。Java 應用運行的初始線程的上下文類加載器是AppClassLoader類加載器。

線程上下文類加載器正好解決了這個問題。如果不做任何的設置，Java 應用的線程的上下文類加載器默認就是系統上下文類加載器。在 SPI 接口的代碼中使用線程上下文類加載器，就可以成功的加載到 SPI 實現的類。線程上下文類加載器在很多 SPI 的實現中都會用到。

1.1.1. 父加載器不能訪問子加載器的類

關於父加載器，不能訪問子加載器加載的類，是一個比較大的問題，舉個栗子。

1.1.2. 一個寵物工廠接口

這裏有一個寵物工廠接口：

face IPetFactory {

    /**

     * 根據類型，構造一個對象

     * @param type 類型，如 Type.CAT

     * @return

     */

    IPet buildePet(IPet.Type type);

}

1.1.3. 一個寵物工廠管理類

還有一個寵物工廠管理類，根據類名，加載工廠實現類。

public class FactoryManager

{

    /**

     * 單例的Pet實例工廠

     */

    private static IPetFactory petFactory;

    /**

     * 已經類名，取得工廠實例

     *

     * @param factoryClassName

     * @return

     */

    public static IPetFactory getInstance(String factoryClassName)

    {

        if (null != petFactory)

        {

            return petFactory;

        }

        if (null == factoryClassName)

        {

            //默認的實現

            factoryClassName = "com.crazymakercircle.petStore.pet.factory.PetFactoryImpl";

        }

        /**

         * 獲得線程上下文加載器

         */

        ClassLoader loader = Thread.currentThread().getContextClassLoader();

        try

        {

//            Class<?> factoryClass = loader.loadClass(factoryClassName);

            Class<?>   factoryClass=Class.forName(factoryClassName);

            petFactory = (IPetFactory) factoryClass.newInstance();

        } catch (Exception e)

        {

            e.printStackTrace();

        }

        return petFactory;

    }

}

1.1.4. APPClassLoader不能訪問子加載器中的類

先上代碼：

public class FailCase

{

   private static IPetFactory petFactory=null;

    public static void testLoader()

    {

        try

        {

            String baseDir = SystemConfig.PET_LIB_PATH;

            FileClassLoader classLoader = new FileClassLoader(baseDir);

            String className = SystemConfig.PET_FACTORY_CLASS;

            Class petFactoryClass = classLoader.loadClass(className);

            Logger.info("顯示petFactoryClass 的ClassLoader tree:");

            ClassLoaderUtil.showLoader4Class(petFactoryClass);

            petFactory = FactoryManager.getInstance(className);

        } catch (ClassNotFoundException e)

        {

            e.printStackTrace();

        }

    }

    public static void showPet()

    {

        IPet dog=petFactory.buildePet(IPet.Type.DOG);

        dog.sayHello();

    }

    public static void main(String[] args)

    {

        testLoader();

        showPet();

    }

}

運行上面的栗子，試一試。

發現，是失敗的。

原因是，FactoryManager是APPClassLoader加載的，而第三方的工廠類是FileClassLoader 加載的。

FileClassLoader 是APPClassLoader的子加載器。子加載器可以訪問父加載器中的類，但是父親不能訪問子加載器中的類。

所以，FactoryManager沒有辦法load子加載器中的工廠實現類。

1.1.5. 線程上下文類加載器

使用線程上下文類加載器，可以在執行線程中拋棄雙親委派加載鏈模式，使用線程上下文裏的類加載器加載類。

public class CorrectCase

{

   private static IPetFactory petFactory=null;

    public static void testLoader()

    {

        try

        {

            String baseDir = SystemConfig.PET_LIB_PATH;

            FileClassLoader classLoader = new FileClassLoader(baseDir);

            Thread.currentThread().setContextClassLoader(classLoader);

            String className = SystemConfig.PET_FACTORY_CLASS;

            petFactory = FactoryManager.getInstance(className);

            Class petFactoryClass = classLoader.loadClass(className);

            Logger.info("顯示petFactoryClass 的ClassLoader tree:");

            ClassLoaderUtil.showLoader4Class(petFactoryClass);

        } catch (ClassNotFoundException e)

        {

            e.printStackTrace();

        }

    }

    public static void showPet()

    {

        IPet dog=petFactory.buildePet(IPet.Type.DOG);

        dog.sayHello();

    }

    public static void main(String[] args)

    {

        testLoader();

        showPet();

    }

}

將FileClassLoader設置成爲線程上下文加載器，然後，在工廠管理器中，使用線程上限加載器加載：

public class FactoryManager

{

    /**

     * 單例的Pet實例工廠

     */

    private static IPetFactory petFactory;

    /**

     * 已經類名，取得工廠實例

     *

     * @param factoryClassName

     * @return

     */

    public static IPetFactory getInstance(String factoryClassName)

    {

        if (null != petFactory)
        {
            return petFactory;
        }

        if (null == factoryClassName)
        {
            //默認的實現
           factoryClassName ="com.crazymakercircle.petStore.pet.factory.PetFactoryImpl";

        }

        /**

         * 獲得線程上下文加載器

         */

        ClassLoader loader = Thread.currentThread().getContextClassLoader();

        try

        {
            Class<?> factoryClass = loader.loadClass(factoryClassName);
            petFactory = (IPetFactory) factoryClass.newInstance();

        } catch (Exception e)

        {

            e.printStackTrace();

        }

        return petFactory;

    }

}