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

Arquitectura

Contenido

org.projectforge.plugins.ihk.IHKPlugin

Este archivo se encuentra en la ruta estándar de Java ServiceLoader META-INF/services/{nombre-completamente-calificado-de-la-interfaz}. Cuando el escáner de plugins de ProjectForge invoca ServiceLoader.load(AbstractPlugin.class), la JVM lee todos estos archivos del classpath, instancia cada clase listada y llama a initialize() en cada instancia de plugin.

Flujo de descubrimiento de plugins

1. Se inicia el contexto de la aplicación Spring.
2. PFPluginService (o el escáner de plugins equivalente) llama a ServiceLoader.load(AbstractPlugin.class).
3. La JVM encuentra META-INF/services/org.projectforge.plugins.core.AbstractPlugin en cada JAR de plugin o entrada de classpath.
4. Para cada nombre de clase completamente calificado en esos archivos, la clase se carga y se instancia mediante su constructor sin argumentos.
5. El constructor de la clase base AbstractPlugin registra los metadatos del plugin (ID, nombre, descripción).
6. El escáner de plugins llama a initialize(), donde IHKPlugin realiza sus registros de DAO, web, menú, derechos e i18n.

Decisiones de diseño

• SPI estándar de Java: ProjectForge utiliza java.util.ServiceLoader en lugar del escaneo de @Component de Spring para el descubrimiento de plugins. Esto permite cargar plugins desde JARs externos colocados en un directorio de plugins, independientemente de los paquetes base de escaneo de componentes de Spring.
• Un archivo, una clase: Cada plugin proporciona exactamente una clase de implementación por archivo de servicio. El plugin IHK registra únicamente IHKPlugin.
• Separado del escaneo de beans de Spring: Aunque IHKPlugin en sí mismo no es un bean de Spring, los componentes que conecta (a través de WicketSupport.get()) son gestionados por Spring. Este enfoque híbrido mantiene el ciclo de vida del plugin separado del ciclo de vida del contexto de Spring.
• También sirve como ServiceLoader para objetos de dominio: Este mismo patrón de archivo es crítico para el descubrimiento de objetos de dominio de Hibernate; sin él, las entidades persistentes del plugin no serían encontradas por el escáner ORM.

Historial de Git

50d5d8926 wip: META-INF/services necesarios para plugins (Service loader)
07b80966b wip: PFPluginService (PluginConfig) -> PluginInfo
45cad02e9 Plugin IHK añadido (Reemplazará el plugin "Ihk-Export")