Änderungen von Dokument Plugin-Entwicklung

Von 5.9 nach 5.8 Von 10.1 nach 9.2

Von Version 9.2

bearbeitet von awa
am 25.02.2022, 22:25

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 5.9

bearbeitet von awa
am 25.02.2022, 13:26

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (1 geändert, 0 hinzugefügt, 0 gelöscht)
- pom.xml

Details

Seiteneigenschaften

Inhalt

@@ -9,9 +9,9 @@
  == Maven-Setup ==
--Zu Beginn der Entwicklung eines Plugins ist es nötig, das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
++Zu Beginn der Entwicklung eines Plugins ist es nötig das entsprechende Entwicklungsprojekt aufzusetzten und zu konfigurieren.
--Für letzteres empfehlen wir hierbei das Build-Management-Tool [[Apache Maven>>url:https://maven.apache.org/||rel="__blank"]] zu verwenden. Andere Build-Tools können prinzipiell auch genutzt werden, hier können wir aber keine Hilfe bereitstellen.
++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.
  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.
@@ -65,20 +65,18 @@
  {{/code}}
  {{/panel}}
--== Maven-Projekteinrichtung ===
++== Maven-Projekteinrichtung
  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"]].
--=== Artekfakte und Abhängigkeiten ===
++=== Artekfakte und Abhängigkeiten
  {{info}}
  Alle Abhängigkeiten zu {{formcycle case="dat"/}} sind im scope "provided" zu definieren!
  {{/info}}
--Eine fertige einfache //pom.xml// können Sie [[hier herunterladen>>attach:pom.xml||rel="__blank"]].
++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||target="_blank"]].
--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 [[unsererer Downloadseite zur Verfügung>>url:http://artifactory.xima-services.de/artifactory/fc-plugin-dev/de/xima/fc/fc-plugin-common||target="_blank"]].
--
  In der //pom.xml// des Plugin-Projekts kann diese Abhängigkeit wie folgt eingebunden werden:
  {{code language="xml"}}
@@ -96,7 +96,7 @@
    </dependencies>
  {{/code}}
--Ferner steht je nach Tiefe der Integration in die bestehende Umgebung von {{formcycle case="dat"/}} und deren Benutzung als höchste Implementierung das Artefakt //fc-logic// zur Verfügung. Dieses wird wie folgt als weitere (oder einzige) Abhängigkeit definiert:
++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:
  {{code language="xml"}}
    <dependency>
@@ -107,22 +107,22 @@
    </dependency>
  {{/code}}
--Eine entsprechende Benutzung ist vor allem bei der Verwendung der Datenbankschnittstelle sowie bei der Implementierung von eigenen Verarbeitungen nötig.
++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"]].
  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).
--=== Manifest und Fat JAR ===
++=== Manifest und Fat JAR
  In der //META-INF/MANIFEST.MF// in der Plugin-JAR-Datei sollten folgende Informationen stehen:
  ; formcycle-version-requirement
--: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist. Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
++: Erforderlich. Version von {{formcycle/}}, für die das Plugin gedacht ist.Ist erforderlich, damit {{formcycle/}} bei der Installation die Kompatibilität prüfen kann.
  ; Implementation-Version
--: Erforderlich. Version des Plugins; Diese wird z.B. in der Oberfläche angezeigt.
++: Erforderlich. Version des Plugins, wird etwa in der Oberfläche angezeigt.
  ; Build-Time oder Build-Timestamp
--: Optional. Wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
++: Optional, wird bei SNAPSHOT-Versionen mit angezeigt, um den SNAPSHOT zu identifizieren.
  ; Implementation-Title
--: Optional. Wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
++: Optional, wird standardmäßig etwa vom Deploy-Plugin verwendet, um das Plugin zu identifzieren.
  Diese Informationen können wie unten beschrieben mittels des //maven-assembly-plugin// in die Manifest-Datei geschrieben werden.
@@ -138,7 +138,7 @@
      <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
    </properties>
    <build>
--    <finalName>${project.artifactId}</finalName>
++    <finalName>${project.parent.artifactId}</finalName>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
@@ -152,7 +152,7 @@
                <goal>single</goal>
              </goals>
              <configuration>
--              <finalName>${project.artifactId}</finalName>
++              <finalName>${project.parent.artifactId}</finalName>
                <appendAssemblyId>false</appendAssemblyId>
                <descriptorRefs>
                  <descriptorRef>jar-with-dependencies</descriptorRef>
@@ -218,7 +218,7 @@
  {{code language="plaintext"}}https://artifactory.xima-services.de/artifactory/libs-release-local/archetype-catalog.xml{{/code}}
--== Deploy-Plugin ==
++== Deploy-Plugin
  Um beim Entwickeln nicht jedes Mal eine neue Plugin-Version manuell über die Oberfläche hochladen zu müssen, kann das Deploy-Plugin verwendet werden. Dieses besteht aus 2 Teilen:
@@ -239,7 +239,7 @@
          <executions>
            <execution>
              <id>upload</id>
--            <phase>package</phase>
++            <phase>install</phase>
              <goals>
                <goal>deploy</goal>
              </goals>
@@ -253,7 +253,7 @@
  Sofern das Deploy-Plugin bereits in {{formcycle/}} installiert ist, kann das Plugin-Projekt dann beim Bauen wie folgt hochgeladen werden:
  {{code language="bash"}}
--mvn package -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
++mvn clean install -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin
  {{/code}}
  Wird Eclipse benutzt, kann auch eine Launch-Configuration mit den //fcDeployUrl// und dem //fcDeployToken// angelegt werden.
@@ -265,10 +265,10 @@
  Sofern wie oben beschrieben in //~~/.m2/settings.xml// die //pluginGroup// hinterlegt wurde, kann in einem beliebiegen Verzeichnis wie folgt ein {{formcycle/}}-Server per Maven gestartet werden:
  {{code language="bash"}}
--mvn package fc-server:run-ms-war -DxfcVersion=7.0.10
++mvn fc-server:run-ms-war -DxfcVersion=7.0.10
  {{/code}}
--Nach kurzer Wartezeit (beim ersten Mal kann es länger dauern) ist dann ein {{formcycle/}}-Server gestartet. Die URL steht am Ende in der Kommandozeile, standardmäßig http://localhost:8080/xima-formcycle Der Zugang für den Superadmin ist {{code language="plaintext"}}sadmin{{/code}} (Passwort {{code language="plaintext"}}admin{{/code}}), der Zugang für den Mandantadministrator {{code language="plaintext"}}admin{{/code}} (Passwort {{code language="plaintext"}}/admin_{{/code}}).
++Nach kurzer Wartezeit (beim ersten Mal kann es länger dauern) ist dann ein {{formcycle/}}-Server gestartet. Die URL steht am Ende in der Kommandozeile, standardmäßig http://localhost:8080/xima-formcycle
  Dies funktioniert auch in einem Ordner ohne Maven-Projekt. Falls keine {{formcycle/}} angegeben ist, wird eine Standard-Version genommen. Wird der Befehl innerhalb eines Plugin-Maven-Projekts ausgeführt, wird versucht, die Version von {{formcycle/}} aus dem Plugin-Projekt auszulesen.

pom.xml

Author

@@ -1,1 +1,1 @@
--XWiki.awa
++XWiki.rth

Größe

@@ -1,1 +1,1 @@
--5.9 KB
++2.2 KB

Inhalt

@@ -2,98 +2,55 @@
  	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  	<modelVersion>4.0.0</modelVersion>
--	<!-- MUST BE FILLED IN -->
  	<groupId></groupId>
  	<artifactId></artifactId>
  	<version></version>
--	<name></name>
--
  	<packaging>jar</packaging>
++	<name></name>
++
  	<properties>
  		<!-- Configuration -->
  		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  		<!-- Dependencies -->
--		<xfc.version>7.0.10</xfc.version>
--		<junit-jupiter.version>5.6.0</junit-jupiter.version>
++		<xfc-version>7.0.9</xfc-version>
  		<!-- Plugins -->
--		<maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
--		<maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
--		<maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
--		<maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version>
--		<fc-deploy-plugin-maven-plugin.version>7.0.1</fc-deploy-plugin-maven-plugin.version>
--		<fc-server-maven-plugin.version>7.0.1</fc-server-maven-plugin.version>
++		<maven-compiler-plugin-version>3.8.1</maven-compiler-plugin-version>
++		<maven-jar-plugin-version>3.1.0</maven-jar-plugin-version>
  	</properties>
++	<repositories>
++		<repository>
++			<id>xima</id>
++			<name>fc-plugin-dev</name>
++			<url>http://artifactory.xima-services.de/artifactory/fc-plugin-dev</url>
++		</repository>
++	</repositories>
++
  	<dependencies>
--		<!-- Reference FORMCYCLE libraries. The plugin is installed in a running -->
--		<!-- FORMCYCLE system, , so you do not need to include the FORMCYCLE libraries -->
--		<!-- in the plugin JAR. This is done by setting the scope to "provided" -->
  		<dependency>
  			<groupId>de.xima.fc</groupId>
--			<artifactId>fc-logic</artifactId>
--			<version>${xfc.version}</version>
++			<artifactId>fc-plugin-common</artifactId>
++			<version>${xfc-version}</version>
  			<scope>provided</scope>
  		</dependency>
--		<!-- JUnit for writing unit tests -->
  		<dependency>
--			<groupId>org.junit.jupiter</groupId>
--			<artifactId>junit-jupiter</artifactId>
--			<version>${junit-jupiter.version}</version>
--			<scope>test</scope>
++			<groupId>de.xima.fc</groupId>
++			<artifactId>fc-logic</artifactId>
++			<version>${xfc-version}</version>
++			<scope>provided</scope>
  		</dependency>
--
--		<!-- You can add additional dependencies here. -->
--		<!-- Some common libraries as apache-commons and guava are provided by -->
--		<!-- FORMCYCLE and can be set to scope=provided. -->
--
  	</dependencies>
  	<build>
--		<finalName>${project.artifactId}</finalName>
--
  		<plugins>
--
--			<!-- Upload the plugin to a running FORMCYCLE server as part of the Maven build process -->
--			<!-- mvn clean install -DfcDeployUrl=http://localhost:8080/xima-formcycle -DfcDeployToken=admin -->
  			<plugin>
--				<groupId>de.xima.fc.maven.plugin</groupId>
--				<artifactId>fc-deploy-plugin-maven-plugin</artifactId>
--				<version>${fc-deploy-plugin-maven-plugin.version}</version>
--				<executions>
--					<execution>
--						<id>upload</id>
--						<phase>package</phase>
--						<goals>
--							<goal>deploy</goal>
--						</goals>
--					</execution>
--				</executions>
--			</plugin>
--
--			<!-- Start a preconfigured FORMCYCLE server-->
--			<!-- mvn fc-server:run-ms-war -->
--			<plugin>
--				<groupId>de.xima.fc.maven.plugin</groupId>
--				<artifactId>fc-server-maven-plugin</artifactId>
--				<version>${fc-server-maven-plugin.version}</version>
--				<configuration>
--					<bootstrap>
--						<pluginManagement>
--							<deployMavenProject>true</deployMavenProject>
--						</pluginManagement>
--					</bootstrap>
--				</configuration>
--			</plugin>
--
--			<!-- Configure the compilation process. At least Java 11 is required. -->
--			<plugin>
  				<groupId>org.apache.maven.plugins</groupId>
  				<artifactId>maven-compiler-plugin</artifactId>
--				<version>${maven-compiler-plugin.version}</version>
++				<version>${maven-compiler-plugin-version}</version>
  				<configuration>
  					<release>11</release>
  					<encoding>UTF-8</encoding>
@@ -102,11 +102,10 @@
  				</configuration>
  			</plugin>
--			<!-- Configure how the JAR is created, including manifest entries -->
  			<plugin>
  				<groupId>org.apache.maven.plugins</groupId>
  				<artifactId>maven-jar-plugin</artifactId>
--				<version>${maven-jar-plugin.version}</version>
++				<version>${maven-jar-plugin-version}</version>
  				<configuration>
  					<archive>
  						<manifest>
@@ -113,58 +113,11 @@
  							<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
  						</manifest>
  						<manifestEntries>
--							<formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
--							<Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
--							<Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
--							<Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
--							<Implementation-Version>${project.version}</Implementation-Version>
++							<formcycle-version-requirement>${xfc-version}</formcycle-version-requirement>
  						</manifestEntries>
  					</archive>
  				</configuration>
  			</plugin>
--
--			<!-- Build a fat JAR with all dependencies included -->
--			<plugin>
--				<groupId>org.apache.maven.plugins</groupId>
--				<artifactId>maven-assembly-plugin</artifactId>
--				<version>${maven-assembly-plugin.version}</version>
--				<executions>
--					<execution>
--						<id>fat-jar</id>
--						<phase>package</phase>
--						<goals>
--						<goal>single</goal>
--						</goals>
--						<configuration>
--							<finalName>${project.artifactId}</finalName>
--							<appendAssemblyId>false</appendAssemblyId>
--							<descriptorRefs>
--								<descriptorRef>jar-with-dependencies</descriptorRef>
--							</descriptorRefs>
--							<archive>
--								<manifest>
--									<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
--								</manifest>
--								<manifestEntries>
--									<formcycle-version-requirement>${xfc.version}</formcycle-version-requirement>
--									<Build-Timestamp>${maven.build.timestamp}</Build-Timestamp>
--									<Implementation-Title>${project.groupId}:${project.artifactId}</Implementation-Title>
--									<Implementation-Vendor-Id>${project.groupId}</Implementation-Vendor-Id>
--									<Implementation-Version>${project.version}</Implementation-Version>
--								</manifestEntries>
--							</archive>
--						</configuration>
--					</execution>
--				</executions>
--			</plugin>
--
--			<!-- Use JUnit to run test classes -->
--			<plugin>
--				<groupId>org.apache.maven.plugins</groupId>
--				<artifactId>maven-surefire-plugin</artifactId>
--				<version>${maven-surefire-plugin.version}</version>
--			</plugin>
  		</plugins>
  	</build>
  </project>
--