Änderungen von Dokument Plugin-Entwicklung

Von Version 3.4
bearbeitet von awa
am 25.02.2022, 11:40
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 2.1
bearbeitet von rth
am 14.02.2022, 17:25
Änderungskommentar: Neuen Anhang pom.xml hochladen

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.awa
1 +XWiki.rth
Inhalt
... ... @@ -10,82 +10,84 @@
10 10  
11 11  == Projekt-Setup ==
12 12  
13 -Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
13 +Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren. Für letzteres kommt hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zum Einsatz. Um die entsprechenden Abhängigkeiten zu {{formcycle case="dat"/}} bereitzustellen ist ein 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 beinhaltet alle öffentlich zur Verfügung stehenden Artefakte welche dem Plugin zur Laufzeit bereitgestellt und während der Entwicklung benötigt werden. Augangspunkt ist hierbei das Artefakt //fc-plugin-common//, welches die einzelnen Plugin-Schnittstellen beinhaltet und auch auf [[unserere Downloadseite zur Verfügung steht>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]]. Ein Auszug des Project Object Models (pom.xml) sieht dem entsprechend beispielhaft wie folgt aus:
14 14  
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.
15 +{{panel title="Beispiel für pom.xml" fullwidth="true" initial="hidden" triggerable="true"}}
16 +{{code language="xml"}}
17 +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
18 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
16 16  
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. Ausgangspunkt ist hierbei das Artefakt //fc-plugin-common//, welches die einzelnen Plugin-Schnittstellen beinhaltet und auch auf [[unserere Downloadseite zur Verfügung steht>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common/]].
20 +...
18 18  
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//:
22 + <properties>
23 + <!-- Configuration -->
24 + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
20 20  
21 -{{panel title="~~~~/.m2/settings.xml" fullwidth="true" initial="hidden" triggerable="true"}}
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">
26 + <!-- Dependencies -->
27 + <xfc.version>7.0.9</xfc.version>
26 26  
27 - <!-- Add XIMA artifactory -->
28 - <profiles>
29 - <profile>
30 - <!-- FORMCYCLE dependencies -->
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>
41 - <!-- Maven plugins for FORMCYCLE -->
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>
29 + <!-- Plugins -->
30 + <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
31 + <maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
32 + </properties>
55 55  
56 - <!-- Enable XIMA artifactory by default -->
57 - <activeProfiles>
58 - <activeProfile>xima-artifactory</activeProfile>
59 - </activeProfiles>
34 + <repositories>
35 + <repository>
36 + <id>xima</id>
37 + <name>fc-plugin-dev</name>
38 + <url>https://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
39 + </repository>
40 + </repositories>
60 60  
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}}
42 + <dependencies>
43 + <dependency>
44 + <groupId>de.xima.fc</groupId>
45 + <artifactId>fc-plugin-common</artifactId>
46 + <version>${xfc.version}</version>
47 + <scope>provided</scope>
48 + </dependency>
49 + </dependencies>
68 68  
69 -In der //pom.xml// des Plugin-Projekts kann die Abhängigkeit dann wie folgt eingebunden werden:
51 + <build>
52 + <plugins>
53 + <plugin>
54 + <groupId>org.apache.maven.plugins</groupId>
55 + <artifactId>maven-compiler-plugin</artifactId>
56 + <version>${maven-compiler-plugin.version}</version>
57 + <configuration>
58 + <release>11</release>
59 + <encoding>UTF-8</encoding>
60 + </configuration>
61 + </plugin>
70 70  
71 -{{code language="xml"}}
72 - <properties>
73 - <xfc.version>7.0.10</xfc.version>
74 - </properties>
63 + <plugin>
64 + <groupId>org.apache.maven.plugins</groupId>
65 + <artifactId>maven-jar-plugin</artifactId>
66 + <version>${maven-jar-plugin.version}</version>
67 + <configuration>
68 + <archive>
69 + <manifest>
70 + <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
71 + </manifest>
72 + <manifestEntries>
73 + <formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
74 + <Build-Time>${maven.build.timestamp}</Build-Time>
75 + </manifestEntries>
76 + </archive>
77 + </configuration>
78 + </plugin>
75 75  
76 - <dependencies>
77 - <dependency>
78 - <groupId>de.xima.fc</groupId>
79 - <artifactId>fc-plugin-common</artifactId>
80 - <version>${xfc.version}</version>
81 - <scope>provided</scope>
82 - </dependency>
83 - </dependencies>
80 + </plugins>
81 + </build>
82 +</project>
83 +
84 84  {{/code}}
85 +{{/panel}}
85 85  
86 86  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:
87 87  
88 88  {{code language="xml"}}
90 +...
89 89   <dependency>
90 90   <groupId>de.xima.fc</groupId>
91 91   <artifactId>fc-logic</artifactId>
... ... @@ -92,6 +92,7 @@
92 92   <version>${xfc.version}</version>
93 93   <scope>provided</scope>
94 94   </dependency>
97 +...
95 95  {{/code}}
96 96  
97 97  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"]].
... ... @@ -104,8 +104,6 @@
104 104  
105 105  Basierend auf der hiermit zur Verfügung stehenden Infrastruktur steht der Entwicklung von eigenen Plugin-Implementierungen nichts mehr im Wege. Die Installation erfolgt anschließend je nach Verwendungszweck über die Oberflächen [[Mandant-Plugins>>doc:Formcycle.UserInterface.Client.Plugins]] oder [[System-Plugins>>doc:Formcycle.SystemSettings.UserInterface.SystemPlugins]].
106 106  
107 -== Archetypes ==
110 +== Demo-Plugins ==
108 108  
109 -TODO
110 -
111 -Um einen besseren Einstieg in die Plugin-Entwicklung zu finden, [[bieten wir auf unserer Downloadseite>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]]
112 +Um einen besseren Einstieg in die Plugin-Entwicklung zu finden, [[bieten wir auf unserer Downloadseite>>url:https://customer.formcycle.eu/index.php/s/PgdMrNOvbYEzhmr]] auch für jeden Plugintyp ein kommentiertes Demo-Maven-Projekt an. Sie können diese herunterladen und in der Entwicklungsumgebung ihrer Wahl einsehen und kompilieren.