使用 ServiceLoader 动态加载插件 jar

我正在尝试为我的应用程序创建一个插件系统，并且我想从一些简单的事情开始。每个插件都应该打包在一个 .jar 文件中并实现SimplePlugin界面：

package plugintest;

public interface SimplePlugin {
    public String getName();
}

现在我已经创建了一个实现SimplePlugin，打包成.jar并放入主应用程序的plugin/子目录中：

package plugintest;

public class PluginTest implements SimplePlugin {
    public String getName() {
        return "I'm the plugin!";
    }
}

在主应用程序中，我想获取一个实例PluginTest。我尝试了两种选择，都使用java.util.ServiceLoader.

1.动态扩展类路径

这使用已知的 hack 在系统类加载器上使用反射来避免封装，以便添加URL是类路径。

package plugintest.system;

import plugintest.SimplePlugin;

import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Iterator;
import java.util.ServiceLoader;

public class ManagePlugins {
    public static void main(String[] args) throws IOException {
        File loc = new File("plugins");
        extendClasspath(loc);

        ServiceLoader<SimplePlugin> sl = ServiceLoader.load(SimplePlugin.class);
        Iterator<SimplePlugin> apit = sl.iterator();
        while (apit.hasNext())
            System.out.println(apit.next().getName());
    }

    private static void extendClasspath(File dir) throws IOException {
        URLClassLoader sysLoader = (URLClassLoader) ClassLoader.getSystemClassLoader();
        URL urls[] = sysLoader.getURLs(), udir = dir.toURI().toURL();
        String udirs = udir.toString();
        for (int i = 0; i < urls.length; i++)
            if (urls[i].toString().equalsIgnoreCase(udirs)) return;
        Class<URLClassLoader> sysClass = URLClassLoader.class;
        try {
            Method method = sysClass.getDeclaredMethod("addURL", new Class[]{URL.class});
            method.setAccessible(true);
            method.invoke(sysLoader, new Object[] {udir});
        } catch (Throwable t) {
            t.printStackTrace();
        }
    }
}

plugins/ 目录按预期添加（因为可以检查调用sysLoader.getURLs())，但是迭代器由ServiceLoader对象为空。

2.使用URLClassLoader

这使用了另一个定义ServiceLoader.load与该类的第二个参数ClassLoader.

package plugintest.system;

import plugintest.SimplePlugin;

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Iterator;
import java.util.ServiceLoader;

public class ManagePlugins {
    public static void main(String[] args) throws IOException {
        File loc = new File("plugins");

        File[] flist = loc.listFiles(new FileFilter() {
            public boolean accept(File file) {return file.getPath().toLowerCase().endsWith(".jar");}
        });
        URL[] urls = new URL[flist.length];
        for (int i = 0; i < flist.length; i++)
            urls[i] = flist[i].toURI().toURL();
        URLClassLoader ucl = new URLClassLoader(urls);

        ServiceLoader<SimplePlugin> sl = ServiceLoader.load(SimplePlugin.class, ucl);
        Iterator<SimplePlugin> apit = sl.iterator();
        while (apit.hasNext())
            System.out.println(apit.next().getName());
    }
}

再说一遍，迭代器从来没有“下一个”元素。

肯定有一些东西我错过了，因为这是我第一次“玩”类路径和加载。

问题很简单。而且愚蠢。在插件 .jar 文件中/services/plugintest.SimplePlugin文件内丢失META-INF目录，所以ServiceLoader无法将 jar 识别为服务并加载该类。

这几乎就是全部，第二种（也是更干净的）方法就像一个魅力。