Java获取package下所有的class对象（普通文件包和Jar文件包）

秒速五厘米 2022-07-21 05:51 337阅读 0赞

# 读取一个package路径下面所有的class #

/** * 获得包下面的所有的class * * @param pack * package完整名称 * @return List包含所有class的实例 */
    public static List<Class> getClasssFromPackage(String pack) { 
      List<Class> clazzs = new ArrayList<Class>();
    
      // 是否循环搜索子包
      boolean recursive = true;
    
      // 包名字
      String packageName = pack;
      // 包名对应的路径名称
      String packageDirName = packageName.replace('.', '/');
    
      Enumeration<URL> dirs;
    
      try { 
        dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
        while (dirs.hasMoreElements()) { 
          URL url = dirs.nextElement();
    
          String protocol = url.getProtocol();
    
          if ("file".equals(protocol)) { 
            System.out.println("file类型的扫描");
            String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
            findClassInPackageByFile(packageName, filePath, recursive, clazzs);
          } else if ("jar".equals(protocol)) { 
            System.out.println("jar类型的扫描");
          }
        }
    
      } catch (Exception e) { 
        e.printStackTrace();
      }
    
      return clazzs;
    }
    
    /** * 在package对应的路径下找到所有的class * * @param packageName * package名称 * @param filePath * package对应的路径 * @param recursive * 是否查找子package * @param clazzs * 找到class以后存放的集合 */
    public static void findClassInPackageByFile(String packageName, String filePath, final boolean recursive, List<Class> clazzs) { 
      File dir = new File(filePath);
      if (!dir.exists() || !dir.isDirectory()) { 
        return;
      }
      // 在给定的目录下找到所有的文件，并且进行条件过滤
      File[] dirFiles = dir.listFiles(new FileFilter() { 
    
        @Override
        public boolean accept(File file) { 
          boolean acceptDir = recursive && file.isDirectory();// 接受dir目录
          boolean acceptClass = file.getName().endsWith("class");// 接受class文件
          return acceptDir || acceptClass;
        }
      });
    
      for (File file : dirFiles) { 
        if (file.isDirectory()) { 
          findClassInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive, clazzs);
        } else { 
          String className = file.getName().substring(0, file.getName().length() - 6);
          try { 
            clazzs.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + "." + className));
          } catch (Exception e) { 
            e.printStackTrace();
          }
        }
      }
    }

上诉代码的原理为通过当前线程的类加载器去加载到目录下的URL，然后URL去加载类。  
但是如果我们需要加载的类是在一个Jar中，则无法采用这种方式，因为此时整个jar被看做了一个文件，无法再通过URL去加载jar中的某个文件。要加载jar中的类则采用如下方式。

# 获取jar文件包中的package下面的所有class #

/** * 从jar文件中读取指定目录下面的所有的class文件 * * @param jarPaht * jar文件存放的位置 * @param filePaht * 指定的文件目录 * @return 所有的的class的对象 */
    public List<Class> getClasssFromJarFile(String jarPaht, String filePaht) { 
      List<Class> clazzs = new ArrayList<Class>();
    
      JarFile jarFile = null;
      try { 
        jarFile = new JarFile(jarPaht);
      } catch (IOException e1) { 
        e1.printStackTrace();
      }
    
      List<JarEntry> jarEntryList = new ArrayList<JarEntry>();
    
      Enumeration<JarEntry> ee = jarFile.entries();
      while (ee.hasMoreElements()) { 
        JarEntry entry = (JarEntry) ee.nextElement();
        // 过滤我们出满足我们需求的东西
        if (entry.getName().startsWith(filePaht) && entry.getName().endsWith(".class")) { 
          jarEntryList.add(entry);
        }
      }
      for (JarEntry entry : jarEntryList) { 
        String className = entry.getName().replace('/', '.');
        className = className.substring(0, className.length() - 6);
        // 也可以采用如下方式把类加载成一个输入流
    	// InputStream in = jarFile.getInputStream(entry);
        try { 
          clazzs.add(Thread.currentThread().getContextClassLoader()
          .loadClass(className));
        } catch (ClassNotFoundException e) { 
           e.printStackTrace();
        }
      }
    
      return clazzs;
    }

上诉代码的原理为通过`JarEntry`加载了Jar中的所有文件，此时通过循环这些文件的文件名，来判断是否属于某个目录下，进而得到目录下的所有文件。

**如果加载的是文件而非类**

此时可以通过如下方式加载出来输入流对象会比较简洁，但是这种方法文件路径一定要是从跟路径下开始写起，比如对于如下目录结构  
![在这里插入图片描述][20210324200725833.png]  
要加载`approveDev.xml`，必须要这样写

InputStream in = Thread.currentThread().getContextClassLoader()
    .getResourceAsStream("/config/apollo_xml/adaptorFlow/approveDev.xml");

不可以写成这样

InputStream in = Thread.currentThread().getContextClassLoader()
    .getResourceAsStream("/apollo_xml/adaptorFlow/approveDev.xml");	// 错误的写法

**不要视图通过加载jar中的文件得到一个File**  
你是否想过通过加载jar中的文件得到一个File，比如下面这样

File file = new File("jar包中的文件路径")

但其实是没法这样做的，因为整个jar被看做了一个整体，如果你非要得到一个File对象，可以考虑用上面的输入流写出到一个文件中，然后通过加载这个文件来得到一个File对象。实际上非特殊情况也不一定要得到File对象，因为假设你是加载xml，dom4j也提供了通过输入流的方式来加载xml.

[20210324200725833.png]: /images/20220720/f15c574ebba5463c825591475aa1dbce.png