Struktur von AEM-Projekten

In diesem Artikel werden die Änderungen erläutert, die erforderlich sind, damit Adobe Experience Manager Maven-Projekte mit AEM as a Cloud Service kompatibel sind, indem sichergestellt wird, dass sie die Aufteilung in veränderliche und unveränderliche Inhalte berücksichtigen. Darüber hinaus werden Abhängigkeiten festgelegt, um nicht widersprüchliche, deterministische Implementierungen zu erstellen, und sie werden in einer bereitstellbaren Struktur verpackt.

AEM-Anwendungsbereitstellungen müssen aus einem einzigen AEM-Paket bestehen. Dieses Paket sollte wiederum Unterpakete enthalten, die alles umfassen, was das Programm benötigt, um zu funktionieren, einschließlich Code, Konfiguration und unterstützenden Basisinhalten.

AEM erfordert eine Trennung von Inhalt und Code. Dies bedeutet, dass ein einzelnes Inhaltspaket nicht sowohl für /apps als auch für zur Laufzeit schreibbare Bereiche des Repositorys bereitstellen kann (z. B./content, /conf, /home oder alles, was nicht /apps ist). Stattdessen muss die Anwendung Code und Inhalt in separaten Pakete für die Bereitstellung in AEM voneinander trennen.

Die in diesem Dokument beschriebene Paketstruktur ist mit lokalen Entwicklungsbereitstellungen und AEM Cloud Service-Bereitstellungen kompatibel.

Veränderliche und nicht veränderliche Bereiche des Repositorys mutable-vs-immutable

Die Bereiche /apps und /libs von AEM gelten als unveränderlich, weil sie nach dem Start (d. h. zur Laufzeit) nicht mehr geändert (erstellt, aktualisiert, gelöscht) werden können. Jeder Versuch, einen unveränderlichen Bereich zur Laufzeit zu ändern, schlägt fehl.

Alle weiteren Komponenten im Repository (z. B. /content, /conf, /var, /etc, /oak:index, /system, /tmp usw.) sind veränderliche Bereiche, d. h. sie können zur Laufzeit geändert werden.

Oak-Indizes oak-indexes

Oak-Indizes (/oak:index) werden vom AEM as a Cloud Service-Bereitstellungsprozess verwaltet. Dies liegt daran, dass Cloud Manager warten muss, bis ein neuer Index bereitgestellt und vollständig neu indiziert wird, bevor zum neuen Code-Bild gewechselt wird.

Aus diesem Grund müssen Oak-Indizes, obwohl sie zur Laufzeit veränderbar sind, als Code bereitgestellt werden, damit sie installiert werden können, bevor veränderbare Pakete installiert werden. Daher sind /oak:index-Konfigurationen Teil des Code-Pakets und nicht Teil des Inhaltspakets, wie unten beschrieben.

Empfohlene Paketstruktur recommended-package-structure

Dieses Diagramm bietet einen Überblick über die empfohlene Projektstruktur und die empfohlenen Artefakte zur Paketbereitstellung.

Die empfohlene Bereitstellungsstruktur für Programme lautet wie folgt:

Code-Pakete/OSGi-Pakete

Inhaltspakete

Container-Pakete

Zusätzliche Anwendungspakete extra-application-packages

Wenn andere AEM-Projekte, die selbst aus eigenen Code- und Inhaltspaketen bestehen, von der AEM-Bereitstellung verwendet werden, sollten ihre Container-Pakete in das all-Paket des Projekts eingebettet werden.

Beispielsweise könnte ein AEM-Projekt, das zwei anbieterspezifische AEM-Programme enthält, wie folgt aussehen:

Pakettypen package-types

Die Pakete sind mit ihrem deklarierten Pakettyp zu kennzeichnen. Mithilfe von Pakettypen lässt sich der Zweck und die Bereitstellung eines Pakets verdeutlichen.

Weitere Informationen finden Sie in der Dokumentation zu Apache Jackrabbit FileVault - Package Maven-Plug-in, Apache Jackrabbit-Pakettypen und dem Konfigurations-Snippet für FileVault Mavent unten.

Markieren von Paketen für die Bereitstellung durch Adobe Cloud Manager marking-packages-for-deployment-by-adoube-cloud-manager

Standardmäßig sammelt Adobe Cloud Manager alle vom Maven-Build erstellten Pakete. Da jedoch das Container-Paket (all) das einzige Implementierungsartefakt ist, das alle Code- und Inhaltspakete enthält, müssen Sie sicherstellen, dass nur das Containter-Paket (all) bereitgestellt wird. Um dies sicherzustellen, müssen andere Pakete, die der Maven-Build generiert, mit der FileVault Content Package Maven Plug-in-Konfiguration von <properties><cloudManagerTarget>none</cloudManageTarget></properties> gekennzeichnet werden.

Repo Init repo-init

Repo Init enthält Anweisungen oder Skripte, mit denen JCR-Strukturen definiert werden, von allgemeinen Knotenstrukturen wie Ordnerbäumen bis hin zu Benutzenden, Dienstbenutzenden, Gruppen und ACL-Definitionen.

Die Hauptvorteile von Repo Init sind, dass sie implizite Berechtigungen zum Ausführen aller Aktionen haben, die von ihren Skripten definiert werden. Außerdem werden solche Skripte frühzeitig im Bereitstellungslebenszyklus aufgerufen, um sicherzustellen, dass alle erforderlichen JCR-Strukturen bereits vorhanden sind, wenn der Code ausgeführt wird.

Während Repo Init-Skripte selbst als Skripte im ui.config-Projekt vorhanden sind, können und sollten sie zum Definieren der folgenden veränderbaren Strukturen verwendet werden:

Repo Init-Skripte werden als scripts-Einträge von RepositoryInitializer-OSGi-Werkskonfigurationen gespeichert. Daher können sie implizit vom Ausführungsmodus angesprochen werden, wodurch Unterschiede zwischen den Repo Init-Skripten der AEM-Authoring- und AEM-Publishing-Dienste oder sogar zwischen Umgebungen (Entwicklung, Staging und Produktion) berücksichtigt werden.

Repo Init-OSGi-Konfigurationen werden am besten im .config OSGi-Konfigurationsformat geschrieben, da sie mehrere Zeilen unterstützen. Dies stellt eine Ausnahme bei den Best Practices dar, .cfg.json zur Definition von OSGi-Konfigurationen zu verwenden.

Beim Definieren von Benutzenden und Gruppen werden nur Gruppen als Teil der Anwendung und als integraler Bestandteil ihrer Funktion betrachtet. Sie definieren Organisationsbenutzende und -gruppen weiterhin zur Laufzeit in AEM. Wenn beispielsweise ein benutzerdefinierter Workflow einer benannten Gruppe Arbeit zuweist, definieren Sie diese Gruppe über Repo Init in der AEM-Anwendung. Wenn die Gruppierung jedoch nur organisatorisch ist, z. B. „Heikes Team“ und „Erwins Team“, werden diese Gruppen am besten zur Laufzeit in AEM definiert und verwaltet.

Das vollständige Vokabular für Repo Init-Skripte ist in der Apache Sling Repo Init-Dokumentation verfügbar.

Repository-Strukturpaket repository-structure-package

Für Code-Pakete muss das FileVault Maven-Plug-in so konfiguriert werden, dass auf ein <repositoryStructurePackage> verwiesen wird, das die Richtigkeit struktureller Abhängigkeiten erzwingt (um sicherzustellen, dass ein Code-Paket nicht über ein anderes installiert wird). Sie können Ihr eigenes Repository-Strukturpaket für Ihr Projekt erstellen.

Dies ist nur für Code-Pakete erforderlich, d. h. für alle Pakete, die mit <packageType>application</packageType> gekennzeichnet sind.

Informationen zum Erstellen eines Repository-Strukturpakets für Ihr Programm finden Sie unter Entwickeln eines Repository-Strukturpakets.

Beachten Sie, dass dieses Repository-Strukturpaket für Inhaltspakete (<packageType>content</packageType>) nicht erforderlich ist.

Einbetten von Unterpaketen in das Container-Paket embeddeds

Inhalts- oder Code-Pakete werden in einem speziellen „Side-Car“-Ordner abgelegt und können mithilfe der <embeddeds>-Konfiguration des FileVault Maven-Plug-ins entweder auf AEM Author, AEM Publish oder beiden installiert werden. Verwenden Sie nicht die <subPackages>-Konfiguration.

Häufige Anwendungsfälle sind:

Um AEM Author, AEM Publish oder beides als Ziel festzulegen, wird das Paket in das all-Container-Paket an einem bestimmten Ordnerspeicherort im folgenden Format eingebettet:

/apps/<app-name>-packages/(content|application|container)/install(.author|.publish)?

Eine Aufschlüsselung dieser Ordnerstruktur:

Beispielsweise kann eine Bereitstellung, die AEM Author- und Publish-spezifische Pakete enthält, wie folgt aussehen:

Filterdefinition des Container-Pakets container-package-filter-definition

Aufgrund der Einbettung von Code und Inhalts-Unterpaketen in das Container-Paket müssen die eingebetteten Zielpfade zur Datei filter.xml des Container-Projekts hinzugefügt werden. Dadurch wird sichergestellt, dass beim Build die eingebetteten Pakete im Container-Paket enthalten sind.

Fügen Sie einfach die <filter root="/apps/<my-app>-packages"/>-Einträge für alle Ordner der zweiten Ebene hinzu, die bereitzustellende Unterpakete enthalten.

Einbetten von Drittanbieter-Paketen embedding-3rd-party-packages

Alle Pakete müssen über das öffentliche Maven-Artefakt-Repository von Adobe oder ein öffentlich zugängliches, referenzierbares Maven-Artefakt-Repository von Drittanbietern verfügbar sein.

Wenn sich die Pakete von Drittanbietern im öffentlichen Maven-Artefakt-Repository von Adobe befinden, ist für Adobe Cloud Manager keine weitere Konfiguration erforderlich, um die Artefakte aufzulösen.

Wenn sich die Pakete von Drittanbietern in einem öffentlichen Maven-Artefakt-Repository von Drittanbietern befinden, muss dieses Repository in der pom.xml des Projekts registriert und gemäß der oben beschriebenen Methode eingebettet werden.

Anwendungen/Connectoren von Drittanbietern sollten mit ihrem all-Paket als Container im Container-Paket (all) Ihres Projekts eingebettet werden.

Das Hinzufügen von Maven-Abhängigkeiten folgt den Standardpraktiken von Maven, und das Einbetten von Artefakten von Drittanbietern (Code- und Inhaltspakete) wird oben beschrieben.

Paketabhängigkeiten zwischen den ui.apps von ui.content-Paketen package-dependencies

Um eine ordnungsgemäße Installation der Pakete sicherzustellen, wird empfohlen, Abhängigkeiten zwischen Paketen zu erstellen.

Die allgemeine Regel ist, dass Pakete mit veränderlichem Inhalt (ui.content) vom unveränderlichen Code (ui.apps) abhängen sollten, der die Wiedergabe und Verwendung des veränderlichen Inhalts unterstützt.

Eine wichtige Ausnahme von dieser allgemeinen Regel ist, wenn das unveränderliche Code-Paket (ui.apps oder jedes andere) nur OSGi-Bundles enthält. Ist dies der Fall sollte kein AEM-Paket eine Abhängigkeit angeben. Der Grund dafür ist, dass unveränderliche Code-Pakete, die nur OSGi-Bundles enthalten, nicht bei AEM Package Manager registriert sind. Daher hat jedes AEM Paket, das davon abhängig ist, eine nicht erfüllte Abhängigkeit und kann nicht installiert werden.

Die üblichen Muster für Abhängigkeiten von Inhaltspaketen sind:

Abhängigkeiten von einfachen Bereitstellungspaketen simple-deployment-package-dependencies

Im einfachen Fall hängt das veränderliche Inhaltspaket ui.content vom unveränderlichen Code-Paket ui.apps ab.

Abhängigkeiten von komplexen Bereitstellungspaketen complex-deploxment-package-dependencies

Komplexe Bereitstellungen gehen über den einfachen Fall hinaus und legen Abhängigkeiten zwischen den entsprechenden veränderbaren Inhalten und unveränderlichen Code-Paketen fest. Abhängigkeiten können bei Bedarf auch zwischen unveränderlichen Code-Paketen festgelegt werden.

Lokale Entwicklung und Bereitstellung local-development-and-deployment

Die in diesem Artikel beschriebenen Projektstrukturen und -organisationen sind mit AEM-Instanzen für die lokale Entwicklung vollständig kompatibel.

POM-XML-Snippets pom-xml-snippets

Im Folgenden finden Sie Maven pom.xml-Konfigurations-Snippets, die zu Maven-Projekten hinzugefügt werden können, um sie an die oben genannten Empfehlungen anzupassen.

Pakettypen xml-package-types

Code- und Inhaltspakete, die als Unterpakete bereitgestellt werden, müssen je nachdem, was sie enthalten, einen Pakettyp Anwendung oder Inhalt deklarieren.

Container-Pakettypen container-package-types

Das Container-Projekt all/pom.xml deklariert keinen <packageType>.

(Unveränderliche) Code-Pakettypen immutable-package-types

Code-Pakete müssen ihren packageType auf application setzen.

In der ui.apps/pom.xml deklariert die <packageType>application</packageType>-Build-Konfigurationsanweisung der filevault-package-maven-plugin-Plug-in-Deklaration den Pakettyp.

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        <group>${project.groupId}</group>
        <name>my-app.ui.apps</name>
        <packageType>application</packageType>
        <accessControlHandling>merge</accessControlHandling>
        <properties>
          <cloudManagerTarget>none</cloudManagerTarget>
        </properties>
      </configuration>
    </plugin>
    ...

(Veränderliche) Code-Pakettypen mutable-package-types

Inhaltspakete müssen ihren packageType auf content setzen.

In der ui.content/pom.xml deklariert die <packageType>content</packageType>-Build-Konfigurationsanweisung der filevault-package-maven-plugin-Plug-in-Deklaration den Pakettyp.

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        <group>${project.groupId}</group>
        <name>my-app.ui.content</name>
        <packageType>content</packageType>
        <accessControlHandling>merge</accessControlHandling>
        <properties>
          <cloudManagerTarget>none</cloudManagerTarget>
        </properties>
      </configuration>
    </plugin>
    ...

Markieren von Paketen für die Bereitstellung über Adobe Cloud Manager cloud-manager-target

Fügen Sie in jedem Projekt, das ein Paket generiert, mit Ausnahme des Container-Projekts (all), <cloudManagerTarget>none</cloudManagerTarget> der <properties>-Konfiguration der filevault-package-maven-plugin-Plug-in-Deklaration hinzu, um sicherzustellen, dass sie nicht von Adobe Cloud Manager bereitgestellt werden. Das Container-Paket (all) sollte das Einzelpaket sein, das über Cloud Manager bereitgestellt wird. Dadurch werden alle erforderlichen Code- und Inhaltspakete eingebettet.

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        ...
        <properties>
          <cloudManagerTarget>none</cloudManagerTarget>
        </properties>
      </configuration>
    </plugin>
    ...

Repo Init snippet-repo-init

Repo Init-Skripte, die die Repo Init-Skripte enthalten, werden in der RepositoryInitializer-OSGi-Werkskonfiguration über die scripts-Eigenschaft definiert. Da diese Skripte in OSGi-Konfigurationen definiert sind, können sie mithilfe der üblichen ../config.<runmode>-Ordnersemantik problemlos vom Ausführungsmodus erfasst werden.

Da es sich bei Skripten normalerweise um mehrzeilige Deklarationen handelt, ist es einfacher, sie in der .config-Datei zu definieren als dem auf JSON-basierenden Format .cfg.json.

/apps/my-app/config.author/org.apache.sling.jcr.repoinit.RepositoryInitializer-author.config

scripts=["
    create service user my-data-reader-service

    set ACL on /var/my-data
        allow jcr:read for my-data-reader-service
    end

    create path (sling:Folder) /conf/my-app/settings
"]

Die scripts-OSGi-Eigenschaft enthält Anweisungen, die in der Repo Init-Sprache von Apache Sling definiert sind.

Repository-Strukturpaket xml-repository-structure-package

Fügen Sie in ui.apps/pom.xml und allen anderen pom.xml, die ein Code-Paket (<packageType>application</packageType>) deklarieren, die folgende Repository-Strukturpaketkonfiguration zum FileVault Maven-Plug-in hinzu. Sie können Ihr eigenes Repository-Strukturpaket für Ihr Projekt erstellen.

...
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.jackrabbit</groupId>
      <artifactId>filevault-package-maven-plugin</artifactId>
      <extensions>true</extensions>
      <configuration>
        ...
        <repositoryStructurePackages>
          <repositoryStructurePackage>
              <groupId>${project.groupId}</groupId>
              <artifactId>ui.apps.structure</artifactId>
              <version>${project.version}</version>
          </repositoryStructurePackage>
        </repositoryStructurePackages>
      </configuration>
    </plugin>
    ...

Einbetten von Unterpaketen in das Container-Paket xml-embeddeds

Fügen Sie in all/pom.xml der Plug-in-Deklaration filevault-package-maven-plugin die folgenden <embeddeds>-Anweisungen hinzu. Denken Sie daran, nicht die <subPackages>-Konfiguration zu verwenden. Der Grund dafür ist, dass sie die Unterpakete in /etc/packages anstelle von /apps/my-app-packages/<application|content|container>/install(.author|.publish)? einbezieht.

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <embeddeds>

          <!-- Include the application's ui.apps and ui.content packages -->
          <!-- Ensure the artifactIds are correct -->

          <!-- OSGi Bundle Jar file that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.core</artifactId>
              <type>jar</type>
              <target>/apps/my-app-packages/application/install</target>
          </embedded>

          <!-- Code package that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.apps</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/application/install</target>
          </embedded>

           <!-- OSGi configuration code package that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.config</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/application/install</target>
          </embedded>

          <!-- Code package that deploys ONLY to AEM Author -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.apps.author</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/application/install.author</target>
          </embedded>

          <!-- Content package that deploys to BOTH AEM Author and AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.content</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/content/install</target>
          </embedded>

          <!-- Content package that deploys ONLY to AEM Publish -->
          <embedded>
              <groupId>${project.groupId}</groupId>
              <artifactId>my-app.ui.content.publish-only</artifactId>
              <type>zip</type>
              <target>/apps/my-app-packages/content/install.publish</target>
          </embedded>

          <!-- Include any other extra packages  -->
          <embedded>
              <groupId>com.vendor.x</groupId>
              <artifactId>vendor.plug-in.all</artifactId>
              <type>zip</type>
              <target>/apps/vendor-packages/container/install</target>
          </embedded>
      <embeddeds>
  </configuration>
</plugin>
...

Filterdefinition des Container-Pakets xml-container-package-filters

Sie müssen in der filter.xml (all/src/main/content/jcr_root/META-INF/vault/definition/filter.xml) des all-Projekts alle -packages-Ordner einschließen, die Unterpakete enthalten, die bereitgestellt werden sollen:

<filter root="/apps/my-app-packages"/>

Wenn mehrere /apps/*-packages in den eingebetteten Zielen verwendet werden, müssen sie hier alle aufgezählt werden.

Maven-Repositorys von Drittanbietern xml-3rd-party-maven-repositories

Fügen Sie in der pom.xml des Reaktorprojekts alle erforderlichen öffentlichen Maven-Repository-Anweisungen von Drittanbietern hinzu. Die vollständige <repository>-Konfiguration sollte beim Repository-Drittanbieter erhältlich sein.

<repositories>
  ...
  <repository>
      <id>3rd-party-repository</id>
      <name>Public Third-Party Repository</name>
      <url>https://repo.3rdparty.example.com/...</url>
      <releases>
          <enabled>true</enabled>
          <updatePolicy>never</updatePolicy>
      </releases>
      <snapshots>
          <enabled>false</enabled>
      </snapshots>
  </repository>
  ...
</repositories>

Paketabhängigkeiten zwischen den ui.apps von ui.content-Paketen xml-package-dependencies

Fügen Sie in ui.content/pom.xml der filevault-package-maven-plugin-Plug-in-Deklaration die folgenden <dependencies>-Anweisungen hinzu.

...
<plugin>
  <groupId>org.apache.jackrabbit</groupId>
  <artifactId>filevault-package-maven-plugin</artifactId>
  <extensions>true</extensions>
  <configuration>
      ...
      <dependencies>
        <!-- Declare the content package dependency in the ui.content/pom.xml on the ui.apps project -->
        <dependency>
            <groupId${project.groupId}</groupId>
            <artifactId>my-app.ui.apps</artifactId>
            <version>${project.version}</version>
        </dependency>
      </dependencies>
    ...
  </configuration>
</plugin>
...

Bereinigen des Zielordners des Container-Projekts xml-clean-container-package

Fügen Sie in all/pom.xml das Plug-in maven-clean-plugin hinzu, das das Zielverzeichnis vor einem Maven-Build bereinigt.

<plugins>
  ...
  <plugin>
    <artifactId>maven-clean-plugin</artifactId>
    <executions>
      <execution>
        <id>auto-clean</id>
        <!-- Run at the beginning of the build rather than the default, which is after the build is done -->
        <phase>initialize</phase>
        <goals>
          <goal>clean</goal>
        </goals>
      </execution>
    </executions>
  </plugin>
  ...
</plugins>

Zusätzliche Ressourcen additional-resources