java - 从类路径中的所有 jar 文件中提取扩展 "Randomizer"的类

Question

主题确实说明了我的目标，但我对实现感到困惑。我有一个程序接收扩展我的 Randomizer 的不同对象类(class)。我想这样做，以便可以放置一个 JAR类路径中的文件，程序将在运行时搜索它，并将其添加到主程序中。到目前为止，这是我尝试过的，但是当我意识到 java.util.jar.JarFile不能给你Class es 或 Method

既然依赖它，我不妨提一下我的类ArrayPP<T>就像ArrayList ，但有更多的方法。它的addAll此处显示的方法的功能与其 add 类似方法，但具有多个参数或泛型对象数组 T .

  private static Randomizer[] loadExternalRandomizers() throws IOException
  {
    java.io.File classPath = new java.io.File(System.getProperty("user.dir"));
    ArrayPP<Randomizer> r = new ArrayPP<>();
    if (classPath.isDirectory())
    {
      r.addAll(getRandomizersIn(classPath));
    }
    return r.toArray();
  }

  private static Randomizer[] getRandomizersIn(File dir) throws IOException
  {
    ArrayPP<Randomizer> r = new ArrayPP<>();
    java.io.File fs[] = dir.listFiles(new java.io.FileFilter() {

      @Override
      public boolean accept(File pathname)
      {
        return pathname.isDirectory() || pathname.toString().endsWith(".jar");
      }
    });
    java.util.jar.JarFile jr;
    java.util.Enumeration<java.util.jar.JarEntry> entries;
    java.util.jar.JarEntry thisEntry;
    for (java.io.File f : fs)
    {
      if (f.isDirectory())
      {
        r.addAll(getRandomizersIn(f));
        continue;
      }
      jr = new java.util.jar.JarFile(f);
      entries = jr.entries();
      while (entries.hasMoreElements())
      {
        thisEntry = entries.nextElement();
        //if (the jar file contains a class that extends Randomizer
        //  add that class to r
      }
    }
    return r.toArray();
  }

如果有帮助，我将在 Java 7 上构建它。我也希望在不使用任何库的情况下执行此操作。

实现解决方案

---

我已尝试实现 Ryan Stewart 描述的解决方案，如下所示。我正在使用它进行测试 JAR称为 BHR2 - Ranger.jar ，其中包含一个扩展 Randomizer 的类, 称为 Ranger , 在包中 bhr2.plugins . JAR在其 META-INF\services 中包含文件夹，一个名为 bhr2.plugins.Ranger 的文件其中一行写着bhr2.Randomizer # Abstract Randomizer .

  private static ArrayPP<Randomizer> loadExternalRandomizers() throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException
  {
    java.io.File classPath = new java.io.File(System.getProperty("user.dir"));
    ArrayPP<Randomizer> r = new ArrayPP<>();
    if (classPath.isDirectory())
    {
      r.addAll(getRandomizersIn(classPath));
    }
    return r;
  }

  private static int depth = 0;
  private static ArrayPP<Randomizer> getRandomizersIn(File dir) throws IOException, ClassNotFoundException, InstantiationException, IllegalAccessException
  {
    ArrayPP<Randomizer> r = new ArrayPP<>();
    java.io.File fs[] = dir.listFiles(new java.io.FileFilter() {

      @Override
      public boolean accept(File pathname)
      {
        return pathname.isDirectory() || pathname.toString().endsWith(".jar");
      }
    });
    for (java.io.File f : fs)
    {
      for (int i=0; i < depth; i++)
        System.out.print("  ");
      System.out.println(f);
      if (f.isDirectory())
      {
        if (depth < 4)
        {
          depth++;
          r.addAll(getRandomizersIn(f));
          depth--;
        }
        else
          System.out.println("Skipping directory due to depth");
        continue;
      }
        java.util.ServiceLoader<Randomizer> sl = ServiceLoader.loadInstalled(Randomizer.class);

        for (Randomizer rand : sl)
        {
          r.add(rand);
          System.out.println("adding " + rand);
        }
    }
    return r == null || r.isEmpty() ? new ArrayPP<Randomizer>() : r;
  }

但是当我运行它时，这是我在它开始做其他事情之前得到的所有输出:

I:\Java\NetBeansProjects\BHRandomizer2\nbproject
  I:\Java\NetBeansProjects\BHRandomizer2\nbproject\private
I:\Java\NetBeansProjects\BHRandomizer2\src
  I:\Java\NetBeansProjects\BHRandomizer2\src\bhr2
    I:\Java\NetBeansProjects\BHRandomizer2\src\bhr2\resources
    I:\Java\NetBeansProjects\BHRandomizer2\src\bhr2\randomizers
  I:\Java\NetBeansProjects\BHRandomizer2\src\bht
    I:\Java\NetBeansProjects\BHRandomizer2\src\bht\test
    I:\Java\NetBeansProjects\BHRandomizer2\src\bht\tools
      I:\Java\NetBeansProjects\BHRandomizer2\src\bht\tools\comps
        I:\Java\NetBeansProjects\BHRandomizer2\src\bht\tools\comps\gameboard
Skipping directory due to depth
      I:\Java\NetBeansProjects\BHRandomizer2\src\bht\tools\effects
      I:\Java\NetBeansProjects\BHRandomizer2\src\bht\tools\misc
      I:\Java\NetBeansProjects\BHRandomizer2\src\bht\tools\utilities
    I:\Java\NetBeansProjects\BHRandomizer2\src\bht\resources
I:\Java\NetBeansProjects\BHRandomizer2\lib
  I:\Java\NetBeansProjects\BHRandomizer2\lib\CopyLibs
    I:\Java\NetBeansProjects\BHRandomizer2\lib\CopyLibs\org-netbeans-modules-java-j2seproject-copylibstask.jar
  I:\Java\NetBeansProjects\BHRandomizer2\lib\swing-layout
    I:\Java\NetBeansProjects\BHRandomizer2\lib\swing-layout\swing-layout-1.0.4.jar
I:\Java\NetBeansProjects\BHRandomizer2\BHR2 - Ranger
  I:\Java\NetBeansProjects\BHRandomizer2\BHR2 - Ranger\META-INF
  I:\Java\NetBeansProjects\BHRandomizer2\BHR2 - Ranger\bhr2
    I:\Java\NetBeansProjects\BHRandomizer2\BHR2 - Ranger\bhr2\plugins
I:\Java\NetBeansProjects\BHRandomizer2\build
  I:\Java\NetBeansProjects\BHRandomizer2\build\classes
    I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bhr2
      I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bhr2\randomizers
      I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bhr2\resources
    I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht
      I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\tools
        I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\tools\comps
Skipping directory due to depth
        I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\tools\utilities
Skipping directory due to depth
        I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\tools\effects
Skipping directory due to depth
        I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\tools\misc
Skipping directory due to depth
      I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\resources
      I:\Java\NetBeansProjects\BHRandomizer2\build\classes\bht\test
    I:\Java\NetBeansProjects\BHRandomizer2\build\classes\META-INF
  I:\Java\NetBeansProjects\BHRandomizer2\build\empty
  I:\Java\NetBeansProjects\BHRandomizer2\build\generated-sources
    I:\Java\NetBeansProjects\BHRandomizer2\build\generated-sources\ap-source-output
I:\Java\NetBeansProjects\BHRandomizer2\dist
  I:\Java\NetBeansProjects\BHRandomizer2\dist\BHRandomizer2.jar
I:\Java\NetBeansProjects\BHRandomizer2\BHR2 - Ranger.jar

Answer 1

此问题的典型解决方案是构建 jar 文件，该文件在 META-INF 中有一个文件，告诉您的程序要从该 jar 加载什么类。 Spring custom namespace handlers和 JDBC drivers ，例如，以这种方式加载。

与其弄清楚如何实际扫描一个 jar 中的所有类，没有人这样做，所以我认为这是不可能/不可行的，而是让您的代码在类路径上的每个 jar 中查找特定文件，其中列出了 Randomizer它包含的实现。例如，期望一个名为 META-INF/randomizers.list 的文件包含一个类名列表，每行一个，它们是该 jar 中实现您的随机发生器的类。读取文件，对于每一行，使用 Class.forName()按名称加载类，然后 newInstance()实例化它。

编辑:从类路径中的任何位置加载“列表”文件:

Enumeration<URL> resources = getClassLoader().getResources(
    "/META-INF/randomizers.list");
while (resources.hasMoreElements()) {
    URL url = resources.nextElement();
    // Load the Randomizer(s) specified in this file
}

编辑: 事实证明，JDK 公开了它用于此类事情的机制，这是我以前不知道的。只需使用 ServiceLoader。 The docs解释如何使用它，我也编写了一个如何使用它的示例。你可以find the code on github或者简单地克隆并自己运行它:

git clone git://github.com/zzantozz/testbed.git tmp
cd tmp
mvn install -pl serviceloader-example/service-usage -am
mvn -q exec:java -D exec.mainClass=rds.serviceloader.ServiceLoaderExample -pl serviceloader-example/service-usage

该示例由五个模块组成:一个定义服务接口(interface)，三个定义单独的服务实现，一个使用 ServiceLoader 加载实现。最后一个称为“服务使用”，演示了如何使用 ServiceLoader 类加载其他三个模块/jar 中定义的三个服务，这些模块/jar 实现了第一个模块/jar 中定义的接口(interface)。

编辑:由于您似乎在使用示例项目时遇到问题，这里是基础知识。

1. 每个包含一个或多个 Randomizer 实现的 jar 文件都应包含一个名为 META-INF/services/com.foo.Randomizer 的文件(其中 com.foo 是您的包名称)。
2. 这个文件应该包含一个类名列表，每行一个，每个都是 Randomizer 的一个实现。

3. 有了这些文件，您要做的就是获取所有 Randomizer 实例

   ServiceLoader<Randomizer> loader = ServiceLoader.load(Randomizer.class);
   for (Randomizer randomizer : loader) {
       randomizer.doWhatever();
   }