java.lang.NoClassDefFoundError: com/sun/tools/javac/Main

   

理解Java ClassLoader機制 Java ClassLoader 2006-5-23

java.lang.NoClassDefFoundError: com/sun/tools/javac/Main
最近在使用java的動態編譯的時候出現的問題,主要是由於在使用類com.sun.tool.javac.Main時,總是出現NoClassDefFoundError的錯誤,後來找到如下的文章,分析,可能是由於對於包tools.jar的載入問題,雖然我在classpath中聲明了這個包,但在eclipse環境下,始終都還是出現運行時異常,對於編譯時間正確,運行時異常的情況,eclipse一般都是由於其自身的載入機製造成的.在eclipse下,對於一般的java工程,只要設定了系統的classpath,在其中添加了tools.jar包,即可;對於plugin工程,我是將tools.jar包,直接拷貝到本工程下,並在property中引用,而且在META-INF/MANIFEST.MF檔案中的Runtime頁的classpath中添加了這個tool.jar包,這樣在運行時就沒有異常了,可以正常編譯了. 當JVM（Java虛擬機器）啟動時，會形成由三個類載入器組成的初始類載入器階層：

       bootstrap classloader
                |
       extension classloader
                |
       system classloader

bootstrap classloader －引導（也稱為原始）類載入器，它負責載入Java的核心類。在Sun的JVM中，在執行java的命令中使用-Xbootclasspath選項或使用- D選項指定sun.boot.class.path系統屬性值可以指定附加的類。這個載入器的是非常特殊的，它實際上不是 java.lang.ClassLoader的子類，而是由JVM自身實現的。大家可以通過執行以下代碼來獲得bootstrap classloader載入了那些核心類庫：
   URL[] urls=sun.misc.Launcher.getBootstrapClassPath().getURLs();
   for (int i = 0; i < urls.length; i++) {
     System.out.println(urls.toExternalform());
   }
在我的電腦上的結果為：
檔案:/C:/j2sdk1.4.1_01/jre/lib/endorsed/dom.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/endorsed/sax.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/endorsed/xalan-2.3.1.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/endorsed/xercesImpl-2.0.0.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/endorsed/xml-apis.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/endorsed/xsltc.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/rt.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/i18n.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/sunrsasign.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/jsse.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/jce.jar
檔案:/C:/j2sdk1.4.1_01/jre/lib/charsets.jar
檔案:/C:/j2sdk1.4.1_01/jre/classes
這時大家知道了為什麼我們不需要在系統屬性CLASSPATH中指定這些類庫了吧，因為JVM在啟動的時候就自動載入它們了。

extension classloader －擴充類載入器，它負責載入JRE的擴充目錄（JAVA_HOME/jre/lib/ext或者由java.ext.dirs系統屬性指定的）中JAR的類包。這為引入除Java核心類以外的新功能提供了一個標準機制。因為預設的擴充目錄對所有從同一個JRE中啟動的JVM都是通用的，所以放入這個目錄的 JAR類包對所有的JVM和system classloader都是可見的。在這個執行個體上調用方法getParent()總是返回空值null，因為引導載入器bootstrap classloader不是一個真正的ClassLoader執行個體。所以當大家執行以下代碼時：
   System.out.println(System.getProperty("java.ext.dirs"));
   ClassLoader extensionClassloader=ClassLoader.getSystemClassLoader().getParent();
   System.out.println("the parent of extension classloader : "+extensionClassloader.getParent());
結果為：
C:\j2sdk1.4.1_01\jre\lib\ext
the parent of extension classloader : null
extension classloader是system classloader的parent，而bootstrap classloader是extension classloader的parent，但它不是一個實際的classloader，所以為null。

system classloader －系統（也稱為應用）類載入器，它負責在JVM被啟動時，載入來自在命令java中的-classpath或者java.class.path系統屬性或者 CLASSPATH作業系統屬性所指定的JAR類包和類路徑。總能通過靜態方法ClassLoader.getSystemClassLoader()找到該類載入器。如果沒有特別指定，則使用者自訂的任何類載入器都將該類載入器作為它的父載入器。執行以下代碼即可獲得：
   System.out.println(System.getProperty("java.class.path"));
輸出結果則為使用者在系統屬性裡面設定的CLASSPATH。
classloader 載入類用的是全盤負責委託機制。所謂全盤負責，即是當一個classloader載入一個Class的時候，這個Class所依賴的和引用的所有 Class也由這個classloader負責載入，除非是顯式的使用另外一個classloader載入；委託機制則是先讓parent（父）類載入器 (而不是super，它與parent classloader類不是繼承關係)尋找，只有在parent找不到的時候才從自己的類路徑中去尋找。此外類載入還採用了cache機制，也就是如果 cache中儲存了這個Class就直接返回它，如果沒有才從檔案中讀取和轉換成Class，並存入cache，這就是為什麼我們修改了Class但是必須重新啟動JVM才會生效的原因。


每個ClassLoader載入Class的過程是：
1.檢測此Class是否載入過（即在cache中是否有此Class），如果有到8,如果沒有到2
2.如果parent classloader不存在（沒有parent，那parent一定是bootstrap classloader了），到4
3.請求parent classloader載入，如果成功到8，不成功到5
4.請求jvm從bootstrap classloader中載入，如果成功到8
5.尋找Class檔案（從與此classloader相關的類路徑中尋找）。如果找不到則到7.
6.從檔案中載入Class，到8.
7.拋出ClassNotFoundException.
8.返回Class.

其中5.6步我們可以通過覆蓋ClassLoader的findClass方法來實現自己的載入策略。甚至覆蓋loadClass方法來實現自己的載入過程。

類載入器的順序是：
先是bootstrap classloader，然後是extension classloader，最後才是system classloader。大家會發現載入的Class越是重要的越在靠前面。這樣做的原因是出於安全性的考慮，試想如果system classloader“親自”載入了一個具有破壞性的“java.lang.System”類的後果吧。這種委託機制保證了使用者即使具有一個這樣的類，也把它加入到了類路徑中，但是它永遠不會被載入，因為這個類總是由bootstrap classloader來載入的。大家可以執行一下以下的代碼：
   System.out.println(System.class.getClassLoader());
將會看到結果是null，這就表明java.lang.System是由bootstrap classloader載入的，因為bootstrap classloader不是一個真正的ClassLoader執行個體，而是由JVM實現的，正如前面已經說過的。

下面就讓我們來看看JVM是如何來為我們來建立類載入器的結構的：
sun.misc.Launcher，顧名思義，當你執行java命令的時候，JVM會先使用bootstrap classloader載入並初始化一個Launcher，執行下來代碼：
  System.out.println("the Launcher's classloader is "+sun.misc.Launcher.getLauncher().getClass().getClassLoader());
結果為：
  the Launcher's classloader is null (因為是用bootstrap classloader載入,所以class loader為null)
Launcher 會根據系統和命令設定初始化好class loader結構，JVM就用它來獲得extension classloader和system classloader,並載入所有的需要載入的Class，最後執行java命令指定的帶有靜態main方法的Class。extension classloader實際上是sun.misc.Launcher$ExtClassLoader類的一個執行個體，system classloader實際上是sun.misc.Launcher$AppClassLoader類的一個執行個體。並且都是 java.net.URLClassLoader的子類。

讓我們來看看Launcher初試化的過程的部分代碼。

Launcher的部分代碼：
public class Launcher  {
   public Launcher() {
       ExtClassLoader extclassloader;
       try {
           //初始化extension classloader
           extclassloader = ExtClassLoader.getExtClassLoader();
       } catch(IOException ioexception) {
           throw new InternalError("Could not create extension class loader");
       }
       try {
           //初始化system classloader，parent是extension classloader
           loader = AppClassLoader.getAppClassLoader(extclassloader);
       } catch(IOException ioexception1) {
           throw new InternalError("Could not create application class loader");
       }
       //將system classloader設定成當前線程的context classloader（將在後面加以介紹）
       Thread.currentThread().setContextClassLoader(loader);
       ......
   }
   public ClassLoader getClassLoader() {
       //返回system classloader
       return loader;
   }
}

extension classloader的部分代碼：
static class Launcher$ExtClassLoader extends URLClassLoader {

   public static Launcher$ExtClassLoader getExtClassLoader()
       throws IOException
   {
       File afile[] = getExtDirs();
       return (Launcher$ExtClassLoader)AccessController.doPrivileged(new Launcher$1(afile));
   }
  private static File[] getExtDirs() {
       //獲得系統屬性“java.ext.dirs”
       String s = System.getProperty("java.ext.dirs");
       File afile[];
       if(s != null) {
           StringTokenizer stringtokenizer = new StringTokenizer(s, File.pathSeparator);
           int i = stringtokenizer.countTokens();
           afile = new File;
           for(int j = 0; j < i; j++)
               afile[j] = new File(stringtokenizer.nextToken());

       } else {
           afile = new File[0];
       }
       return afile;
   }
}

system classloader的部分代碼：
static class Launcher$AppClassLoader extends URLClassLoader
{

   public static ClassLoader getAppClassLoader(ClassLoader classloader)
       throws IOException
   {
       //獲得系統屬性“java.class.path”
       String s = System.getProperty("java.class.path");
       File afile[] = s != null ? Launcher.access$200(s) : new File[0];
       return (Launcher$AppClassLoader)AccessController.doPrivileged(new Launcher$2(s, afile, classloader));
   }
}

看了原始碼大家就清楚了吧，extension classloader是使用系統屬性“java.ext.dirs”設定類搜尋路徑的，並且沒有parent。system classloader是使用系統屬性“java.class.path”設定類搜尋路徑的，並且有一個parent classloader。Launcher初始化extension classloader，system classloader，並將system classloader設定成為context classloader，但是僅僅返回system classloader給JVM。

　　這裡怎麼又出來一個context classloader呢。它有什麼用呢。我們在建立一個線程Thread的時候，可以為這個線程通過setContextClassLoader方法來指定一個合適的classloader作為這個線程的context classloader，當此線程啟動並執行時候，我們可以通過getContextClassLoader方法來獲得此context classloader，就可以用它來載入我們所需要的Class。預設的是system classloader。利用這個特性，我們可以“打破”classloader委託機制了，父classloader可以獲得當前線程的context classloader，而這個context classloader可以是它的子classloader或者其他的classloader，那麼父classloader就可以從其獲得所需的 Class，這就打破了只能向父classloader請求的限制了。這個機制可以滿足當我們的classpath是在運行時才確定,並由定製的 classloader載入的時候,由system classloader(即在jvm classpath中)載入的class可以通過context classloader獲得定製的classloader並載入入特定的class(通常是抽象類別和介面,定製的classloader中是其實現),例如web應用中的servlet就是用這種機制載入的.


好了，現在我們瞭解了classloader的結構和工作原理，那麼我們如何?在運行時的動態載入和更新呢。只要我們能夠動態改變類搜尋路徑和清除classloader的cache中已經載入的Class就行了，有兩個方案，一是我們繼承一個classloader，覆蓋loadclass方法，動態尋找Class檔案並使用defineClass方法來；另一個則非常簡單實用，只要重新使用一個新的類搜尋路徑來new一個classloader就行了，這樣即更新了類搜尋路徑以便來載入新的Class，也重建了一個空白的cache(當然,類搜尋路徑不一定必須更改)。噢，太好了，我們幾乎不用做什麼工作，java.netURLClassLoader正是一個符合我們要求的classloader。我們可以直接使用或者繼承它就可以了。

這是j2se1.4 API的doc中URLClassLoader的兩個構造器的描述：
URLClassLoader(URL[] urls)
         Constructs a new URLClassLoader for the specified URLs using the default delegation parent ClassLoader.
URLClassLoader(URL[] urls, ClassLoader parent)
         Constructs a new URLClassLoader for the given URLs.
其中URL[] urls就是我們要設定的類搜尋路徑，parent就是這個classloader的parent classloader，預設的是system classloader。


好，現在我們能夠動態載入Class了，這樣我們就可以利用newInstance方法來獲得一個Object。但我們如何將此Object造型呢。可以將此Object造型成它本身的Class嗎。

首先讓我們來分析一下java源檔案的編譯，運行吧。javac命令是調用“JAVA_HOME/lib/tools.jar”中的“com.sun.tools.javac.Main”的compile方法來編譯：

   public static int compile(String as[]);

   public static int compile(String as[], PrintWriter printwriter);

返回0表示編譯成功，字串數組as則是我們用javac命令編譯時間的參數，以空格劃分。例如：
javac -classpath c:\foo\bar.jar;. -d c:\ c:\Some.java
則字串數組as為{"-classpath","c:\\foo\\bar.jar;.","-d","c:\\","c:\\Some.java"}，如果帶有PrintWriter參數，則會把編譯資訊出到這個指定的printWriter中。預設的輸出是System.err。

其中 Main是由JVM使用Launcher初始化的system classloader載入的，根據全盤負責原則，編譯器在解析這個java源檔案時所發現的它所依賴和引用的所有Class也將由system classloader載入，如果system classloader不能載入某個Class時，編譯器將拋出一個“cannot resolve symbol”錯誤。

所以首先編譯就通不過，也就是編譯器無法編譯一個引用了不在CLASSPATH中的未知Class的java源檔案，而由於拼字錯誤或者沒有把所需類庫放到CLASSPATH中，大家一定經常看到這個“cannot resolve symbol”這個編譯錯誤吧。

其次，就是我們把這個Class放到編譯路徑中，成功的進行了編譯，然後在啟動並執行時候不把它放入到CLASSPATH中而利用我們自己的 classloader來動態載入這個Class，這時候也會出現“java.lang.NoClassDefFoundError”的違例，為什麼呢。

我們再來分析一下，首先調用這個造型語句的可執行檔Class一定是由JVM使用Launcher初始化的system classloader載入的，根據全盤負責原則，當我們進行造型的時候，JVM也會使用system classloader來嘗試載入這個Class來對執行個體進行造型，自然在system classloader尋找不到這個Class時就會拋出“java.lang.NoClassDefFoundError”的違例。

OK，現在讓我們來總結一下，java檔案的編譯和Class的載入執行，都是使用Launcher初始化的system classloader作為類載入器的，我們無法動態改變system classloader，更無法讓JVM使用我們自己的classloader來替換system classloader，根據全盤負責原則，就限制了編譯和運行時，我們無法直接顯式的使用一個system classloader尋找不到的Class，即我們只能使用Java核心類庫，擴充類庫和CLASSPATH中的類庫中的Class。

還不死心。再嘗試一下這種情況，我們把這個Class也放入到CLASSPATH中，讓system classloader能夠識別和載入。然後我們通過自己的classloader來從指定的class檔案中載入這個Class（不能夠委託 parent載入，因為這樣會被system classloader從CLASSPATH中將其載入），然後執行個體化一個Object，並造型成這個Class，這樣JVM也識別這個Class（因為 system classloader能夠定位和載入這個Class從CLASSPATH中），載入的也不是CLASSPATH中的這個Class，而是從 CLASSPATH外動態載入的，這樣總行了吧。十分不幸的是，這時會出現“java.lang.ClassCastException”違例。

為什麼呢。我們也來分析一下，不錯，我們雖然從CLASSPATH外使用我們自己的classloader動態載入了這個Class，但將它的執行個體造型的時候是JVM會使用system classloader來再次載入這個Class，並嘗試將使用我們的自己的classloader載入的Class的一個執行個體造型為system classloader載入的這個Class（另外的一個）。大家發現什麼問題了嗎。也就是我們嘗試將從一個classloader載入的Class的一個執行個體造型為另外一個classloader載入的Class，雖然這兩個Class的名字一樣，甚至是從同一個class檔案中載入。但不幸的是JVM 卻認為這個兩個Class是不同的，即JVM認為不同的classloader載入的相同的名字的Class（即使是從同一個class檔案中載入的）是不同的。這樣做的原因我想大概也是主要出於安全性考慮，這樣就保證所有的核心Java類都是system classloader載入的，我們無法用自己的classloader載入的相同名字的Class的執行個體來替換它們的執行個體。

看到這裡，聰明的讀者一定想到了該如何動態載入我們的Class，執行個體化，造型並調用了吧。

那就是利用物件導向的基本特性之一的多型。我們把我們動態載入的Class的執行個體造型成它的一個system classloader所能識別的父類就行了。這是為什麼呢。我們還是要再來分析一次。當我們用我們自己的classloader來動態載入這我們只要把這個Class的時候，發現它有一個父類Class，在載入它之前JVM先會載入這個父類Class，這個父類Class是system classloader所能識別的，根據委託機制，它將由system classloader載入，然後我們的classloader再載入這個Class，建立一個執行個體，造型為這個父類Class，注意了，造型成這個父類 Class的時候（也就是上溯）是物件導向的java語言所允許的並且JVM也支援的，JVM就使用system classloader再次載入這個父類Class，然後將此執行個體造型為這個父類Class。大家可以從這個過程發現這個父類Class都是由 system classloader載入的，也就是同一個class loader載入的同一個Class，所以造型的時候不會出現任何異常。而根據多型，調用這個父類的方法時，真正執行的是這個Class（非父類 Class）的覆蓋了父類方法的方法。這些方法中也可以引用system classloader不能識別的Class，因為根據全盤負責原則，只要載入這個Class的classloader即我們自己定義的 classloader能夠定位和載入這些Class就行了。

這樣我們就可以事先定義好一組介面或者基類並放入CLASSPATH中，然後在執行的時候動態載入實現或者繼承了這些介面或基類的子類。還不明白嗎。讓我們來想一想Servlet吧，web application server能夠載入任何繼承了Servlet的Class並正確的執行它們，不管它實際的Class是什麼，就是都把它們執行個體化成為一個Servlet Class，然後執行Servlet的init，doPost，doGet和destroy等方法的,而不管這個Servlet是從web- inf/lib和web-inf/classes下由system classloader的子classloader(即定製的classloader)動態載入。說了這麼多希望大家都明白了。在applet,ejb等容器中,都是採用了這種機制.

對於以上各種情況，希望大家實際編寫一些example來實驗一下。

最後我再說點別的， classloader雖然稱為類載入器，但並不意味著只能用來載入Class，我們還可以利用它也獲得圖片，音頻檔案等資源的URL，當然，這些資源必須在CLASSPATH中的jar類庫中或目錄下。我們來看API的doc中關於ClassLoader的兩個尋找資源和Class的方法描述吧：
　　　　　　　　public URL getResource(String name)
　　　　　　　　用指定的名字來尋找資源，一個資源是一些能夠被class代碼訪問的在某種程度上依賴於代碼位置的資料（圖片，音頻，文本等等）。
               一個資源的名字是以'/'號分隔確定資源的路徑名的。
               這個方法將先請求parent classloader搜尋資源，如果沒有parent，則會在內建在虛擬機器中的classloader（即bootstrap classloader）的路徑中搜尋。如果失敗，這個方法將調用findResource(String)來尋找資源。
　　　　　　　　public static URL getSystemResource(String name)
               從用來載入類的搜尋路徑中尋找一個指定名字的資源。這個方法使用system class loader來定位資源。即相當於ClassLoader.getSystemClassLoader().getResource(name)。

例如：
   System.out.println(ClassLoader.getSystemResource("java/lang/String.class"));
的結果為：
   jar:檔案:/C:/j2sdk1.4.1_01/jre/lib/rt.jar!/java/lang/String.class
表明String.class檔案在rt.jar的java/lang目錄中。
因此我們可以將圖片等資源隨同Class一同打包到jar類庫中（當然，也可單獨打包這些資源）並添加它們到class loader的搜尋路徑中，我們就可以無需關心這些資源的具體位置，讓class loader來幫我們尋找了。
ipse下java動態編譯時間com.sun.tools.javac.Main類載入問題的解決 2007-10-05 03:07 阿豪 我看了eclipse報錯時classpath載入的路徑有：G:\Program Files\Java\jdk1.5.0\jre\lib\ext\dnsns.jar
所以我把tools.jar加到了這個G:\Program Files\Java\jdk1.5.0\jre\lib\ext目錄也就解決了，不知有同其它的解決方案。
＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝
以下是報載入時的classpath：

classpath=C:\DOCUME~1\jujumao\LOCALS~1\Temp\Jetty__8081__openfans;G:\Program Files\Java\jdk1.5.0\jre\lib\ext\dnsns.jar;(後面的略掉)