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

Architecture

Contenu

org.projectforge.plugins.ihk.IHKPlugin

Ce fichier se trouve au chemin standard Java ServiceLoader META-INF/services/{nom-d-interface-entièrement-qualifié}. Lorsque le scanner de plugins de ProjectForge invoque ServiceLoader.load(AbstractPlugin.class), la JVM lit tous ces fichiers depuis le classpath, instancie chaque classe listée et appelle initialize() sur chaque instance de plugin.

Flux de découverte des plugins

1. Le contexte de l'application Spring démarre.
2. PFPluginService (ou un scanner de plugins équivalent) appelle ServiceLoader.load(AbstractPlugin.class).
3. La JVM trouve META-INF/services/org.projectforge.plugins.core.AbstractPlugin dans chaque JAR de plugin ou entrée de classpath.
4. Pour chaque nom de classe entièrement qualifié dans ces fichiers, la classe est chargée et instanciée via son constructeur sans argument.
5. Le constructeur de la classe de base AbstractPlugin enregistre les métadonnées du plugin (ID, nom, description).
6. Le scanner de plugins appelle initialize(), où IHKPlugin effectue ses enregistrements DAO, web, menu, droits et i18n.

Décisions de conception

• SPI Java standard : ProjectForge utilise java.util.ServiceLoader plutôt que le scan @Component de Spring pour la découverte des plugins. Cela permet de charger les plugins depuis des JARs externes déposés dans un répertoire de plugins, indépendamment des packages de base du scan de composants Spring.
• Un fichier, une classe : Chaque plugin fournit exactement une classe d'implémentation par fichier de service. Le plugin IHK n'enregistre que IHKPlugin.
• Séparé du scan de beans Spring : Bien que IHKPlugin lui-même ne soit pas un bean Spring, les composants qu'il câble (via WicketSupport.get()) sont gérés par Spring. Cette approche hybride maintient le cycle de vie du plugin séparé de celui du contexte Spring.
• Sert également de ServiceLoader pour les objets domaine : Ce même modèle de fichier est essentiel pour la découverte des objets domaine Hibernate — sans lui, les entités persistantes du plugin ne seraient pas trouvées par le scanner ORM.

Historique Git

50d5d8926 wip : META-INF/services nécessaire pour les plugins (chargeur de services)
07b80966b wip : PFPluginService (PluginConfig) -> PluginInfo
45cad02e9 Plugin IHK ajouté (remplacera le plugin "Ihk-Export")