java中使用URLClassLoader訪問外部jar包的java類

很多時候 我們寫的Java程序是分模塊的，有很好的擴展機制，即我們可以為我們自己的java類添加插件，來運行將來某天我們可能開發出來的類，以下稱這些類為插件類。

下邊是一種簡單的實現方法：

Class A 作為程序的主入口，其中包含了程序的執行入口（main）函數。然后在main函數中通過外部的配置文件，然后通過外部的配置文件，我們可以獲得插件類的信息（位於哪個jar包，jar包的具體路徑），然后獲得jar包中某一個類的實例，來完成相應的工作。這個jar包很可能是外部的jar包，是我們自己寫好的，那么我們放到哪里，他才能自己找到呢？我嘗試過很多次，除非將其具體目錄，放到class_path中才可以成功執行，否則報的異常只有一個ClassNotFoundException，就是找不到類。不過還有一種方法，就是將該jar包解壓到運行jar包所在的目錄，這樣就可以通過class_path中的.來獲得相應的類了。不過這樣會顯得很不專業，java寫出來的東西都是jar包啊，自己感覺的。放到claspath中，不能每次寫出新的jar包都配置一遍吧！

如此出現了如下的解決辦法：

想了解解決辦法的含義，首先要了解java的類加載機制。眾所周知，程序若想執行，必須加載到內存當中才能成功執行。java程序並不是可執行文件，由許多獨立的類文件來完成。所以java中加載程序是以類為單外來完成的。這也就需要我們來簡單了解一下java的class loader加載機制。

java程序開始執行，遇到的第一個classloader是bootstrap classloader，這個classloader是用c++語言編寫，通過他來完成加載java中的核心類。第二個classloader是extension classloader，加載的是jre/lib目錄中的ext目錄中的jar包。然后第三個是system classloader，也被稱為應用加載器，主要負責完成加載-classpath 或者系統中的全局變量ClassPath中的類。System.out.println(System.getProperty(“java.class.path”));可以獲得classpath的配置，也就是system classloader 加載的類，第四個class loader可能是用戶自定義的加載器，來自定義加載類。通常一個類的加載過程是這樣的通過當前的類加載器的父加載器嘗試查找，如果沒有再找其父加載器嘗試加載，直到最終的bootstrap classloader為止，如果還沒有找到，那么就開始從上往下加載類。這樣做的目的是防止自定義的類來覆蓋系統中的類，如果沒有這種機制很容易出現這種笑話，自己寫了一個String類，然后new string的時候是自己寫的String類，這樣就比較好玩了。

1.自己定義URLClassLoader對象加載外部jar包，針對jar包里面不再出現別的jar包的情況，即只解析.class文件：

private static void test1() {  
 String path = "D:\\test.jar";//外部jar包的路徑  
 Set<Class<?>> classes = new LinkedHashSet<Class<?>>();//所有的Class對象  
 Map<Class<?>, Annotation[]> classAnnotationMap = new HashMap<Class<?>, Annotation[]>();//每個Class對象上的注釋對象  
 Map<Class<?>, Map<Method, Annotation[]>> classMethodAnnoMap = new HashMap<Class<?>, Map<Method,Annotation[]>>();//每個Class對象中每個方法上的注釋對象  
 try {  
  JarFile jarFile = new JarFile(new File(path));  
  URL url = new URL("file:" + path);  
  ClassLoader loader = new URLClassLoader(new URL[]{url});//自己定義的classLoader類，把外部路徑也加到load路徑里，使系統去該路經load對象  
  Enumeration<JarEntry> es = jarFile.entries();  
  while (es.hasMoreElements()) {  
   JarEntry jarEntry = (JarEntry) es.nextElement();  
   String name = jarEntry.getName();  
   if(name != null && name.endsWith(".class")){//只解析了.class文件，沒有解析里面的jar包  
    //默認去系統已經定義的路徑查找對象，針對外部jar包不能用  
    //Class<?> c = Thread.currentThread().getContextClassLoader().loadClass(name.replace("/", ".").substring(0,name.length() - 6));  
    Class<?> c = loader.loadClass(name.replace("/", ".").substring(0,name.length() - 6));//自己定義的loader路徑可以找到  
    System.out.println(c);  
    classes.add(c);  
    Annotation[] classAnnos = c.getDeclaredAnnotations();  
    classAnnotationMap.put(c, classAnnos);  
    Method[] classMethods = c.getDeclaredMethods();  
    Map<Method, Annotation[]> methodAnnoMap = new HashMap<Method, Annotation[]>();  
    for(int i = 0;i<classMethods.length;i++){  
     Annotation[] a = classMethods[i].getDeclaredAnnotations();  
     methodAnnoMap.put(classMethods[i], a);  
    }  
    classMethodAnnoMap.put(c, methodAnnoMap);  
   }  
  }  
  System.out.println(classes.size());  
 } catch (IOException e) {  
  e.printStackTrace();  
 } catch (ClassNotFoundException e) {  
  e.printStackTrace();  
 }  
}  

 

以上的這種情況可以在別的project項目里寫test方法，是平時最常用的，如果當.class文件里有依賴別的jar包里的對象的時候，就要把該jar包拷貝到寫此測試方法的project並buildPath,不然的話運行的時候會報找不到Class對象的異常。

2.第二種情況是針對加載jar包里面的jar包的Class對象，還有讀取某一個properties文件的方法。

private static void test2() {  
  String path = "D:\\test.jar";//此jar包里還有別的jar包  
  try {  
   JarFile jarfile = new JarFile(new File(path));  
   Enumeration<JarEntry> es = jarfile.entries();  
   while (es.hasMoreElements()) {  
    JarEntry je = es.nextElement();  
    String name = je.getName();  
    if(name.endsWith(".jar")){//讀取jar包里的jar包  
     File f = new File(name);  
     JarFile j = new JarFile(f);  
     Enumeration<JarEntry> e = j.entries();  
     while (e.hasMoreElements()) {  
      JarEntry jarEntry = (JarEntry) e.nextElement();  
      System.out.println(jarEntry.getName());  
      //.........接下去和上面的方法類似  
     }  
    }  
//    System.out.println(je.getName());  
    if(je.getName().equals("entity_pk.properties")){  
     InputStream inputStream = jarfile.getInputStream(je);  
     Properties properties = new Properties();  
     properties.load(inputStream);  
     Iterator<Object> ite = properties.keySet().iterator();  
     while (ite.hasNext()) {  
      Object key = ite.next();  
      System.out.println(key + " : " +properties.get(key));  
     }  
    }  
   }  
  } catch (IOException e) {  
   e.printStackTrace();  
  }  
 }  

 

3.第三種情況是在該項目下獲取某個包的Class對象，當然了，測試方法是在該項目下寫的（這樣classLoader就直接可以知道對象了，不需要再自定義URLClassLoader了，用Thread.currentThread().getContextClassLoader().loadClass(.....)就可以直接獲得Class對象了，回去ClassPath下找，System.out.print(System.getProperty("java.class.path"))就可以找到classPath路徑）。

private static Set<Class<?>>  getclass() {  
  Set<Class<?>> classes = new LinkedHashSet<Class<?>>();  
  boolean flag = true;//是否循環迭代  
   
  String packName = "com.yk.framework.db";  
//  String packName = "org.jdom";  
  String packDir = packName.replace(".", "/");  
  Enumeration<URL> dir;  
  try {  
   dir = Thread.currentThread().getContextClassLoader().getResources(packDir);  
   while(dir.hasMoreElements()){  
    URL url = dir.nextElement();  
    System.out.println("url:***" + url);  
    String protocol = url.getProtocol();//獲得協議號  
    if("file".equals(protocol)){  
     System.err.println("file類型的掃描");  
     String filePath = URLDecoder.decode(url.getFile(), "UTF-8");  
     System.out.println("filePath :" + filePath);  
     findAndAddClassesInPackageByFile(packName, filePath,flag,classes);  
    }else if("jar".equals(protocol)){  
     System.err.println("jar類型掃描");  
     JarFile jar;  
     jar = ((JarURLConnection)url.openConnection()).getJarFile();  
     Enumeration<JarEntry> entries = jar.entries();  
     while(entries.hasMoreElements()){  
      JarEntry entry = entries.nextElement();  
      String name = entry.getName();  
      System.out.println(">>>>:" + name);  
      //......  
     }  
       
    }  
      
   }  
     
  } catch (IOException e) {  
   e.printStackTrace();  
  }  
  System.out.println(classes.size());  
  return classes;  
    
 }  

 

下面上第二段代碼

private static void findAndAddClassesInPackageByFile(String packName, String filePath, final boolean flag, Set<Class<?>> classes) {  
 File dir = new File(filePath);  
 if( !dir.exists() || !dir.isDirectory()){  
  System.out.println("此路徑下沒有文件");  
  return;  
 }  
 File[] dirfiles = dir.listFiles(new FileFilter(){  
  @Override  
  public boolean accept(File pathname) {  
   return flag && pathname.isDirectory() || pathname.getName().endsWith(".class");  
  }  
 });  
 for (File file : dirfiles) {  
  if(file.isDirectory()){//如果是目錄，繼續掃描  
   findAndAddClassesInPackageByFile(packName + "." + file.getName(),file.getAbsolutePath(),flag,classes);  
  }else{//如果是文件  
   String className = file.getName().substring(0,file.getName().length() - 6);  
   System.out.println("類名：" +className);  
   try {  
    classes.add(Thread.currentThread().getContextClassLoader().loadClass(packName + "." + className));  
   } catch (ClassNotFoundException e) {  
    e.printStackTrace();  
   }  
  }  
 }  
}  

 

好了，大致就是這樣，好好學習，天天向上！哈哈~~

補充：

4.讀取jar包中的entity_pk.properties鍵值對到項目本地entity_pk.properties文件中

/** 
 * 讀取jar包中的entity_pk.properties鍵值對到項目本地entity_pk.properties文件中 
 */  
private static void test2() {  
    String path = "D:\\test.jar";  
    try {  
        JarFile jarFile = new JarFile(new File(path));  
        Enumeration<JarEntry> es = jarFile.entries();  
        while (es.hasMoreElements()) {  
            JarEntry jarEntry = (JarEntry) es.nextElement();  
            String name = jarEntry.getName();  
            if(name.equals("entity_pk.properties")){  
                InputStream inputStream = new FileInputStream(name);  
                Properties prop = new Properties();  
                prop.load(inputStream);//先load本地的entity_pk.propertoes文件  
                InputStream inputStream2 = jarFile.getInputStream(jarEntry);//獲得jar包entity_pk.propertoes文件流  
                Properties prop2 = new Properties();  
                prop2.load(inputStream2);  
                Enumeration<Object> ks = prop2.keys();  
                OutputStream out = new FileOutputStream(name);  
                while (ks.hasMoreElements()) {  
                    String key =  (String)ks.nextElement();  
                    System.out.println(key + " : " +prop2.getProperty(key));  
                    prop.setProperty(key, prop2.getProperty(key));//把jar包entity_pk.properties鍵值對放入本地  
                }  
                prop.store(out,"");  
            }  
        }  
          
    } catch (IOException e) {  
        e.printStackTrace();  
    }  
      
}  

 

 5.讀寫db_config.xml文件

/** 
 * 讀寫db_config.xml文件 
 */  
private static void test3() {  
    String path = "D:\\test.jar";  
    try {  
        JarFile jarFile = new JarFile(new File(path));  
        Enumeration<JarEntry> es = jarFile.entries();  
        while (es.hasMoreElements()) {  
            JarEntry jarEntry = (JarEntry) es.nextElement();  
            String name = jarEntry.getName();  
            if(name.equals("db_config.xml")){  
                InputStream inputStream = jarFile.getInputStream(jarEntry);  
                SAXBuilder builder = new SAXBuilder();  
                Document doc = null;  
                try {  
                    doc = builder.build(inputStream);  
                    if(doc != null){  
                        Element e = doc.getRootElement();  
                        Element proxool = e.getChild("proxool");  
                        List<Element> children = proxool.getChildren();  
                        for (Element element : children) {  
                            System.out.println(element.getText());  
                        }  
                        Element s = new Element("test");  
                        s.addContent("test");  
                        proxool.addContent(s);  
                        XMLOutputter outputter = new XMLOutputter();  
                        outputter.output(doc, new FileOutputStream("config/db_config.xml"));  
                    }  
                } catch (JDOMException e) {  
                    e.printStackTrace();  
                }finally{  
                    if(inputStream != null){  
                        inputStream.close();  
                    }  
                }  
                  
            }  
              
        }  
          
    } catch (IOException e) {  
        e.printStackTrace();  
    }  
}