Struttura dei progetti AEM

Questo articolo illustra le modifiche necessarie affinché i progetti Adobe Experience Manager Maven siano compatibili con AEM as a Cloud Service, garantendo che rispettino la suddivisione dei contenuti mutabili e immutabili. Inoltre, le dipendenze vengono stabilite per creare distribuzioni deterministiche non in conflitto e vengono inserite in una struttura distribuibile.

Le implementazioni delle applicazioni AEM devono essere composte da un singolo pacchetto AEM. A sua volta, questo pacchetto deve contenere pacchetti secondari che comprendono tutto ciò che l’applicazione richiede per funzionare, inclusi il codice, la configurazione e qualsiasi contenuto di base di supporto.

AEM richiede una separazione di contenuto e codice, il che significa che un singolo pacchetto di contenuti non può essere distribuito a entrambe /apps e alle aree scrivibili di runtime (ad esempio, /content, /conf, /home o a qualsiasi elemento diverso da /apps) dell'archivio. Al contrario, l’applicazione deve separare codice e contenuto in pacchetti discreti da distribuire in AEM.

La struttura del pacchetto descritta in questo documento è compatibile sia con le distribuzioni di sviluppo locali che con le distribuzioni di AEM Cloud Service.

Aree mutabili e immutabili dell’archivio mutable-vs-immutable

Le aree /apps e /libs dell'AEM sono considerate immutabili perché non possono essere modificate (create, aggiornate, eliminate) dopo l'avvio dell'AEM (ovvero in fase di runtime). Qualsiasi tentativo di modificare un’area immutabile in fase di runtime non riesce.

Tutte le altre aree del repository, /content, /conf, /var, /etc, /oak:index, /system, /tmp e così via, sono tutte mutabili, il che significa che possono essere modificate in fase di esecuzione.

Indici Oak oak-indexes

Gli indici Oak (/oak:index) sono gestiti dal processo di distribuzione di AEM as a Cloud Service. Il motivo è che Cloud Manager deve attendere che venga distribuito e completamente reindicizzato un nuovo indice prima di passare alla nuova immagine del codice.

Per questo motivo, anche se gli indici Oak sono modificabili in fase di esecuzione, devono essere distribuiti come codice in modo che possano essere installati prima di installare eventuali pacchetti modificabili. Pertanto /oak:index configurazioni fanno parte del pacchetto codice e non del pacchetto contenuto come descritto di seguito.

Struttura consigliata dei pacchetti recommended-package-structure

Questo diagramma fornisce una panoramica della struttura di progetto e degli artefatti di distribuzione dei pacchetti consigliati.

La struttura consigliata per la distribuzione delle applicazioni è la seguente:

Pacchetti codice/Bundle OSGi

Pacchetti di contenuti

Pacchetti contenitore

Pacchetti di applicazioni aggiuntivi extra-application-packages

Se altri progetti AEM, a loro volta costituiti da pacchetti di codice e contenuti, vengono utilizzati dalla distribuzione AEM, i pacchetti contenitore devono essere incorporati nel pacchetto all del progetto.

Ad esempio, un progetto AEM che include due applicazioni AEM di fornitori diversi potrebbe essere simile al seguente:

Tipi di pacchetti package-types

I pacchetti devono essere contrassegnati con il relativo tipo di pacchetto dichiarato. I tipi di pacchetto aiutano a chiarire lo scopo e la distribuzione di un pacchetto.

Per ulteriori informazioni, consulta Apache Jackrabbit FileVault - Documentazione del plug-in Maven per pacchetti, Apache Jackrabbit Package Types e FileVault Maven configuration snippet di seguito.

Contrassegno dei pacchetti per la distribuzione da parte di Adobe Cloud Manager marking-packages-for-deployment-by-adoube-cloud-manager

Per impostazione predefinita, Adobe Cloud Manager raccoglie tutti i pacchetti prodotti dalla build Maven. Tuttavia, poiché il pacchetto contenitore (all) è l'unico artefatto di distribuzione che contiene tutti i pacchetti di codice e contenuto, è necessario assicurarsi che solo il pacchetto contenitore (all) sia distribuito. Per questo motivo, gli altri pacchetti generati dalla build Maven devono essere contrassegnati con la configurazione FileVault Content Package Maven Plug-In di <properties><cloudManagerTarget>none</cloudManageTarget></properties>.

Repo iniziale repo-init

Repo Init fornisce istruzioni, o script, per definire le strutture JCR, che vanno dalle strutture di nodi comuni come le strutture di cartelle a utenti, utenti del servizio, gruppi e definizioni ACL.

I vantaggi principali di Repo Init sono le autorizzazioni implicite per eseguire tutte le azioni definite dagli script. Inoltre, tali script vengono richiamati nelle prime fasi del ciclo di vita della distribuzione, garantendo che tutte le strutture JCR richieste esistano al momento dell’esecuzione del codice temporale.

Anche se gli script Repo Init stessi vivono nel progetto ui.config come script, possono e devono essere utilizzati per definire le seguenti strutture mutabili:

Gli script Repo Init sono archiviati come scripts voci di RepositoryInitializer configurazioni di fabbrica OSGi. Di conseguenza, possono essere indirizzati implicitamente dalla modalità di esecuzione, consentendo differenze tra gli script Repo Init di AEM Author e AEM Publish Services, o anche tra ambienti (Dev, Stage e Prod).

Le configurazioni OSGi Repo Init vengono scritte in modo ottimale nel formato di configurazione OSGi .config in quanto supportano più righe, il che rappresenta un'eccezione alle best practice di utilizzo di .cfg.json per definire le configurazioni OSGi.

Quando si definiscono Utenti e Gruppi, solo i gruppi sono considerati parte dell’applicazione e sono parte integrante della sua funzione. Puoi ancora definire gli utenti e i gruppi dell’organizzazione in fase di runtime in AEM. Ad esempio, se un flusso di lavoro personalizzato assegna il lavoro a un gruppo denominato, definisci tale gruppo tramite Repo Init nell’applicazione AEM. Tuttavia, se il Raggruppamento è puramente organizzativo, come "Wendy's Team" e "Sean's Team", questi gruppi sono meglio definiti e gestiti in fase di runtime in AEM.

Il vocabolario completo per gli script Repo Init è disponibile nella documentazione Apache Sling Repo Init.

Pacchetto struttura archivio repository-structure-package

I pacchetti di codice richiedono la configurazione della configurazione del plug-in Maven FileVault per fare riferimento a <repositoryStructurePackage> che impone la correttezza delle dipendenze strutturali (per garantire che un pacchetto di codice non venga installato su un altro). Puoi creare il tuo pacchetto della struttura dell'archivio per il progetto.

È richiesto solo per i pacchetti codice, ovvero per tutti i pacchetti contrassegnati con <packageType>application</packageType>.

Per informazioni su come creare un pacchetto della struttura dell'archivio per l'applicazione, vedere Sviluppare un pacchetto della struttura dell'archivio.

I pacchetti di contenuto (<packageType>content</packageType>) non richiedono questo pacchetto della struttura dell'archivio.

Incorporazione di pacchetti secondari nel pacchetto contenitore embeddeds

I pacchetti di contenuto o codice vengono inseriti in una cartella "side-car" speciale e possono essere destinati all’installazione su AEM Author, AEM Publish o entrambi, utilizzando la configurazione <embeddeds> del plug-in FileVault Maven. Non utilizzare la configurazione <subPackages>.

I casi d’uso comuni includono:

Per eseguire il targeting dell'autore AEM, delle pubblicazioni AEM o di entrambi, il pacchetto è incorporato nel pacchetto contenitore all in una posizione cartella speciale, nel formato seguente:

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

Suddivisione di questa struttura di cartelle:

Ad esempio, una distribuzione che contiene pacchetti specifici per l’authoring e la pubblicazione di AEM può avere un aspetto simile al seguente:

Definizione filtro del pacchetto contenitore container-package-filter-definition

A causa dell'incorporamento del codice e dei pacchetti secondari di contenuto nel pacchetto contenitore, i percorsi di destinazione incorporati devono essere aggiunti al filter.xml del progetto contenitore. In questo modo i pacchetti incorporati vengono inclusi nel pacchetto contenitore quando generato.

È sufficiente aggiungere le voci <filter root="/apps/<my-app>-packages"/> per tutte le cartelle di secondo livello che contengono pacchetti secondari da distribuire.

Incorporazione di pacchetti di terze parti embedding-3rd-party-packages

Tutti i pacchetti devono essere disponibili tramite l'archivio di artefatti Maven pubblico di Adobe o un archivio di artefatti Maven pubblico accessibile e di terze parti referenziabile.

Se i pacchetti di terze parti si trovano nell'archivio di artefatti Maven pubblico di Adobe, non è necessaria alcuna ulteriore configurazione affinché Adobe Cloud Manager possa risolvere gli artefatti.

Se i pacchetti di terze parti si trovano in un archivio di artefatti Maven pubblico di terze parti, questo archivio deve essere registrato in pom.xml del progetto e incorporato seguendo il metodo descritto sopra.

L'applicazione o i connettori di terze parti devono essere incorporati utilizzando il pacchetto all come contenitore nel pacchetto contenitore del progetto (all).

L'aggiunta di dipendenze Maven segue le pratiche Maven standard e l'incorporamento di artefatti di terze parti (pacchetti di codice e contenuti) sono descritti sopra.

Dipendenze dei pacchetti tra ui.apps da ui.content pacchetti package-dependencies

Per garantire la corretta installazione dei pacchetti, si consiglia di stabilire le dipendenze tra i pacchetti.

La regola generale è che i pacchetti contenenti contenuto mutabile (ui.content) devono dipendere dal codice immutabile (ui.apps) che supporta il rendering e l'utilizzo del contenuto mutabile.

Un'eccezione rilevante a questa regola generale è se il pacchetto di codice immutabile (ui.apps o qualsiasi altro), only contiene bundle OSGi. In tal caso, nessun pacchetto AEM dovrebbe dichiarare una dipendenza da esso. Il motivo è che i pacchetti di codice immutabile che solo contengono bundle OSGi non sono registrati con AEM Gestione pacchetti. Pertanto, qualsiasi pacchetto AEM che dipende da esso ha una dipendenza non soddisfatta e non riesce a installare.

I pattern comuni per le dipendenze dei pacchetti di contenuti sono:

Dipendenze dei pacchetti di distribuzione semplici simple-deployment-package-dependencies

Con l'uso di maiuscole/minuscole, il pacchetto di contenuto mutabile ui.content dipende dal pacchetto di codice immutabile ui.apps.

Dipendenze dei pacchetti di distribuzione complesse complex-deploxment-package-dependencies

Le distribuzioni complesse si espandono in base al caso semplice e impostano le dipendenze tra il contenuto mutabile corrispondente e i pacchetti di codice immutabile. Se necessario, è possibile stabilire le dipendenze anche tra pacchetti di codice immutabili.

Sviluppo e distribuzione locali local-development-and-deployment

Le strutture e l'organizzazione del progetto descritte in questo articolo sono completamente compatibili istanze AEM di sviluppo locale.

Frammenti XML POM pom-xml-snippets

Di seguito sono riportati snippet di configurazione Maven pom.xml che possono essere aggiunti ai progetti Maven per allinearli ai consigli di cui sopra.

Tipi di pacchetti xml-package-types

I pacchetti di codice e contenuto, distribuiti come pacchetti secondari, devono dichiarare un tipo di pacchetto di applicazione o contenuto, a seconda di ciò che contengono.

Tipi di pacchetti contenitore container-package-types

Il progetto del contenitore all/pom.xml non dichiara un <packageType>.

Tipi di pacchetti codice (immutabili) immutable-package-types

I pacchetti di codice devono impostare packageType su application.

In ui.apps/pom.xml, le direttive di configurazione della build <packageType>application</packageType> della dichiarazione del plug-in filevault-package-maven-plugin dichiarano il relativo tipo di pacchetto.

...
<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>
    ...

Tipi di pacchetti di contenuti (mutabili) mutable-package-types

I pacchetti di contenuti devono impostare packageType su content.

In ui.content/pom.xml, la direttiva di configurazione della build <packageType>content</packageType> della dichiarazione del plug-in filevault-package-maven-plugin dichiara il relativo tipo di pacchetto.

...
<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>
    ...

Contrassegno dei pacchetti per la distribuzione Cloud Manager di Adobe cloud-manager-target

In ogni progetto che genera un pacchetto, fatta eccezione per il progetto contenitore (all), aggiungi <cloudManagerTarget>none</cloudManagerTarget> alla configurazione <properties>della dichiarazione del plug-in filevault-package-maven-plugin, in modo da assicurarti che non siano distribuiti da Adobe Cloud Manager. Il pacchetto contenitore (all) deve essere il singolo pacchetto distribuito tramite Cloud Manager, che a sua volta incorpora tutti i pacchetti richiesti di codice e contenuto.

...
<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 iniziale snippet-repo-init

Gli script Repo Init che contengono gli script Repo Init sono definiti nella configurazione di fabbrica OSGi RepositoryInitializer tramite la proprietà scripts. Poiché questi script sono definiti nelle configurazioni OSGi, possono essere facilmente delimitati dalla modalità di esecuzione utilizzando la semantica di cartella ../config.<runmode>.

Poiché gli script sono in genere dichiarazioni su più righe, è più semplice definirli nel file .config rispetto al formato .cfg.json basato su 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
"]

La proprietà OSGi scripts contiene le direttive definite dal linguaggio Repo Init di Apache Sling.

Pacchetto struttura archivio xml-repository-structure-package

In ui.apps/pom.xml e in qualsiasi altro pom.xml che dichiara un pacchetto di codice (<packageType>application</packageType>), aggiungere la seguente configurazione del pacchetto di struttura dell'archivio al plug-in Maven FileVault. Puoi creare il tuo pacchetto della struttura dell'archivio per il progetto.

...
<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>
    ...

Incorporazione di pacchetti secondari nel pacchetto contenitore xml-embeddeds

In all/pom.xml, aggiungere le seguenti <embeddeds> direttive alla dichiarazione del plug-in filevault-package-maven-plugin. Ricorda che non utilizza la configurazione <subPackages>. Il motivo è che include i pacchetti secondari in /etc/packages anziché /apps/my-app-packages/<application|content|container>/install(.author|.publish)?.

...
<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>
...

Definizione filtro del pacchetto contenitore xml-container-package-filters

Nel filter.xml (all/src/main/content/jcr_root/META-INF/vault/definition/filter.xml) del progetto all, include le cartelle -packages che contengono pacchetti secondari da distribuire:

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

Se nelle destinazioni incorporate vengono utilizzati più /apps/*-packages, è necessario enumerarli tutti.

Archivi Maven di terze parti xml-3rd-party-maven-repositories

Nel pom.xml del progetto reactor, aggiungi eventuali direttive dell’archivio Maven pubblico di terze parti necessarie. La configurazione <repository> completa deve essere disponibile dal provider dell'archivio di terze parti.

<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>

Dipendenze dei pacchetti tra ui.apps da ui.content pacchetti xml-package-dependencies

In ui.content/pom.xml, aggiungere le seguenti <dependencies> direttive alla dichiarazione del plug-in filevault-package-maven-plugin.

...
<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>
...

Pulizia della cartella di destinazione del progetto contenitore xml-clean-container-package

In all/pom.xml, aggiungi il plug-in maven-clean-plugin che pulisce la directory di destinazione prima di una build Maven.

<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>

Risorse aggiuntive additional-resources