使用 ServiceLoader 动态加载插件 jar
2022-08-31 22:11:56
我正在尝试为我的应用程序创建一个插件系统,我想从简单的事情开始。每个插件都应该打包在一个.jar文件中,并实现接口:SimplePlugin
package plugintest;
public interface SimplePlugin {
public String getName();
}
现在,我已经创建了一个的实现,打包在.jar中,并将其放在主应用程序的插件/子目录中:SimplePlugin
package plugintest;
public class PluginTest implements SimplePlugin {
public String getName() {
return "I'm the plugin!";
}
}
在主应用程序中,我想获取 .我尝试了两种选择,都使用.PluginTest
java.util.ServiceLoader
1. 动态扩展类路径
这使用已知的 hack 在系统类装入器上使用反射来避免封装,以便将 s 添加到类路径中。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();
}
}
}
插件/目录按预期添加(因为可以检查调用),但随后对象给出的迭代器为空。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());
}
}
再一次,迭代器从来没有“下一个”元素。
我肯定错过了一些东西,因为这是我第一次“玩”类路径和加载。