Java Language
Implementazioni del sistema di plugin Java
Ricerca…
Osservazioni
Se si utilizza un IDE e / o un sistema di compilazione, è molto più semplice impostare questo tipo di progetto. Crei un modulo applicativo principale, quindi un modulo API, quindi crei un modulo plugin e lo faccia dipendere dal modulo API o da entrambi. Successivamente, si configura dove devono essere posizionate le risorse del progetto, nel nostro caso i jar del plugin compilati possono essere inviati direttamente alla directory "plugins", evitando così di fare movimenti manuali.
Utilizzando URLClassLoader
Esistono diversi modi per implementare un sistema di plugin per un'applicazione Java. Uno dei più semplici è usare URLClassLoader . L'esempio seguente comporterà un po 'di codice JavaFX.
Supponiamo di avere un modulo di un'applicazione principale. Questo modulo dovrebbe caricare plugin in forma di Jars dalla cartella 'plugins'. Codice iniziale:
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);
}
}
Quindi, creiamo un'interfaccia che rappresenterà un plugin.
package main;
public interface Plugin
{
default void initialize()
{
System.out.println("Initialized "+this.getClass().getName());
}
default String name(){return getClass().getSimpleName();}
}
Vogliamo caricare classi che implementano questa interfaccia, quindi prima dobbiamo filtrare i file che hanno l'estensione '.jar':
File[] files=pluginDirectory.listFiles((dir, name) -> name.endsWith(".jar"));
Se ci sono file, dobbiamo creare raccolte di URL e nomi di classi:
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);
}
}
Aggiungiamo un HashSet statico a MainApplication che manterrà i plugin caricati:
static HashSet<Plugin> plugins=new HashSet<>();
Successivamente, istanziamo un URLClassLoader e iteriamo su nomi di classi, istanziando classi che implementano l'interfaccia 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();}
});
Quindi, possiamo chiamare i metodi del plugin, ad esempio, per inizializzarli:
if(!plugins.isEmpty())loadedPlugins.getChildren().add(new Label("Loaded plugins:"));
plugins.forEach(plugin -> {
plugin.initialize();
loadedPlugins.getChildren().add(new Label(plugin.name()));
});
Il codice finale di 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);
}
}
Creiamo due plugin. Ovviamente, la fonte del plugin dovrebbe essere in un modulo separato.
package plugins;
import main.Plugin;
public class FirstPlugin implements Plugin
{
//this plugin has default behaviour
}
Secondo 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"));
}
}
Questi plugin devono essere impacchettati in giare standard: questo processo dipende dal tuo IDE o da altri strumenti.
Quando i Jars verranno inseriti direttamente nei "plug-in", MainApplication li rileverà e istanzerà le classi appropriate.