Java Language
Реализации Java-плагинов
Поиск…
замечания
Если вы используете систему IDE и / или сборки, гораздо проще настроить такой проект. Вы создаете основной модуль приложения, затем модуль API, затем создаете модуль плагина и делаете его зависимым от модуля API или обоих. Затем вы настраиваете, где должны быть помещены артефакты проекта - в нашем случае скомпилированные плагины могут быть отправлены прямо в каталог «plugins», что позволяет избежать ручного перемещения.
Использование URLClassLoader
Существует несколько способов реализации плагиновой системы для Java-приложения. Одним из самых простых является использование URLClassLoader . В следующем примере будет задействован бит кода JavaFX.
Предположим, что у нас есть модуль основного приложения. Предполагается, что этот модуль загружает плагины в форме Jars из папки «plugins». Исходный код:
package main;
public class MainApplication extends Application
{
@Override
public void start(Stage primaryStage) throws Exception
{
File pluginDirectory=new File("plugins"); //arbitrary directory
if(!pluginDirectory.exists())pluginDirectory.mkdir();
VBox loadedPlugins=new VBox(6); //a container to show the visual info later
Rectangle2D screenbounds=Screen.getPrimary().getVisualBounds();
Scene scene=new Scene(loadedPlugins,screenbounds.getWidth()/2,screenbounds.getHeight()/2);
primaryStage.setScene(scene);
primaryStage.show();
}
public static void main(String[] a)
{
launch(a);
}
}
Затем мы создаем интерфейс, который будет представлять собой плагин.
package main;
public interface Plugin
{
default void initialize()
{
System.out.println("Initialized "+this.getClass().getName());
}
default String name(){return getClass().getSimpleName();}
}
Мы хотим загрузить классы, реализующие этот интерфейс, поэтому сначала нам нужно отфильтровать файлы с расширением «.jar»:
File[] files=pluginDirectory.listFiles((dir, name) -> name.endsWith(".jar"));
Если есть какие-либо файлы, нам необходимо создать коллекции URL-адресов и имен классов:
if(files!=null && files.length>0)
{
ArrayList<String> classes=new ArrayList<>();
ArrayList<URL> urls=new ArrayList<>(files.length);
for(File file:files)
{
JarFile jar=new JarFile(file);
jar.stream().forEach(jarEntry -> {
if(jarEntry.getName().endsWith(".class"))
{
classes.add(jarEntry.getName());
}
});
URL url=file.toURI().toURL();
urls.add(url);
}
}
Давайте добавим статический HashSet к MainApplication, который будет содержать загруженные плагины:
static HashSet<Plugin> plugins=new HashSet<>();
Затем мы создаем экземпляр URLClassLoader и повторяем имена классов, создавая экземпляры классов, которые реализуют интерфейс Plugin :
URLClassLoader urlClassLoader=new URLClassLoader(urls.toArray(new URL[urls.size()]));
classes.forEach(className->{
try
{
Class cls=urlClassLoader.loadClass(className.replaceAll("/",".").replace(".class","")); //transforming to binary name
Class[] interfaces=cls.getInterfaces();
for(Class intface:interfaces)
{
if(intface.equals(Plugin.class)) //checking presence of Plugin interface
{
Plugin plugin=(Plugin) cls.newInstance(); //instantiating the Plugin
plugins.add(plugin);
break;
}
}
}
catch (Exception e){e.printStackTrace();}
});
Затем мы можем вызвать методы плагина, например, для их инициализации:
if(!plugins.isEmpty())loadedPlugins.getChildren().add(new Label("Loaded plugins:"));
plugins.forEach(plugin -> {
plugin.initialize();
loadedPlugins.getChildren().add(new Label(plugin.name()));
});
Окончательный код MainApplication :
package main;
public class MainApplication extends Application
{
static HashSet<Plugin> plugins=new HashSet<>();
@Override
public void start(Stage primaryStage) throws Exception
{
File pluginDirectory=new File("plugins");
if(!pluginDirectory.exists())pluginDirectory.mkdir();
File[] files=pluginDirectory.listFiles((dir, name) -> name.endsWith(".jar"));
VBox loadedPlugins=new VBox(6);
loadedPlugins.setAlignment(Pos.CENTER);
if(files!=null && files.length>0)
{
ArrayList<String> classes=new ArrayList<>();
ArrayList<URL> urls=new ArrayList<>(files.length);
for(File file:files)
{
JarFile jar=new JarFile(file);
jar.stream().forEach(jarEntry -> {
if(jarEntry.getName().endsWith(".class"))
{
classes.add(jarEntry.getName());
}
});
URL url=file.toURI().toURL();
urls.add(url);
}
URLClassLoader urlClassLoader=new URLClassLoader(urls.toArray(new URL[urls.size()]));
classes.forEach(className->{
try
{
Class cls=urlClassLoader.loadClass(className.replaceAll("/",".").replace(".class",""));
Class[] interfaces=cls.getInterfaces();
for(Class intface:interfaces)
{
if(intface.equals(Plugin.class))
{
Plugin plugin=(Plugin) cls.newInstance();
plugins.add(plugin);
break;
}
}
}
catch (Exception e){e.printStackTrace();}
});
if(!plugins.isEmpty())loadedPlugins.getChildren().add(new Label("Loaded plugins:"));
plugins.forEach(plugin -> {
plugin.initialize();
loadedPlugins.getChildren().add(new Label(plugin.name()));
});
}
Rectangle2D screenbounds=Screen.getPrimary().getVisualBounds();
Scene scene=new Scene(loadedPlugins,screenbounds.getWidth()/2,screenbounds.getHeight()/2);
primaryStage.setScene(scene);
primaryStage.show();
}
public static void main(String[] a)
{
launch(a);
}
}
Давайте создадим два плагина. Очевидно, что источник плагина должен быть в отдельном модуле.
package plugins;
import main.Plugin;
public class FirstPlugin implements Plugin
{
//this plugin has default behaviour
}
Второй плагин:
package plugins;
import main.Plugin;
public class AnotherPlugin implements Plugin
{
@Override
public void initialize() //overrided to show user's home directory
{
System.out.println("User home directory: "+System.getProperty("user.home"));
}
}
Эти плагины должны быть упакованы в стандартные Jars - этот процесс зависит от вашей среды разработки или других инструментов.
Когда Jars будут помещены в «плагины» напрямую, MainApplication обнаружит их и создаст соответствующие классы.