Systemanforderungen
Entwicklungsumgebung
Für die Entwicklung von FirstSpirit-Modulen sind in erster Linie ein Java Development Kit (JDK) und – optional, aber dringend empfohlen – eine integrierte Entwicklungsumgebung (IDE) notwendig. Build-Tools ermöglichen zusätzlich das unkomplizierte Erstellen von Artefakten und bieten eine einfache Möglichkeit, Abhängigkeiten zu weiteren Bibliotheken zu verwalten. Auch wenn die Verwendung von Apache Maven möglich ist, empfiehlt Crownpeak den Einsatz von Gradle.
Informationen über unterstütze JDK-Versionen finden Sie in den Systemanforderungen für FirstSpirit-Server im Abschnitt Technische Voraussetzungen und Empfehlungen (→Dokumentation für Administratoren).
FirstSpirit API
Die FirstSpirit Access API stellt die Schnittstelle zwischen dem selbst entwickelten Code und FirstSpirit bereit. Hierfür ist die Einbindung eines einzelnen Artefakts notwendig.
dependencies {
compileOnly(group = "de.espirit.firstspirit", name = "fs-isolated-runtime", version = "5.2.250311")
}Die gewählte Version sollte möglichst der Server-Version entsprechen, auf dem der Code später ausgeführt wird. Das Artefakt wird von FirstSpirit automatisch in der passenden Version eingebunden und darf daher nicht als Teil eines FSM ausgeliefert werden.
Das oben genannte Artefakt ist nicht über öffentliche Repositorys wie MavenCentral verfügbar, daher ist es zwingend erforderlich, ein zusätzliches Repository im Build-Tool zu konfigurieren. Kunden und Partner mit einem Zugang zum Cloud-Artifactory können dieses direkt nutzen, neue Versionen werden hier automatisch bereitgestellt. Für die Entwicklung ohne diesen Zugang ist das entsprechende Jar im Download-Verzeichnis des FirstSpirit-Releases verfügbar und kann in ein eigenes, lokales Repository übernommen werden.
Bitte beachten Sie, dass das Jar nicht ausschließlich API-Klassen enthält. Elemente, die nicht Teil der stabilen API sind, sind mit @ApiStatus.Internal annotiert. Im Idealfall warnt die IDE bereits während der Entwicklung, wenn eine entsprechende Klasse oder Methode dennoch verwendet wird. Dies sollte auf jeden Fall vermieden werden, da sich die interne Struktur jederzeit ohne Ankündigung ändern kann, was im schlimmsten Fall dazu führt, dass das eigene Modul nicht mehr funktioniert.
FirstSpirit Module Gradle Plugin
Das quelloffene FirstSpirit Module Gradle Plugin ermöglicht eine einfache Erstellung von FirstSpirit-Modulen. Es unterstützt beispielsweise bei der Definition von selbst entwickelten Komponenten, prüft auf Wunsch auf die Verwendung von Nicht-API-Elementen und erzeugt anschließend die FSM-Datei. Die README-Datei des Projekts enthält ausführliche Informationen zur Einrichtung des Plugins.
Beispiel-Module
Zwei auf GitHub verfügbare Module zeigen beispielhaft die Umsetzung verschiedener Anforderungen: