Java Language
Implémentations du système de plug-in Java
Recherche…
Remarques
Si vous utilisez un IDE et / ou un système de construction, il est beaucoup plus facile de configurer ce type de projet. Vous créez un module d'application principal, puis un module d'API, puis créez un module de plug-in et faites-le dépendre du module de l'API ou des deux. Ensuite, vous configurez l'emplacement des artefacts du projet - dans notre cas, les plug-ins compilés peuvent être envoyés directement dans le répertoire "plugins", évitant ainsi tout mouvement manuel.
Utiliser URLClassLoader
Il existe plusieurs manières d’implémenter un système de plug-in pour une application Java. L'un des plus simples est d'utiliser URLClassLoader . L'exemple suivant impliquera un peu de code JavaFX.
Supposons que nous ayons un module d'une application principale. Ce module est supposé charger des plugins sous forme de Jars depuis le dossier 'plugins'. Code initial:
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);
}
}
Ensuite, nous créons une interface qui représentera un plug-in.
package main;
public interface Plugin
{
default void initialize()
{
System.out.println("Initialized "+this.getClass().getName());
}
default String name(){return getClass().getSimpleName();}
}
Nous voulons charger les classes qui implémentent cette interface, donc nous devons d'abord filtrer les fichiers qui ont une extension '.jar':
File[] files=pluginDirectory.listFiles((dir, name) -> name.endsWith(".jar"));
S'il y a des fichiers, nous devons créer des collections d'URL et de noms de classe:
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);
}
}
Ajoutons un HashSet statique à MainApplication qui contiendra les plugins chargés:
static HashSet<Plugin> plugins=new HashSet<>();
Ensuite, nous instancions un URLClassLoader et effectuons une itération sur les noms de classes, en instanciant des classes qui implémentent une interface 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();}
});
Ensuite, nous pouvons appeler les méthodes du plugin, par exemple, pour les initialiser:
if(!plugins.isEmpty())loadedPlugins.getChildren().add(new Label("Loaded plugins:"));
plugins.forEach(plugin -> {
plugin.initialize();
loadedPlugins.getChildren().add(new Label(plugin.name()));
});
Le code final de 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);
}
}
Créons deux plugins. De toute évidence, la source du plugin devrait être dans un module séparé.
package plugins;
import main.Plugin;
public class FirstPlugin implements Plugin
{
//this plugin has default behaviour
}
Deuxième plugin:
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"));
}
}
Ces plugins doivent être intégrés dans des fichiers Jars standard. Ce processus dépend de votre IDE ou d’autres outils.
Lorsque les Jars seront placés directement dans les «plugins», MainApplication les détectera et instanciera les classes appropriées.