Java Language
Java-plugin-systemimplementeringar
Sök…
Anmärkningar
Om du använder ett IDE och / eller bygger system är det mycket lättare att ställa in den här typen av projekt. Du skapar en huvudapplikationsmodul, sedan API-modul, skapar sedan en pluginmodul och gör den beroende av API-modulen eller båda. Därefter konfigurerar du var projektets artefakter ska placeras - i vårt fall kan de sammanställda plugin-burkarna skickas direkt till "plugins" -katalogen och därmed undvika att göra manuell rörelse.
Använda URLClassLoader
Det finns flera sätt att implementera ett plugin-system för en Java-applikation. En av de enklaste är att använda URLClassLoader . Följande exempel involverar lite JavaFX-kod.
Anta att vi har en modul med en huvudapplikation. Denna modul är tänkt att ladda plugins i form av Jars från "plugins" -mappen. Inledande kod:
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);
}
}
Sedan skapar vi ett gränssnitt som representerar ett plugin.
package main;
public interface Plugin
{
default void initialize()
{
System.out.println("Initialized "+this.getClass().getName());
}
default String name(){return getClass().getSimpleName();}
}
Vi vill ladda klasser som implementerar detta gränssnitt, så först måste vi filtrera filer som har ett .jar-förlängning:
File[] files=pluginDirectory.listFiles((dir, name) -> name.endsWith(".jar"));
Om det finns några filer måste vi skapa samlingar av webbadresser och klassnamn:
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);
}
}
Låt oss lägga till en statisk HashSet till MainApplication som kommer att innehålla laddade plugins:
static HashSet<Plugin> plugins=new HashSet<>();
Därefter initierar vi en URLClassLoader och itererar över klassnamn , instigerar klasser som implementerar Plugin- gränssnitt:
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();}
});
Sedan kan vi ringa plugin-metoder, till exempel för att initialisera dem:
if(!plugins.isEmpty())loadedPlugins.getChildren().add(new Label("Loaded plugins:"));
plugins.forEach(plugin -> {
plugin.initialize();
loadedPlugins.getChildren().add(new Label(plugin.name()));
});
Den sista koden för 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);
}
}
Låt oss skapa två plugins. Uppenbarligen bör plugin-källan finnas i en separat modul.
package plugins;
import main.Plugin;
public class FirstPlugin implements Plugin
{
//this plugin has default behaviour
}
Andra 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"));
}
}
Dessa plugins måste paketeras i standardburkar - den här processen beror på din IDE eller andra verktyg.
När Jars kommer att placeras direkt i "plugins" kommer MainApplication att upptäcka dem och instansera lämpliga klasser.