使用JWhich工具管理CLASSPATH

2019-11-18 11:55:19

字體：大中小

來源：轉載

供稿：網友

　　從表面上看，java的classpath（類路徑）很簡單，但一直以來它都是一個產生問題和混亂的根源。本文介紹classpath的基本知識、可能產生的問題，并提供了一個簡單的classpath治理工具。
　　
　　和Java類路徑（classpath）打交道的過程中，開發者偶然會碰到麻煩。這是因為，類裝載器實際裝入的是哪一個類有時并不顯而易見，當應用程序的classpath包含大量的類和目錄時，情況尤其嚴重。本文將提供一個工具，它能夠顯示出被裝入類文件的絕對路徑名。
　　
　　一、Classpath基礎
　　Java虛擬機（JVM）借助類裝載器裝入應用程序使用的類，具體裝入哪些類根據當時的需要決定。CLASSPATH環境變量告訴類裝載器到哪里去尋找第三方提供的類和用戶定義的類。另外，你也可以使用JVM命令行參數-classpath分別為應用程序指定類路徑，在-classpath中指定的類路徑覆蓋CLASSPATH環境變量中指定的值。
　　
　　類路徑中的內容可以是：文件的目錄（包含不在包里面的類），包的根目錄（包含已打包的類），包含類的檔案文件（比如.zip文件或者.jar文件）。在Unix家族的系統上，類路徑的各個項目由冒號分隔，在MS Windows系統上，它們由分號分隔。
　　
　　類裝載器以委托層次的形式組織，每一個類裝載器有一個父類裝載器。當一個類裝載器被要求裝載某個類時，它在嘗試自己尋找類之前會把請求先委托給它的父類裝載器。系統類裝載器，即由安裝在系統上的JDK或JRE提供的默認類裝載器，通過CLASSPATH環境變量或者-classpath這個JVM命令行參數裝入第三方提供的類或者用戶定義的類。系統類裝載器委托擴展類裝載器裝入使用Java Extension機制的類。擴展類裝載器委托自舉類裝載器（bootstrap class loader）裝入核心JDK類。
　　
　　你可以自己開發非凡的類裝載器，定制JVM如何動態地裝入類。例如，大多數Servlet引擎使用定制的類裝載器，動態地裝入那些在classpath指定的目錄內發生變化的類。
　　
　　必須非凡注重的是（也是令人吃驚的是），類裝載器裝入類的次序就是類在classpath中出現的次序。類裝載器從classpath的第一項開始，依次檢查每一個設定的目錄和壓縮文件，嘗試找出待裝入的類文件。當類裝載器第一次找到具有指定名字的類時，它就把該類裝入，classpath中所有余下的項目都被忽略。
　　
　　看起來很簡單，對吧？
　　
　　二、可能出現的問題
　　不管他們是否愿意承認，初學者和富有經驗的Java開發者都一樣，他們都曾經在某些時候（通常是在那些最糟糕的情形下）被冗長、復雜的classpath欺騙。應用程序所依靠的第三方類和用戶定義類的數量逐漸增長，classpath也逐漸成了一個堆積所有可能的目錄和檔案文件名的地方。此時，類裝載器首先裝載的究竟是哪一個類也就不再顯而易見。假如classpath中包含重復的類入口，這個問題尤其突出。前面已經提到，類裝載器總是裝載第一個它在classpath中找到的具有合適名字的類，從實際效果看，它“隱藏”了其他具有合適名字但在classpath中優先級較低的類。
　　
　　假如不小心，你很輕易掉進這個classpath的陷阱。當你結束了一天漫長的工作，最后為了讓應用程序使用最好、最新的類，你把一個目錄加入到了classpath，但與此同時，你卻忘記了：在classpath的另一個具有更高優先級的目錄下，存放著該類的另一個版本！
　　
　　三、一個簡單的classpath工具
　　優先級問題是扁平路徑聲明方法與生俱來固有的問題，但它不是只有Java的classpath才有的問題。要解決這個問題，你只需站到富有傳奇色彩的軟件巨構的肩膀上：Unix操作系統有一個which命令，在命令參數中指定一個名字，which就會顯示出當這個名字作為命令執行時執行文件的路徑名。實際上，which命令是分析PATH變量，然后找出命令第一次出現的位置。對于Java的類路徑治理來說，這應該也是一個好工具。在它的啟發之下，我著手設計了一個Java工具JWhich。這個工具要求指定一個Java類的名字，然后根據classpath的指引，找出類裝載器即將裝載的類所在位置的絕對路徑。
　　
　　下面是一個JWhich的使用實例。它顯示出當Java類裝載器裝載com.clarkware.ejb.ShoppingCartBean類時，該類第一次出現位置的絕對路徑名，查找結果顯示該類在某個目錄下：
　　
　　> java JWhich com.clarkware.ejb.ShoppingCartBean
　　
　　Class 'com.clarkware.ejb.ShoppingCartBean' found in
　　'/home/mclark/classes/com/clarkware/ejb/ShoppingCartBean.class'
　　
　　下面是第二個JWhich的使用實例。它顯示出當Java類裝載器裝載javax.servlet.http.HttpServlet類時，該類第一次出現位置的絕對路徑名，查找結果顯示該類在某個檔案文件中：
　　
　　> java JWhich javax.servlet.http.HttpServlet
　　
　　Class 'javax.servlet.http.HttpServlet' found in
　　'file:/home/mclark/lib/servlet.jar!/javax/servlet/http/HttpServlet.class'
　　
　　四、JWhich的工作過程
　　要精確地測定classpath中哪一個類先被裝載，你必須深入到類裝載器的思考方法。事實上，具體實現的時候并沒有聽起來這么復雜——你只需直接詢問類裝載器就可以了！
　　
　　1: public class JWhich {
　　2:
　　3: /**
　　4: * 根據當前的classpath設置，
　　5: * 顯示出包含指定類的類文件所在
　　6: * 位置的絕對路徑
　　7: *
　　8: * @param className <類的名字>
　　9: */
　　10: public static void which(String className) {
　　11:
　　12: if (!className.startsWith("/")) {
　　13: className = "/" + className;
　　14: }
　　15: className = className.replace('.', '/');
　　16: className = className + ".class";
　　17:
　　18: java.net.URL classUrl =
　　19: new JWhich().getClass().getResource(className);
　　20:
　　21: if (classUrl != null) {
　　22: System.out.　　23: "' found in　'" + classUrl.getFile() + "'");
　　24: } else {
　　25: System.out.println(" Class '" + className +
　　26: "' not found in　'" +
　　27: System.getProperty("java.class.path") + "'");
　　28: }
　　29: }
　　30:
　　31: public static void main(String args[]) {
　　32: if (args.length > 0) {
　　33: JWhich.which(args[0]);
　　34: } else {
　　35: System.err.println("Usage: java JWhich ");
　　36: }
　　37: }
　　38: }
　　
　　首先，你必須稍微調整一下類的名字以便類裝載器能夠接受（12-16行）。在類的名字前面加上一個“/”表示要求類裝載器對classpath中的類名字進行逐字精確匹配，而不是嘗試隱含地加上調用類的包名字前綴。把所有“.”轉換為“/”的目的是，按照類裝載器的要求，把類名字格式化成一個合法的URL資源名。
　　
　　接下來，程序向類裝載器查詢資源，這個資源的名字必須和經過適當格式化的類名字匹配（18-19行）。每一個Class對象維護著一個對裝載它的ClassLoader對象的引用，所以這里是向裝載JWhich類的類裝載器查詢。Class.getResource()方法實際上委托裝入該類的類裝載器，返回一個用于讀取類文件資源的URL；或者，當指定的類名字不能在當前的classpath中找到時，Class.getResource()方法返回null。
　　
　　最后，假如當前的classpath中能夠找到指定的類，則程序顯示包含該類的類文件所在位置的絕對路徑名（21-24行）。作為一種調試輔助手段，假如當前classpath中不能找到指定的類，則程序獲取java.class.path系統屬性并顯示當前的classpath（24-28行）。
　　
　　很輕易想象，在使用Servlet引擎classpath的Java Servlet中，或者在使用EJB服務器classpath的EJB 組件中，上面這段簡單的代碼是如何運作。例如，假如JWhich類是由Servlet引擎的定制類裝載器裝入，那么程序將用Servlet引擎的類裝載器去尋找指定的類。假如Servlet引擎的類裝載器不能找到類文件，它將委托它的父類裝載器。一般地，當JWhich被某個類裝載器裝入時，它能夠找出當前類裝載器以及所有其父類裝載器所裝入的所有類。
　　
　　【結束語】假如需要是所有發明之母，那么幫助我們治理Java類路徑的工具可以說遲到了很長時間。Java新聞組和郵件列表中充塞著許多有關classpath的問題，現在JWhich為我們提供了一個簡單卻強大的工具，幫助我們在任何環境中徹底玩轉Java類路徑

上一篇：應用Mustang里新的啟動畫面功能

下一篇：JFC/Swing活學活用之定制JList顯示