#205: org.projectforge.plugins.core.AbstractPlugin (ServiceLoader)

Architektur

Inhalt

org.projectforge.plugins.ihk.IHKPlugin

Diese Datei befindet sich unter dem standardmäßigen Java ServiceLoader-Pfad META-INF/services/{vollqualifizierter-Schnittstellenname}. Wenn der Plugin-Scanner von ProjectForge ServiceLoader.load(AbstractPlugin.class) aufruft, liest die JVM alle derartigen Dateien aus dem Klassenpfad, instanziiert jede aufgeführte Klasse und ruft initialize() für jede Plugin-Instanz auf.

Plugin-Erkennungsablauf

1. Der Spring-Anwendungskontext wird gestartet.
2. PFPluginService (oder ein gleichwertiger Plugin-Scanner) ruft ServiceLoader.load(AbstractPlugin.class) auf.
3. Die JVM findet META-INF/services/org.projectforge.plugins.core.AbstractPlugin in jedem Plugin-JAR oder Klassenpfadeintrag.
4. Für jeden vollqualifizierten Klassennamen in diesen Dateien wird die Klasse geladen und über ihren parameterlosen Konstruktor instanziiert.
5. Der Basisklassenkonstruktor von AbstractPlugin registriert die Metadaten des Plugins (ID, Name, Beschreibung).
6. Der Plugin-Scanner ruft initialize() auf, wo IHKPlugin seine DAO-, Web-, Menü-, Rechte- und i18n-Registrierungen durchführt.

Entwurfsentscheidungen

• Standard Java SPI: ProjectForge verwendet java.util.ServiceLoader anstelle von Springs @Component-Scanning für die Plugin-Erkennung. Dies ermöglicht das Laden von Plugins aus externen JARs, die in ein Plugin-Verzeichnis gelegt werden, unabhängig von Springs Component-Scan-Base-Packages.
• Eine Datei, eine Klasse: Jedes Plugin stellt genau eine Implementierungsklasse pro Servicedatei bereit. Das IHK-Plugin registriert nur IHKPlugin.
• Getrennt vom Spring-Bean-Scanning: Obwohl IHKPlugin selbst keine Spring-Bean ist, werden die Komponenten, die es verdrahtet (über WicketSupport.get()), von Spring verwaltet. Dieser hybride Ansatz hält den Plugin-Lebenszyklus vom Spring-Kontext-Lebenszyklus getrennt.
• Dient auch als ServiceLoader für Domain-Objekte: Dieses gleiche Dateimuster ist entscheidend für die Erkennung von Hibernate-Domain-Objekten – ohne es würden die persistenten Entitäten des Plugins vom ORM-Scanner nicht gefunden.

Git-Verlauf

50d5d8926 wip: META-INF/services für Plugins benötigt (Service Loader)
07b80966b wip: PFPluginService (PluginConfig) -> PluginInfo
45cad02e9 IHK-Plugin hinzugefügt (wird "Ihk-Export"-Plugin ersetzen)