1. 簡(jiǎn)述

 在日常Java開(kāi)發(fā)中，我們經(jīng)常碰到j(luò)ava.lang.NoClassDefFoundError這樣的錯(cuò)誤，需要花費(fèi)很多時(shí)間去找錯(cuò)誤的原因，具體是哪個(gè)類不見(jiàn)了？類明明還在，為什么找不到？而且我們很容易把java.lang.NoClassDefFoundError和java.lang.ClassNotfoundException這兩個(gè)錯(cuò)誤搞混，事實(shí)上這兩個(gè)錯(cuò)誤是完全不同的。我們往往花費(fèi)時(shí)間去不斷嘗試一些其他的方法去解決這個(gè)問(wèn)題，而沒(méi)有真正去理解這個(gè)錯(cuò)誤的原因。這篇文章就是通過(guò)解決NoClassDefFoundError錯(cuò)誤處理的經(jīng)驗(yàn)分享來(lái)揭開(kāi)NoClassDefFoundError的一些秘密。NoClassDefFoundError的錯(cuò)誤并非不能解決或者說(shuō)很難解決，只是這種錯(cuò)誤的表現(xiàn)形式很容易迷惑其他的Java開(kāi)發(fā)者。下面我們來(lái)分析下為什么會(huì)發(fā)生NoClassDefFoundError這樣的錯(cuò)誤，以及怎樣去解決這個(gè)錯(cuò)誤。

2. NoClassDefFoundError錯(cuò)誤發(fā)生的原因

NoClassDefFoundError錯(cuò)誤的發(fā)生，是因?yàn)镴ava虛擬機(jī)在編譯時(shí)能找到合適的類，而在運(yùn)行時(shí)不能找到合適的類導(dǎo)致的錯(cuò)誤。例如在運(yùn)行時(shí)我們想調(diào)用某個(gè)類的方法或者訪問(wèn)這個(gè)類的靜態(tài)成員的時(shí)候，發(fā)現(xiàn)這個(gè)類不可用，此時(shí)Java虛擬機(jī)就會(huì)拋出NoClassDefFoundError錯(cuò)誤。與ClassNotFoundException的不同在于，這個(gè)錯(cuò)誤發(fā)生只在運(yùn)行時(shí)需要加載對(duì)應(yīng)的類不成功，而不是編譯時(shí)發(fā)生。很多Java開(kāi)發(fā)者很容易在這里把這兩個(gè)錯(cuò)誤搞混。

簡(jiǎn)單總結(jié)就是，NoClassDefFoundError發(fā)生在編譯時(shí)對(duì)應(yīng)的類可用，而運(yùn)行時(shí)在Java的classpath路徑中，對(duì)應(yīng)的類不可用導(dǎo)致的錯(cuò)誤。發(fā)生NoClassDefFoundError錯(cuò)誤時(shí)，你能看到如下的錯(cuò)誤日志：

Exception in thread "main" java.lang.NoClassDefFoundError

錯(cuò)誤的信息很明顯地指明main線程無(wú)法找到指定的類，而這個(gè)main線程可能時(shí)主線程或者其他子線程。如果是主線程發(fā)生錯(cuò)誤，程序?qū)⒈罎⒒蛲Ｖ梗绻亲泳€程，則子線程停止，其他線程繼續(xù)運(yùn)行。

3. NoClassDefFoundError和ClassNotFoundException區(qū)別

我們經(jīng)常被java.lang.ClassNotFoundException和java.lang.NoClassDefFoundError這兩個(gè)錯(cuò)誤迷惑不清，盡管他們都與Java classpath有關(guān)，但是他們完全不同。NoClassDefFoundError發(fā)生在JVM在動(dòng)態(tài)運(yùn)行時(shí)，根據(jù)你提供的類名，在classpath中找到對(duì)應(yīng)的類進(jìn)行加載，但當(dāng)它找不到這個(gè)類時(shí)，就發(fā)生了java.lang.NoClassDefFoundError的錯(cuò)誤，而ClassNotFoundException是在編譯的時(shí)候在classpath中找不到對(duì)應(yīng)的類而發(fā)生的錯(cuò)誤。ClassNotFoundException比NoClassDefFoundError容易解決，是因?yàn)樵诰幾g時(shí)我們就知道錯(cuò)誤發(fā)生，并且完全是由于環(huán)境的問(wèn)題導(dǎo)致。而如果你在J2EE的環(huán)境下工作，并且得到NoClassDefFoundError的異常，而且對(duì)應(yīng)的錯(cuò)誤的類是確實(shí)存在的，這說(shuō)明這個(gè)類對(duì)于類加載器來(lái)說(shuō)，可能是不可見(jiàn)的。

4. 怎么解決NoClassDefFoundError錯(cuò)誤

根據(jù)前文，很明顯NoClassDefFoundError的錯(cuò)誤是因?yàn)樵谶\(yùn)行時(shí)類加載器在classpath下找不到需要加載的類，所以我們需要把對(duì)應(yīng)的類加載到classpath中，或者檢查為什么類在classpath中是不可用的，這個(gè)發(fā)生可能的原因如下：

• 對(duì)應(yīng)的Class在java的classpath中不可用
• 你可能用jar命令運(yùn)行你的程序，但類并沒(méi)有在jar文件的manifest文件中的classpath屬性中定義
• 可能程序的啟動(dòng)腳本覆蓋了原來(lái)的classpath環(huán)境變量
• 因?yàn)镹oClassDefFoundError是java.lang.LinkageError的一個(gè)子類，所以可能由于程序依賴的原生的類庫(kù)不可用而導(dǎo)致
• 檢查日志文件中是否有java.lang.ExceptionInInitializerError這樣的錯(cuò)誤，NoClassDefFoundError有可能是由于靜態(tài)初始化失敗導(dǎo)致的
• 如果你工作在J2EE的環(huán)境，有多個(gè)不同的類加載器，也可能導(dǎo)致NoClassDefFoundError

下面我們看一些當(dāng)發(fā)生NoClassDefFoundError時(shí)，我們?cè)撊绾谓鉀Q的樣例。

5. NoClassDefFoundError解決示例

• 當(dāng)發(fā)生由于缺少jar文件，或者jar文件沒(méi)有添加到classpath，或者jar的文件名發(fā)生變更會(huì)導(dǎo)致java.lang.NoClassDefFoundError的錯(cuò)誤。
• 當(dāng)類不在classpath中時(shí)，這種情況很難確切的知道，但如果在程序中打印出System.getproperty(“java.classpath”)，可以得到程序?qū)嶋H運(yùn)行的classpath
• 運(yùn)行時(shí)明確指定你認(rèn)為程序能正常運(yùn)行的 -classpath 參數(shù)，如果增加之后程序能正常運(yùn)行，說(shuō)明原來(lái)程序的classpath被其他人覆蓋了。
• NoClassDefFoundError也可能由于類的靜態(tài)初始化模塊錯(cuò)誤導(dǎo)致，當(dāng)你的類執(zhí)行一些靜態(tài)初始化模塊操作，如果初始化模塊拋出異常，哪些依賴這個(gè)類的其他類會(huì)拋出NoClassDefFoundError的錯(cuò)誤。如果你查看程序日志，會(huì)發(fā)現(xiàn)一些java.lang.ExceptionInInitializerError的錯(cuò)誤日志，ExceptionInInitializerError的錯(cuò)誤會(huì)導(dǎo)致java.lang.NoClassDefFoundError: Could not initialize class，如下面的代碼示例：

/**
 * Java program to demonstrate how failure of static initialization subsequently cause
 * java.lang.NoClassDefFoundError in Java.
 * @author Javin Paul
 */
public class NoClassDefFoundErrorDueToStaticInitFailure {
    public static void main(String args[]){
        List<User> users = new ArrayList<User>(2);
        for(int i=0; i<2; i++){
            try{
            users.add(new User(String.valueOf(i))); //will throw NoClassDefFoundError
            }catch(Throwable t){
                t.printStackTrace();
            }
        }         
    }
}
class User{
    private static String USER_ID = getUserId();
    public User(String id){
        this.USER_ID = id;
    }
    private static String getUserId() {
        throw new RuntimeException("UserId Not found");
    }     
}
Output
java.lang.ExceptionInInitializerError
    at testing.NoClassDefFoundErrorDueToStaticInitFailure.main(NoClassDefFoundErrorDueToStaticInitFailure.java:23)
Caused by: java.lang.RuntimeException: UserId Not found
    at testing.User.getUserId(NoClassDefFoundErrorDueToStaticInitFailure.java:41)
    at testing.User.<clinit>(NoClassDefFoundErrorDueToStaticInitFailure.java:35)
    ... 1 more
java.lang.NoClassDefFoundError: Could not initialize class testing.User
    at testing.NoClassDefFoundErrorDueToStaticInitFailure.main(NoClassDefFoundErrorDueToStaticInitFailure.java:23)

• 由于NoClassDefFoundError是LinkageError的子類，而LinkageError的錯(cuò)誤在依賴其他的類時(shí)會(huì)發(fā)生，所以如果你的程序依賴原生的類庫(kù)和需要的dll不存在時(shí)，有可能出現(xiàn)java.lang.NoClassDefFoundError。這種錯(cuò)誤也可能拋出java.lang.UnsatisfiedLinkError: no dll in java.library.path Exception Java這樣的異常。解決的辦法是把依賴的類庫(kù)和dll跟你的jar包放在一起。
• 如果你使用Ant構(gòu)建腳本來(lái)生成jar文件和manifest文件，要確保Ant腳本獲取的是正確的classpath值寫(xiě)入到manifest.mf文件
• Jar文件的權(quán)限問(wèn)題也可能導(dǎo)致NoClassDefFoundError，如果你的程序運(yùn)行在像linux這樣多用戶的操作系統(tǒng)種，你需要把你應(yīng)用相關(guān)的資源文件，如Jar文件，類庫(kù)文件，配置文件的權(quán)限單獨(dú)分配給程序所屬用戶組，如果你使用了多個(gè)用戶不同程序共享的jar包時(shí)，很容易出現(xiàn)權(quán)限問(wèn)題。比如其他用戶應(yīng)用所屬權(quán)限的jar包你的程序沒(méi)有權(quán)限訪問(wèn)，會(huì)導(dǎo)致java.lang.NoClassDefFoundError的錯(cuò)誤。
• 基于XML配置的程序也可能導(dǎo)致NoClassDefFoundError的錯(cuò)誤。比如大多數(shù)Java的框架像Spring，Struts使用xml配置獲取對(duì)應(yīng)的bean信息，如果你輸入了錯(cuò)誤的名稱，程序可能會(huì)加載其他錯(cuò)誤的類而導(dǎo)致NoClassDefFoundError異常。我們?cè)谑褂肧pring MVC框架或者Apache Struts框架，在部署War文件或者EAR文件時(shí)就經(jīng)常會(huì)出現(xiàn)Exception in thread “main” java.lang.NoClassDefFoundError。

• 在有多個(gè)ClassLoader的J2EE的環(huán)境中，很容易出現(xiàn)NoClassDefFoundError的錯(cuò)誤。由于J2EE沒(méi)有指明標(biāo)準(zhǔn)的類加載器，使用的類加載器依賴與不同的容器像Tomcat、WebLogic，WebSphere加載J2EE的不同組件如War包或者EJB-JAR包。關(guān)于類加載器的相關(guān)知識(shí)可以參考這篇文章類加載器的工作原理。

  總結(jié)來(lái)說(shuō)，類加載器基于三個(gè)機(jī)制：委托、可見(jiàn)性和單一性，委托機(jī)制是指將加載一個(gè)類的請(qǐng)求交給父類加載器，如果這個(gè)父類加載器不能夠找到或者加載這個(gè)類，那么再加載它?？梢?jiàn)性的原理是子類的加載器可以看見(jiàn)所有的父類加載器加載的類，而父類加載器看不到子類加載器加載的類。單一性原理是指僅加載一個(gè)類一次，這是由委托機(jī)制確保子類加載器不會(huì)再次加載父類加載器加載過(guò)的類?，F(xiàn)在假設(shè)一個(gè)User類在WAR文件和EJB-JAR文件都存在，并且被WAR ClassLoader加載，而WAR ClassLoader是加載EJB-JAR ClassLoader的子ClassLoader。當(dāng)EJB-JAR中代碼引用這個(gè)User類時(shí)，加載EJB-JAR所有class的Classloader找不到這個(gè)類，因?yàn)檫@個(gè)類已經(jīng)被EJB-JAR classloader的子加載器WAR classloader加載。

  這會(huì)導(dǎo)致的結(jié)果就是對(duì)User類出現(xiàn)NoClassDefFoundError異常，而如果在兩個(gè)JAR包中這個(gè)User類都存在，如果你使用equals方法比較兩個(gè)類的對(duì)象時(shí)，會(huì)出現(xiàn)ClassCastException的異常，因?yàn)閮蓚€(gè)不同類加載器加載的類無(wú)法進(jìn)行比較。

• 有時(shí)候會(huì)出現(xiàn)Exception in thread “main” java.lang.NoClassDefFoundError: com/sun/tools/javac/Main 這樣的錯(cuò)誤，這個(gè)錯(cuò)誤說(shuō)明你的Classpath, PATH 或者 JAVA_HOME沒(méi)有安裝配置正確或者JDK的安裝不正確。這個(gè)問(wèn)題的解決辦法時(shí)重新安裝你的JDK。

• Java在執(zhí)行l(wèi)inking操作的時(shí)候，也可能導(dǎo)致NoClassDefFoundError。例如在前面的腳本中，如果在編譯完成之后，我們刪除User的編譯文件，再運(yùn)行程序，這個(gè)時(shí)候你就會(huì)直接得到NoClassDefFoundError，而錯(cuò)誤的消息只打印出User類的名稱。

java.lang.NoClassDefFoundError: testing/User
    at testing.NoClassDefFoundErrorDueToStaticInitFailure.main(NoClassDefFoundErrorDueToStaticInitFailure.java:23)

現(xiàn)在我們知道要怎樣去面對(duì)NoClassDefFoundError異常并解決它了。

總結(jié)

到此這篇關(guān)于java.lang.NoClassDefFoundError錯(cuò)誤的原因及解決的文章就介紹到這了,更多相關(guān)java.lang.NoClassDefFoundError錯(cuò)誤內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！