Wiki-Quellcode von Plugin-Entwicklung

Verstecke letzte Bearbeiter

version	line-number	content
1.1	1	{{content/}}
	2
	3	== Plugins für zusätzliche Funktionalitäten ==
	4
	5	{{formcycle/}} bietet ein Vielzahl von Einstiegspunkten für die Erweiterung der Standard-Funktionalitäten durch Plugins. Basierend auf den einzelnen [[Plugin-Typen>>doc:Formcycle.PluginDevelopment.Types.WebHome]] werden diese zu gewissen Zeitpunkten automatisch oder manuell angesprochen und erlauben es somit von der Ersetzung eigener Platzhalter bis hin zur Implementierung eigener Verarbeitungslogik {{formcycle/}} anzupassen. Als fundamentaler erster Schritt für die Entwicklung eigener Plugins ist hierbei das Erstellen eines entsprechenden Java-Projekts anzusehen.
	6
	7	== API-Dokumentation ==
	8
	9	Die API-Dokumentation für {{formcycle/}} findet sich hier auf unserer Seite: [[Javadocs>>https://docs.formcycle.eu/]]
	10
3.5	11	== Maven-Setup ==
1.1	12
3.1	13	Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
1.1	14
3.1	15	Für letzteres empfehlen wir hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/\|\|rel="__blank"]] zum Einsatz. Andere Build-Tools können prinzipiell benutzt werden, hier können wir aber keine Hilfe bereitstellen.
1.1	16
3.5	17	Um die entsprechenden Abhängigkeiten zu {{formcycle case="dat"/}} bereitzustellen, ist das Repository unter der URL [[https:~~/~~/artifactory.xima-services.de/artifactory/fc-plugin-dev>>url:https://artifactory.xima-services.de/artifactory/fc-plugin-dev]] zu benutzen. Dieses enthält alle öffentlich zur Verfügung stehenden Artefakte, welche dem Plugin zur Laufzeit bereitgestellt und während der Entwicklung benötigt werden.
1.1	18
4.2	19	Damit das Repository auch beim Bauen mit Maven verwendet wird, sollte folgendes in die Maven-Konfigurationsdatei //settings.xml// geschrieben werden. Diese Datei findet sich in der Regeln im //.m2//-Ordner im Home-Verzeichnis des aktuellen Nutzers. Unter Linux //~~/.m2/settings.xml// und unter Windows //%homepath%\.m2\settings.xml//:
1.1	20
3.3	21	{{panel title="~~~~/.m2/settings.xml" fullwidth="true" initial="hidden" triggerable="true"}}
3.1	22	{{code language="xml"}}
	23	<?xml version="1.0" encoding="UTF-8"?>
	24	<settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd" xmlns="http://maven.apache.org/SETTINGS/1.1.0"
	25	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
1.1	26
3.1	27	<!-- Add XIMA artifactory -->
	28	<profiles>
	29	<profile>
3.4	30	<!-- FORMCYCLE dependencies -->
3.1	31	<repositories>
	32	<repository>
	33	<snapshots>
	34	<enabled>false</enabled>
	35	</snapshots>
	36	<id>xima</id>
	37	<name>libs-release</name>
	38	<url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
	39	</repository>
	40	</repositories>
3.4	41	<!-- Maven plugins for FORMCYCLE -->
3.1	42	<pluginRepositories>
	43	<pluginRepository>
	44	<snapshots>
	45	<enabled>false</enabled>
	46	</snapshots>
	47	<id>xima</id>
	48	<name>plugins-release</name>
	49	<url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
	50	</pluginRepository>
	51	</pluginRepositories>
	52	<id>xima-artifactory</id>
	53	</profile>
	54	</profiles>
1.1	55
3.1	56	<!-- Enable XIMA artifactory by default -->
	57	<activeProfiles>
	58	<activeProfile>xima-artifactory</activeProfile>
	59	</activeProfiles>
1.1	60
3.1	61	<!-- FORMCYCLE specific Maven plugins provided by XIMA -->
	62	<pluginGroups>
	63	<pluginGroup>de.xima.fc.maven.plugin</pluginGroup>
	64	</pluginGroups>
	65	</settings>
	66	{{/code}}
	67	{{/panel}}
1.1	68
3.8	69	== Maven-Projekteinrichtung
1.1	70
3.13	71	Im Folgenden werden einige Punkte beschrieben, die beim Einrichten eines Maven-Projekts für ein {{formcycle/}}-Plugin beachtet werden müssen. Für den schnellen Einstieg gibt auch einige [[Maven-Archetypes>>\|\|anchor="HMaven-Archetypes"]].
3.8	72
3.5	73	=== Artekfakte und Abhängigkeiten
	74
	75	{{info}}
	76	Alle Abhängigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren!
	77	{{/info}}
	78
	79	Ausgangspunkt für die Entwicklung von Plugin ist das Maven-Artefakt //fc-plugin-common//. Dieses enthält die einzelnen Plugin-Schnittstellen und steht auch auf [[unserere Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]].
	80
	81	In der //pom.xml// des Plugin-Projekts kann diese Abhängigkeit wie folgt eingebunden werden:
	82
3.1	83	{{code language="xml"}}
	84	<properties>
	85	<xfc.version>7.0.10</xfc.version>
	86	</properties>
1.1	87
3.1	88	<dependencies>
	89	<dependency>
	90	<groupId>de.xima.fc</groupId>
	91	<artifactId>fc-plugin-common</artifactId>
	92	<version>${xfc.version}</version>
	93	<scope>provided</scope>
	94	</dependency>
	95	</dependencies>
1.1	96	{{/code}}
	97
	98	Ferner steht je nach Tiefe der Integration in die bestehende Umgebung von {{formcycle case="dat"/}} und dessen Benutzung als höchste Implementierung das Artefakt //fc-logic// zur Verfügung. Dieses wird wie folgt als weitere (oder einzige) Abhängigkeit definiert:
	99
	100	{{code language="xml"}}
	101	<dependency>
	102	<groupId>de.xima.fc</groupId>
	103	<artifactId>fc-logic</artifactId>
	104	<version>${xfc.version}</version>
	105	<scope>provided</scope>
	106	</dependency>
	107	{{/code}}
	108
	109	Eine entsprechende Benutzung ist vor allem bei der Verwendung der Datenbankschnittstelle sowie bei der Implementierung von eigenen Verarbeitungen nötig. Eine Vorlage für ein somit entstehendes Project Object Model finden Sie [[hier>>attach:pom.xml\|\|rel="__blank"]].
	110
	111	Ferner ist zu beachten, dass sämtliche Abhängigkeiten zu {{formcycle case="dat"/}} im scope //provided //anzugeben sind. Dies verhindert neben Classpath-Problemen auch das unnötige Anschwellen der Plugin-Größe. Ebenso sollten diesbezüglich Abhängigkeiten auf bereits von {{formcycle case="dat"/}} benutzten und damit bereitstehenden Bibliotheken wiederverwendet werden (z.B. diverse Apache Commons-Implementierungen).
	112
3.5	113	=== Manifest und Fat JAR
1.1	114
3.5	115	In der //META-INF/MANIFEST.MF// in der Plugin-JAR-Datei sollten folgende Informationen stehen:
1.1	116
3.5	117	; formcycle-version-requirement
	118	: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist.Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
	119	; Implementation-Version
	120	: Erforderlich. Version des Plugins, wird etwa in der Oberfläche angezeigt.
	121	; Build-Time oder Build-Timestamp
	122	: Optional, wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
	123	; Implementation-Title
	124	: Optional, wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
1.1	125
3.5	126	Diese Informationen können wie unten beschrieben mittels des //maven-assembly-plugin// in die Manifest-Datei geschrieben werden.
	127
	128	Weiterhin ist beim Bauen zu beachten, dass eine sogenannte Fat-JAR gebaut werden muss. Abhängigkeiten zu {{formcycle case="dat"/}} sowie anderen Bibliotheken, welche bereits durch {{formcycle case="acc"/}} mitgeliefert werden, sollten wie bereits erwähnt im scope //provided// eingebunden werden. Falls im Plugin aber noch andere Abhängigkeiten benutzt werden, müssen diese in der JAR-Datei inkludiert werden (Fat JAR).
	129
	130	Dies kann entweder über das [[maven-assembly-plugin>>url:https://maven.apache.org/plugins/maven-assembly-plugin/]] oder das [[maven-shade-plugin>>url:https://maven.apache.org/plugins/maven-shade-plugin/]] erfolgen. Letzteres ist für forgeschrittene Anwendungsfälle gedacht, wenn etwa mehrere Abhängigkeiten die gleichen Dateien mitbringen und zusammengeführt werden müssen.
	131
	132	Für einfache Plugins ist das //maven-assembly-plugin// ausreichend. Dieses kann in der //pom.xml// wie folgt konfiguriert werden:
	133
3.6	134	{{panel title="maven-assembly-plugin in pom.xml" fullwidth="true" initial="hidden" triggerable="true"}}
3.5	135	{{code language="java"}}
	136	<properties>
	137	<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
	138	</properties>
	139	<build>
	140	<finalName>${project.parent.artifactId}</finalName>
	141	<plugins>
	142	<plugin>
	143	<groupId>org.apache.maven.plugins</groupId>
	144	<artifactId>maven-assembly-plugin</artifactId>
	145	<version>${maven-assembly-plugin.version}</version>
	146	<executions>
	147	<execution>
	148	<id>fat-jar</id>
	149	<phase>package</phase>
	150	<goals>
	151	<goal>single</goal>
	152	</goals>
	153	<configuration>
	154	<finalName>${project.parent.artifactId}</finalName>
	155	<appendAssemblyId>false</appendAssemblyId>
	156	<descriptorRefs>
	157	<descriptorRef>jar-with-dependencies</descriptorRef>
	158	</descriptorRefs>
	159	<archive>
	160	<manifest>
	161	<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
	162	</manifest>
	163	<manifestEntries>
	164	<formcycle-version-requirement>${xfc-version}</formcycle-version-requirement>
	165	<Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
	166	<Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
	167	<Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
	168	<Implementation-Version>${project.version}</Implementation-Version>
	169	</manifestEntries>
	170	</archive>
	171	</configuration>
	172	</execution>
	173	</executions>
	174	</plugin>
	175	</plugins>
	176	</build>
	177	{{/code}}
3.6	178	{{/panel}}
3.5	179
	180	=== Bauen und Installieren ===
	181
	182	Der genaue Befehl zum Bauen hängt von den konkreten Einstellungen in der //pom.xml// ab. In der Regel sollte aber folgender Standardbefehl im Plugin-Verzeichnis funktionieren:
	183
	184	{{code}}
	185	mvn clean install
	186	{{/code}}
	187
3.15	188	Nachdem das Plugin erfolgreich gebaut wurde, kann die so entstandene JAR-Datei im //target//-Verzeichnis in {{formcycle/}} über die Oberfläche [[Mandant-Plugins>>doc:Formcycle.UserInterface.Client.Plugins]] beziehungsweise [[System-Plugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]] hochgeladen werden.
3.5	189
3.14	190	Siehe [[Deploy-Plugin>>\|\|anchor="HDeploy-Plugin"]] zum automatischen Hochladen beim Maven-Build.
3.5	191
3.14	192	Siehe [[FC-Server-Plugin>>\|\|anchor="HFC-Server-Plugin"]] zum Starten eines einfachen {{formcycle/}}-Servers.
3.5	193
	194	== Maven-Archetypes ==
	195
4.3	196	{{figure image="eclipse-archetype.png" width="500"}}
4.11	197	Hinzufügen des Archetypes-Katalogs in Eclipse
4.2	198	{{/figure}}
3.1	199
4.7	200	Für einige häufig verwendete Plugin-Typen stehen [[Maven-Archetypes>>url:https://maven.apache.org/guides/introduction/introduction-to-archetypes.html]] bereits, um schnell ein Maven-Projekt aufsetzen zu können.
4.2	201
	202	Voraussetzung für die Verwendung ist, dass in den //~~/.m2/settings.xml// wie oben beschrieben das XIMA-Artifactory eingerichtet wurde. Dann kann etwa über die Kommandozeile wie folgt eine Archetype generiert werden:
	203
	204	{{code}}
	205	mvn archetype:generate -DarchetypeArtifactId=plugin-archetype-workflow-element-simple -DarchetypeGroupId=de.xima.fc.archetype -DarchetypeVersion=7.0.4
	206	{{/code}}
	207
	208	Es werden dann einige wenige Informationen wie die gewünschten Maven-Koordinaten des neuen Plugin-Projekts abgefragt und anschließend ein neues vorkonfiguriertes Projekt erstellt.
	209
4.7	210	Alle vorhandenen Archetypes und deren Versionen können im [[Archetype-Katalog>>url:https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml]] eingesehen werden.
4.2	211
4.14	212	In Eclipse kann der Archetype-Katalog in den Einstellungen hinzugefügt werden. Bei der Erstellung eines neuen Maven-Projekt werden dann alle verfügbaren Archetypes angezeigt:
4.2	213
4.14	214	{{code language="plaintext"}}https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml{{/code}}
	215
3.5	216	== Deploy-Plugin
	217
	218	TODO
	219
	220	== FC-Server-Plugin
	221
	222	TODO
	223
	224