Java-Programme durch PlugIns erweitern: Unterschied zwischen den Versionen

Aus Byte-Welt Wiki
Zur Navigation springenZur Suche springen
K (Kommentare geändert, Code bearbeitet (Variablen ausgelagert), neuen Abschnitt mit gesamter Methode angelegt)
 
(9 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
Damit [[Programm]]e leicht um neue Teile erweitert werden können, ist es hilfreich diese mit einer [[Plugin]]-[[Schnittstelle]] auszustatten.
+
{| align=center border=0 cellpadding=3 cellspacing=3 style="border: 1px solid #E0E0E0; background-color: #F8F8F8"
 +
|-
 +
| style="font-size: 90%" | [[Bild:Unvollstaendig.png]]  Dieser Artikel ist unvollständig. Hilf mit ihn zu verbessern, erweitere ihn oder beteilige dich an der Diskussion.
 +
|}
 +
 
 +
Damit [[Programm]]e leicht um neue Teile erweitert werden können, ist es hilfreich und komfortabel, diese mit einer [[Plugin]]-[[Schnittstelle]] auszustatten.
  
 
==Voraussetzungen==
 
==Voraussetzungen==
 
Als Voraussetzung für die Verwendung von Plugins sollten verschiedene [[Klasse]]n und [[Interface (Java) | Interface]]s vorhanden sein:
 
Als Voraussetzung für die Verwendung von Plugins sollten verschiedene [[Klasse]]n und [[Interface (Java) | Interface]]s vorhanden sein:
 
# '''Plugin-Interface''' - das die Plugins implementieren müssen. Hiermit wird festgelegt welche Funktionen das Plugin der Anwendung anbieten muss.
 
# '''Plugin-Interface''' - das die Plugins implementieren müssen. Hiermit wird festgelegt welche Funktionen das Plugin der Anwendung anbieten muss.
# '''Anwendung-Interface''' - das die Schnittstelle von den Plugins zur [[Anwendung]] darstellt, hiermit kann kontrolliert werden was die Anwendungen dürfen und was sie sehen.
+
# '''Anwendung-Interface''' - das die Schnittstelle von den Plugins zur [[Anwendung]] darstellt, hiermit kann kontrolliert werden, was die Anwendungen dürfen und was sie sehen.
 
# '''Manager''' - gesonderte Klasse für das Laden, Starten und Beenden der Plugins.
 
# '''Manager''' - gesonderte Klasse für das Laden, Starten und Beenden der Plugins.
  
 
==Die Interfaces==
 
==Die Interfaces==
Das gesamte Plugin-System könnte auch ohne Interfaces geschrieben werden, jedoch ist dies unsicherer. Weil wenn dafür die Klassen der Anwendung eingebunden werden müssen und mit [[Entwicklungsumgebung]]en wie [[Eclipse]] kann der [[Programmierer]] alle [[Methoden]] sehen und auf diese zugreifen. Die Interfaces schließen dies nicht aus aber bilden eine saubere Trennung.
+
Das gesamte Plugin-System könnte auch ohne Interfaces geschrieben werden, jedoch ist dies unsicherer. Interfaces standardisieren durch vordefinierte Methoden die Entwicklung und Verwendung von Klassen, was innerhalb der Anwendung sicher stellt, dass nachgerüstete Klassen alle benötigten Methoden bereit stellen. Dadurch ist mit einfachen Mitteln eine gewisse Vielgestaltigkeit möglich.
  
 
===Das Plugin-Interface===
 
===Das Plugin-Interface===
Das Interface für die Plugins kann keine Methoden umfassen, aber auch viele verschiedene. Es sollte nach meiner derzeitigen Auffassung jedoch immer zwei Methoden besitzen '''start''' und '''stop'''. Außerdem eine Methode um die Manager-Klasse zu setzen, sollte das Plugin auf irgendwelche Eigenschaften der Anwendung zugreifen können.
+
Das Interface für die Plugins muss keine Methoden (Markerinterface), kann aber auch beliebig viele definieren. Es hat sich bewärt, dass das Plugin-Interface mindestens zwei Methoden besitzt '''start()''' und '''stop()'''. Außerdem eine Methode um die Manager-Klasse zu setzen, sollte das Plugin auf irgendwelche Eigenschaften der Anwendung zugreifen können.
<code=java>
+
<syntaxhighlight lang="java">
 
package net.byte_welt.wiki;
 
package net.byte_welt.wiki;
 
public interface PluginInterface{
 
public interface PluginInterface{
Zeile 20: Zeile 25:
 
   public void hello();
 
   public void hello();
 
}
 
}
</code=java>
+
</syntaxhighlight>
 
Zusätzlich wurde das Interface um die Methode ''hello'' erweitert, somit kann das Plugin von der Anwendung auch benachrichtigt werden.
 
Zusätzlich wurde das Interface um die Methode ''hello'' erweitert, somit kann das Plugin von der Anwendung auch benachrichtigt werden.
  
 
===Das PluginManager-Interface===
 
===Das PluginManager-Interface===
Das Interface für den Pluginmanager bildet die Schnittstelle vom Plugin zur Anwendung, hier werden alle Methoden aufgeführt die das Plugin aufrufen darf.
+
Das Interface für den Pluginmanager bildet die Schnittstelle vom Plugin zur Anwendung. Hier werden alle Methoden aufgeführt die das Plugin aufrufen darf.
<code=java>
+
<syntaxhighlight lang="java">
 
package net.byte_welt.wiki;
 
package net.byte_welt.wiki;
 
public interface PluginManager{
 
public interface PluginManager{
 
   public void openWindow(String msg);
 
   public void openWindow(String msg);
 
}
 
}
</code=java>
+
</syntaxhighlight>
Unser Pluginmanager erlaubt nur das Öffnen eines Fensters mit einem String als Nachricht.
+
Unser Plugin-Manager erlaubt nur das Öffnen eines Fensters mit einem String als Nachricht.
  
 
==Implementierungen==
 
==Implementierungen==
Zeile 38: Zeile 43:
 
===Hello-Plugin===
 
===Hello-Plugin===
 
Unser Plugin soll beim Aufruf der ''hello()''-Methode nur ein Fenster öffnen und dort ''Hallo'' ausgeben, daher fällt die Implementierung sehr einfach aus. Die ''start()''- und ''stop()''-Methoden werden garnicht benötigt, würde der Text aus einer [[Datenbank]] oder [[Datei]] gelesen werden könnte dies in der ''start''-Methode erledigt werden
 
Unser Plugin soll beim Aufruf der ''hello()''-Methode nur ein Fenster öffnen und dort ''Hallo'' ausgeben, daher fällt die Implementierung sehr einfach aus. Die ''start()''- und ''stop()''-Methoden werden garnicht benötigt, würde der Text aus einer [[Datenbank]] oder [[Datei]] gelesen werden könnte dies in der ''start''-Methode erledigt werden
<code=java>
+
<syntaxhighlight lang="java">
 
package net.byte_welt.wiki;
 
package net.byte_welt.wiki;
 
public class HelloPlugin implements PluginInterface{
 
public class HelloPlugin implements PluginInterface{
Zeile 57: Zeile 62:
 
   }
 
   }
 
}
 
}
</code=java>
+
</syntaxhighlight>
  
 
===PluginManager===
 
===PluginManager===
Der Pluginmanager kann für zwei Aufgaben verwendet werden, einmal kann er dem Plugin übergeben werden und zusätzlich kann er die Kontrolle der Plugins übernehmen. Unser Pluginmanager übernimmt beide Aufgaben, daher implementiert er das PluginManager-Interface. Zusätzlich werden die Methoden ''loadPlugin'', ''start'' und ''stop'' implementiert.
+
Der Plugin-Manager kann für zwei Aufgaben verwendet werden. Er kann dem Plugin übergeben werden und zusätzlich kann er die Kontrolle der Plugins übernehmen. Unser Pluginmanager übernimmt beide Aufgaben, daher implementiert er das PluginManager-Interface. Zusätzlich werden die [[Methode|Methoden]] ''loadPlugin'', ''start'' und ''stop'' implementiert.
<code=java>
+
<syntaxhighlight lang="java">
 
package net.byte_welt.wiki;
 
package net.byte_welt.wiki;
 
import java.io.*;
 
import java.io.*;
 
import java.util.jar.*;
 
import java.util.jar.*;
 
import java.net.*;
 
import java.net.*;
 +
 
public class PluginManagerImpl implements PluginManager{
 
public class PluginManagerImpl implements PluginManager{
   private Vector<PluginInterface> loadedplugins = new Vector<PluginInterface>();
+
 
 +
   private List<PluginInterface> loadedplugins = new ArrayLIst<>();
 +
 
 
   public void start(){
 
   public void start(){
   ...
+
   //..
 
   }
 
   }
 
   public void stop(){
 
   public void stop(){
   ...
+
   //..
 
   }
 
   }
 
   public void loadPlugin(File file){
 
   public void loadPlugin(File file){
   ...
+
   //..
 
   }
 
   }
 
   public void openWindow(String msg){
 
   public void openWindow(String msg){
   ...
+
   //..
 
   }
 
   }
 
}
 
}
</code=java>
+
</syntaxhighlight>
  
 
====Start-Methode====
 
====Start-Methode====
Die ''start''-Methode wird aufgerufen, wenn die Anwendung gestartet wird und alle vorhandenen Plugins geladen werden sollen. Die Pfade zu den vorhandenen Plugins lassen sich z.B. extra speichern oder es wird gesagt alles was im Ordner '''plugins''' liegt gilt als Plugin. In unserem Fall wird gesagt was im Ordner '''plugins''' liegt wird geladen, dafür wird nur die ''loadPlugin''-Methode aufgerufen.
+
Die ''start''-Methode wird aufgerufen, wenn die Anwendung gestartet wird und alle vorhandenen Plugins geladen werden sollen. Die Pfade zu den vorhandenen Plugins lassen sich z.B. extra speichern, oder es wird gesagt, alles was im Ordner '''plugins''' liegt gilt als Plugin. In unserem Fall wird gesagt, was im Ordner '''plugins''' liegt wird geladen, dafür wird nur die ''loadPlugin''-Methode aufgerufen.
<code=java>
+
<syntaxhighlight lang="java">
 
public void start(){
 
public void start(){
 
   File[] files = new File("plugins").listFiles();
 
   File[] files = new File("plugins").listFiles();
   for(File f:files)
+
   for(File f : files)
 
     loadPlugin(f);
 
     loadPlugin(f);
   for(PluginInterface pi:loadedplugins)
+
   for(PluginInterface pi : loadedplugins)
 
     pi.start();
 
     pi.start();
 
}
 
}
</code=java>
+
</syntaxhighlight>
Sind alle Plugins geladen werden sie gestartet.
+
Sind alle Plugins geladen, werden sie gestartet.
  
 
====Stop-Methode====
 
====Stop-Methode====
Mit der ''stop''-Methode wird den Plugins signalisiert, dass sie runterfahren sollen. Dies ist der Fall, wenn z.B. das Programm beendet wird.<code=java>
+
Mit der ''stop''-Methode wird den Plugins signalisiert, dass sie herunterfahren sollen. Dies ist der Fall, wenn z.B. das Programm beendet wird.<syntaxhighlight lang="java">
 
public void stop(){
 
public void stop(){
   for(PluginInterface pi:loadedplugins)
+
   for(PluginInterface pi : loadedplugins)
 
     pi.stop();
 
     pi.stop();
 
}
 
}
</code=java>
+
</syntaxhighlight>
  
 
====LoadPlugin-Methode====
 
====LoadPlugin-Methode====
Um Plugins zu laden gibt es zwei Ansätze, zum einen gibt es die Möglichkeit [[Class-Datei]]en aber auch [[JAR-Datei]]en zu laden.
+
Um Plugins zu laden, gibt es zwei Ansätze. Zum einen gibt es die Möglichkeit [[Class-Datei|Class-Dateien]] aber auch [[JAR-Datei|JAR-Dateien]] zu laden.
  
 
=====JAR-Dateien laden=====
 
=====JAR-Dateien laden=====
Um ein Plugin aus einer JAR-Datei zu laden muss deren Pfad und die Mainclass bekannt sein. Im Gegensatz zu einer normalen Anwendung ist die Mainclass bei einem Plugin die Klasse, die das Interface für die Pluginschnittstelle implementiert. Es ist aber auch Möglich alle Klassen der JAR durchzulaufen.
+
Um ein Plugin aus einer JAR-Datei zu laden, muss deren Pfad und die [[Main-Class]] bekannt sein. Im Gegensatz zu einer normalen Anwendung ist die Main-Class bei einem Plugin die [[Klasse]], die das [[Interface]] für die Plugin-Schnittstelle implementiert. Es ist aber auch möglich, alle Klassen der JAR zu durchlaufen.
<code=java>
+
<syntaxhighlight lang="java">
//Erzeugen des JAR-Objekts
+
//Erzeugen des JAR-Objekts durch die Eingabe der eingelesenen File in file
JarFile file = new JarFile("Plugin.jar");
+
JarFile file = new JarFile(file);
 
//Laden der MANIFEST.MF
 
//Laden der MANIFEST.MF
 
Manifest manifest = file.getManifest();
 
Manifest manifest = file.getManifest();
Zeile 118: Zeile 126:
 
// holen der Mainclass aus den Attributen
 
// holen der Mainclass aus den Attributen
 
String main = attrib.getValue(Attributes.Name.MAIN_CLASS);
 
String main = attrib.getValue(Attributes.Name.MAIN_CLASS);
</code=java>
+
</syntaxhighlight>
  
Aus dem Manifest-Objekt lassen sich jetzt beliebige Daten auslesen, jedoch werden hier nur die Informationen über die Mainclass benötigt. Mit diesen Daten lässt sich jetzt das Plugin laden, dazu wird ein neuer [[ClassLoader (Java) |ClassLoader]] erzeugt.
+
Aus dem [[JAR-Datei#MANIFEST.MF|Manifest]]-Objekt lassen sich jetzt beliebige Daten auslesen, jedoch werden hier nur die Informationen über die Main-Class benötigt. Mit diesen Daten lässt sich jetzt das Plugin laden, dazu wird ein neuer [[ClassLoader (Java) |ClassLoader]] erzeugt.
<code=java>
+
<syntaxhighlight lang="java">
// laden der Klasse mit dem File als URL und der Mainclass
+
//Festlegen wo das PluginInterface liegt
Class cl = new URLClassLoader(new URL[]{new File("Plugin.jar").toURL()}).loadClass(main);
+
String PLUGININTERFACECLASS_STRING = "net.byte_welt.wiki.PluginInterface";
// holen der Interfaces die die Klasse impementiert
+
// Laden der Datei und Konvertierung von einer Datei, zu einer URI und dann zu einer URL
 +
URL urlFile = file.toURI().toURL();
 +
// Laden der Klasse durch den URLClassLoader
 +
URLClassLoader classLoader = new URLClassLoader(new URL[] { urlFile });
 +
// Class aus dem classLoader holen
 +
Class cl = classLoader.loadClass(main);
 +
// Interfaces aus der Klasse holen, die dort impementiert sind
 
Class[] interfaces = cl.getInterfaces();
 
Class[] interfaces = cl.getInterfaces();
// Durchlaufen durch die Interfaces der Klasse und nachsehn ob es das passende Plugin implementiert
+
// Durchlaufen durch die Interfaces der Klasse und nachsehen ob es das passende Plugin implementiert
 
boolean isplugin = false;
 
boolean isplugin = false;
 
for(int y = 0; y < interfaces.length && !isplugin; y++)
 
for(int y = 0; y < interfaces.length && !isplugin; y++)
   if(interfaces[y].getName().equals("net.byte_welt.wiki.PluginInterface"))
+
   if(interfaces[y].getName().equals(PLUGININTERFACECLASS_STRING))
 
     isplugin = true;
 
     isplugin = true;
 
if(isplugin){
 
if(isplugin){
Zeile 135: Zeile 149:
 
   loadedplugins.add(plugin);
 
   loadedplugins.add(plugin);
 
}
 
}
</code=java>
+
 
 +
//Schließen von JarFile und ClassLoader um Fehler zu vermeiden
 +
//jarFile.close();
 +
classLoader.close();
 +
</syntaxhighlight>
 
Anschließend werden die Interfaces der Klasse betrachtet, ob es sich wirklich um ein Plugin handelt. Ist es ein Plugin wird eine neue Instanz erzeugt und diese abgespeichert.
 
Anschließend werden die Interfaces der Klasse betrachtet, ob es sich wirklich um ein Plugin handelt. Ist es ein Plugin wird eine neue Instanz erzeugt und diese abgespeichert.
 +
 +
=====JAR-Dateien laden (Die Methode komplett)=====
 +
Um ein Plugin aus einer JAR-Datei zu laden, muss deren Pfad und die [[Main-Class]] bekannt sein. Im Gegensatz zu einer normalen Anwendung ist die Main-Class bei einem Plugin die [[Klasse]], die das [[Interface]] für die Plugin-Schnittstelle implementiert. Es ist aber auch möglich, alle Klassen der JAR zu durchlaufen.
 +
<syntaxhighlight lang="java">
 +
 +
//Festlegen wo das PluginInterface liegt
 +
private static final String PLUGININTERFACECLASS_STRING = "net.byte_welt.wiki.PluginInterface";
 +
 +
public void loadPlugin(File file) {
 +
try {
 +
// Erzeugen des JAR-Objekts durch die Eingabe der eingelesenen File in file
 +
JarFile jarFile = new JarFile(file);
 +
// Laden der MANIFEST.MF
 +
Manifest manifest = jarFile.getManifest();
 +
// Auslesen der Attribute aus der Manifest-Datei
 +
Attributes attrib = manifest.getMainAttributes();
 +
// Mainclass aus den Attributen laden
 +
String main = attrib.getValue(Attributes.Name.MAIN_CLASS);
 +
// Laden der Datei und Konvertierung von einer Datei, zu einer URI und dann zu
 +
// einer URL
 +
URL urlFile = file.toURI().toURL();
 +
// Laden der Klasse durch den URLClassLoader
 +
URLClassLoader classLoader = new URLClassLoader(new URL[] { urlFile });
 +
// Class aus dem classLoader holen
 +
Class cl = classLoader.loadClass(main);
 +
// Interfaces aus der Klasse holen, die dort impementiert sind
 +
Class[] interfaces = cl.getInterfaces();
 +
// Durchlaufen durch die Interfaces der Klasse und nachsehen ob es das
 +
// PluginInterface implementiert und somit ein Plugin ist
 +
boolean isplugin = false;
 +
for (int y = 0; y < interfaces.length && !isplugin; y++)
 +
if (interfaces[y].getName().equals(PLUGININTERFACECLASS_STRING))
 +
isplugin = true;
 +
// Wenn es ein Plugin ist, dann lade die Datei bzw. das Plugin
 +
if (isplugin) {
 +
PluginInterface plugin = (PluginInterface) cl.newInstance();
 +
        // Zu den geladenen Plugin hinzufügen
 +
loadedplugins.add(plugin);
 +
}
 +
// Schließen von JarFile und ClassLoader um Fehler zu vermeiden
 +
jarFile.close();
 +
classLoader.close();
 +
} catch (ClassNotFoundException | InstantiationException | IllegalAccessException | IOException e) {
 +
System.out.println("Plugin konnte nicht geladen werden!");
 +
e.printStackTrace();
 +
}
 +
}
 +
</syntaxhighlight>
  
 
=====Class-Dateien laden=====
 
=====Class-Dateien laden=====
* Da muss ich gerade passen das hab ich noch nicht ausprobiert, das sollte ähnlich wie mit den JAR Dateien laufen.
+
* wird nachgeliefert.
 
 
  
 
===OpenWindow-Methode===
 
===OpenWindow-Methode===
Die ''openWindow''-Methode ist für die Interaktion mit den Plugins, sie können über diese Methode ein Fenster öffnen lassen.
+
Die ''openWindow''-Methode ist für die Interaktion mit den Plugins nötig, über diese Methode kann ein Fenster geöffnet werden.
<code=java>
+
<syntaxhighlight lang="java">
 
public void openWindow(String msg){
 
public void openWindow(String msg){
   javax.swing.JOptionPane.showMessageDialog(null,msg);
+
   javax.swing.JOptionPane.showMessageDialog(null, msg);
 
}
 
}
</code=java>
+
</syntaxhighlight>
 +
 
 +
=Weblinks=
 +
*[http://www.java-blog-buch.de/d-plugin-entwicklung-in-java/ Java Blog Buch: Plugin-Entwicklung in Java]
 +
 
 +
 
 
[[Kategorie:Tutorials (Java)]]
 
[[Kategorie:Tutorials (Java)]]
 +
[[Kategorie:Java]]

Aktuelle Version vom 10. Dezember 2021, 12:15 Uhr

Unvollstaendig.png Dieser Artikel ist unvollständig. Hilf mit ihn zu verbessern, erweitere ihn oder beteilige dich an der Diskussion.

Damit Programme leicht um neue Teile erweitert werden können, ist es hilfreich und komfortabel, diese mit einer Plugin-Schnittstelle auszustatten.

Voraussetzungen

Als Voraussetzung für die Verwendung von Plugins sollten verschiedene Klassen und Interfaces vorhanden sein:

  1. Plugin-Interface - das die Plugins implementieren müssen. Hiermit wird festgelegt welche Funktionen das Plugin der Anwendung anbieten muss.
  2. Anwendung-Interface - das die Schnittstelle von den Plugins zur Anwendung darstellt, hiermit kann kontrolliert werden, was die Anwendungen dürfen und was sie sehen.
  3. Manager - gesonderte Klasse für das Laden, Starten und Beenden der Plugins.

Die Interfaces

Das gesamte Plugin-System könnte auch ohne Interfaces geschrieben werden, jedoch ist dies unsicherer. Interfaces standardisieren durch vordefinierte Methoden die Entwicklung und Verwendung von Klassen, was innerhalb der Anwendung sicher stellt, dass nachgerüstete Klassen alle benötigten Methoden bereit stellen. Dadurch ist mit einfachen Mitteln eine gewisse Vielgestaltigkeit möglich.

Das Plugin-Interface

Das Interface für die Plugins muss keine Methoden (Markerinterface), kann aber auch beliebig viele definieren. Es hat sich bewärt, dass das Plugin-Interface mindestens zwei Methoden besitzt start() und stop(). Außerdem eine Methode um die Manager-Klasse zu setzen, sollte das Plugin auf irgendwelche Eigenschaften der Anwendung zugreifen können.

package net.byte_welt.wiki;
public interface PluginInterface{
  public boolean start();
  public boolean stop();
  public void setPluginManager(PluginManager manager);
  public void hello();
}

Zusätzlich wurde das Interface um die Methode hello erweitert, somit kann das Plugin von der Anwendung auch benachrichtigt werden.

Das PluginManager-Interface

Das Interface für den Pluginmanager bildet die Schnittstelle vom Plugin zur Anwendung. Hier werden alle Methoden aufgeführt die das Plugin aufrufen darf.

package net.byte_welt.wiki;
public interface PluginManager{
  public void openWindow(String msg);
}

Unser Plugin-Manager erlaubt nur das Öffnen eines Fensters mit einem String als Nachricht.

Implementierungen

Durch die Interfaces muss für die Entwicklung des Plugins nur die Class- oder Java-Dateien weiter gegeben werden, die Implementierungen des PluginManagers dagegen nicht.

Hello-Plugin

Unser Plugin soll beim Aufruf der hello()-Methode nur ein Fenster öffnen und dort Hallo ausgeben, daher fällt die Implementierung sehr einfach aus. Die start()- und stop()-Methoden werden garnicht benötigt, würde der Text aus einer Datenbank oder Datei gelesen werden könnte dies in der start-Methode erledigt werden

package net.byte_welt.wiki;
public class HelloPlugin implements PluginInterface{
  private PluginManager manager;
  public boolean start(){
    System.out.println("ich starte");
    return true;
  }
  public boolean stop(){
    System.out.println("ich stoppe");
    return true;
  }
  public void setPluginManager(PluginManager manager){
    this.manager = manager;
  }
  public void hello(){
    manager.openWindow("hallo");
  }
}

PluginManager

Der Plugin-Manager kann für zwei Aufgaben verwendet werden. Er kann dem Plugin übergeben werden und zusätzlich kann er die Kontrolle der Plugins übernehmen. Unser Pluginmanager übernimmt beide Aufgaben, daher implementiert er das PluginManager-Interface. Zusätzlich werden die Methoden loadPlugin, start und stop implementiert.

package net.byte_welt.wiki;
import java.io.*;
import java.util.jar.*;
import java.net.*;

public class PluginManagerImpl implements PluginManager{

  private List<PluginInterface> loadedplugins = new ArrayLIst<>();

  public void start(){
  //..
  }
  public void stop(){
  //..
  }
  public void loadPlugin(File file){
  //..
  }
  public void openWindow(String msg){
  //..
  }
}

Start-Methode

Die start-Methode wird aufgerufen, wenn die Anwendung gestartet wird und alle vorhandenen Plugins geladen werden sollen. Die Pfade zu den vorhandenen Plugins lassen sich z.B. extra speichern, oder es wird gesagt, alles was im Ordner plugins liegt gilt als Plugin. In unserem Fall wird gesagt, was im Ordner plugins liegt wird geladen, dafür wird nur die loadPlugin-Methode aufgerufen.

public void start(){
  File[] files = new File("plugins").listFiles();
  for(File f : files)
    loadPlugin(f);
  for(PluginInterface pi : loadedplugins)
    pi.start();
}

Sind alle Plugins geladen, werden sie gestartet.

Stop-Methode

Mit der stop-Methode wird den Plugins signalisiert, dass sie herunterfahren sollen. Dies ist der Fall, wenn z.B. das Programm beendet wird.

public void stop(){
  for(PluginInterface pi : loadedplugins)
    pi.stop();
}

LoadPlugin-Methode

Um Plugins zu laden, gibt es zwei Ansätze. Zum einen gibt es die Möglichkeit Class-Dateien aber auch JAR-Dateien zu laden.

JAR-Dateien laden

Um ein Plugin aus einer JAR-Datei zu laden, muss deren Pfad und die Main-Class bekannt sein. Im Gegensatz zu einer normalen Anwendung ist die Main-Class bei einem Plugin die Klasse, die das Interface für die Plugin-Schnittstelle implementiert. Es ist aber auch möglich, alle Klassen der JAR zu durchlaufen.

//Erzeugen des JAR-Objekts durch die Eingabe der eingelesenen File in file
JarFile file = new JarFile(file);
//Laden der MANIFEST.MF
Manifest manifest = file.getManifest();
// auslesen der Attribute aus der Manifest
Attributes attrib = manifest.getMainAttributes();
// holen der Mainclass aus den Attributen
String main = attrib.getValue(Attributes.Name.MAIN_CLASS);

Aus dem Manifest-Objekt lassen sich jetzt beliebige Daten auslesen, jedoch werden hier nur die Informationen über die Main-Class benötigt. Mit diesen Daten lässt sich jetzt das Plugin laden, dazu wird ein neuer ClassLoader erzeugt.

//Festlegen wo das PluginInterface liegt
String PLUGININTERFACECLASS_STRING = "net.byte_welt.wiki.PluginInterface";
// Laden der Datei und Konvertierung von einer Datei, zu einer URI und dann zu einer URL
URL urlFile = file.toURI().toURL();
// Laden der Klasse durch den URLClassLoader
URLClassLoader classLoader = new URLClassLoader(new URL[] { urlFile });
// Class aus dem classLoader holen
Class cl = classLoader.loadClass(main);
// Interfaces aus der Klasse holen, die dort impementiert sind
Class[] interfaces = cl.getInterfaces();
// Durchlaufen durch die Interfaces der Klasse und nachsehen ob es das passende Plugin implementiert
boolean isplugin = false;
for(int y = 0; y < interfaces.length && !isplugin; y++)
  if(interfaces[y].getName().equals(PLUGININTERFACECLASS_STRING))
    isplugin = true;
if(isplugin){
  PluginInterface plugin = (PluginInterface) cl.newInstance();
  loadedplugins.add(plugin);
}

//Schließen von JarFile und ClassLoader um Fehler zu vermeiden
//jarFile.close();
classLoader.close();

Anschließend werden die Interfaces der Klasse betrachtet, ob es sich wirklich um ein Plugin handelt. Ist es ein Plugin wird eine neue Instanz erzeugt und diese abgespeichert.

JAR-Dateien laden (Die Methode komplett)

Um ein Plugin aus einer JAR-Datei zu laden, muss deren Pfad und die Main-Class bekannt sein. Im Gegensatz zu einer normalen Anwendung ist die Main-Class bei einem Plugin die Klasse, die das Interface für die Plugin-Schnittstelle implementiert. Es ist aber auch möglich, alle Klassen der JAR zu durchlaufen.

//Festlegen wo das PluginInterface liegt
private static final String PLUGININTERFACECLASS_STRING = "net.byte_welt.wiki.PluginInterface";

		public void loadPlugin(File file) {
		try {
			// Erzeugen des JAR-Objekts durch die Eingabe der eingelesenen File in file
			JarFile jarFile = new JarFile(file);
			// Laden der MANIFEST.MF
			Manifest manifest = jarFile.getManifest();
			// Auslesen der Attribute aus der Manifest-Datei
			Attributes attrib = manifest.getMainAttributes();
			// Mainclass aus den Attributen laden
			String main = attrib.getValue(Attributes.Name.MAIN_CLASS);
			// Laden der Datei und Konvertierung von einer Datei, zu einer URI und dann zu
			// einer URL
			URL urlFile = file.toURI().toURL();
			// Laden der Klasse durch den URLClassLoader
			URLClassLoader classLoader = new URLClassLoader(new URL[] { urlFile });
			// Class aus dem classLoader holen
			Class cl = classLoader.loadClass(main);
			// Interfaces aus der Klasse holen, die dort impementiert sind
			Class[] interfaces = cl.getInterfaces();
			// Durchlaufen durch die Interfaces der Klasse und nachsehen ob es das
			// PluginInterface implementiert und somit ein Plugin ist
			boolean isplugin = false;
			for (int y = 0; y < interfaces.length && !isplugin; y++)
				if (interfaces[y].getName().equals(PLUGININTERFACECLASS_STRING))
					isplugin = true;
			// Wenn es ein Plugin ist, dann lade die Datei bzw. das Plugin
			if (isplugin) {
				PluginInterface plugin = (PluginInterface) cl.newInstance();
			        // Zu den geladenen Plugin hinzufügen
				loadedplugins.add(plugin);
			}
			// Schließen von JarFile und ClassLoader um Fehler zu vermeiden
			jarFile.close();
			classLoader.close();
		} catch (ClassNotFoundException | InstantiationException | IllegalAccessException | IOException e) {
			System.out.println("Plugin konnte nicht geladen werden!");
			e.printStackTrace();
		}
	}
Class-Dateien laden
  • wird nachgeliefert.

OpenWindow-Methode

Die openWindow-Methode ist für die Interaktion mit den Plugins nötig, über diese Methode kann ein Fenster geöffnet werden.

public void openWindow(String msg){
  javax.swing.JOptionPane.showMessageDialog(null, msg);
}

Weblinks