使用ServiceLoader动态加载插件jar

Question

我正在尝试为我的应用程序创建一个插件系统，我想从简单的事情开始。每个插件都应打包在.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.动态扩展类路径

这使用已知的技巧在系统类加载器上使用反射来避免封装，从而添加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());
    }
}

再一次，迭代器再也没有“ next”元素。

我肯定会缺少某些东西，因为这是我第一次“玩”类路径和加载。

Answer 1

问题很简单。又傻 在插件.jar文件中/services/plugintest.SimplePlugin，META- INF目录内缺少该文件，因此ServiceLoader无法将jar识别为服务并加载类。

几乎就是所有，第二种方法（和更清洁的方法）就像一种魅力。