Estrutura de projetos do AEM

Este artigo descreve as alterações necessárias para que os projetos do Adobe Experience Manager Maven sejam compatíveis com o AEM as a Cloud Service, garantindo que eles respeitem a divisão de conteúdo mutável e imutável. Além disso, as dependências são estabelecidas para criar implantações determinísticas e não conflitantes e são agrupadas em uma estrutura implantável.

As implantações de aplicativos de AEM devem ser compostas por um único pacote de AEM. Este pacote deve, por sua vez, conter subpacotes que incluem tudo o que o aplicativo exige para funcionar, incluindo código, configuração e qualquer conteúdo de linha de base de suporte.

O AEM exige uma separação de conteúdo e código, que significa um único pacote de conteúdo não é possível implantar em ambos /apps e áreas graváveis em tempo de execução (por exemplo, /content, /conf, /home, ou qualquer coisa que não /apps) do repositório. Em vez disso, o aplicativo deve separar código e conteúdo em pacotes separados para implantação no AEM.

A estrutura do pacote descrita neste documento é compatível com ambas as implantações de desenvolvimento locais e implantações do serviço da AEM Cloud.

Áreas mutáveis versus imutáveis do repositório mutable-vs-immutable

A variável /apps e /libs áreas de AEM são consideradas imutável porque não podem ser alteradas (criar, atualizar, excluir) após o início do AEM (ou seja, no tempo de execução). Qualquer tentativa de alterar uma área imutável no tempo de execução falha.

Todo o restante no repositório, /content, /conf, /var, /etc, /oak:index, /system, /tmpe assim por diante, são todos mutável áreas, o que significa que elas podem ser alteradas no tempo de execução.

Índices Oak oak-indexes

Índices Oak (/oak:index) são gerenciados pelo processo de implantação as a Cloud Service do AEM. O motivo é que o Cloud Manager deve aguardar até que qualquer novo índice seja implantado e totalmente reindexado antes de alternar para a nova imagem de código.

Por esse motivo, embora os índices Oak sejam mutáveis em tempo de execução, eles devem ser implantados como código para que possam ser instalados antes que qualquer pacote mutável seja instalado. Portanto /oak:index as configurações fazem parte do Pacote de código e não do Pacote de conteúdo conforme descrito abaixo.

Estrutura de pacotes recomendada recommended-package-structure

Este diagrama fornece uma visão geral da estrutura de projeto recomendada e dos artefatos de implantação de pacote.

A estrutura de implantação de aplicativo recomendada é a seguinte:

Pacotes de código / pacotes OSGi

Pacotes de conteúdo

Pacotes de contêineres

Pacotes de Aplicativos Adicionais extra-application-packages

Se outros projetos AEM - que são, em si, compostos de seus próprios pacotes de código e conteúdo - forem usados pela implantação do AEM, seus pacotes de contêiner deverão ser incorporados no all pacote.

Por exemplo, um projeto AEM que inclui aplicativos AEM de dois fornecedores pode ser semelhante a:

Tipos de encapsulamento package-types

Os pacotes devem ser marcados com o tipo de pacote declarado. Os tipos de pacote ajudam a esclarecer a finalidade e a implantação de um pacote.

Para obter mais informações, consulte Apache Jackrabbit FileVault - documentação do plug-in Package Maven, Tipos de pacote do Apache Jackrabbit, e o Trecho de configuração do FileVault Maven abaixo.

Marcação de pacotes para implantação pelo Adobe Cloud Manager marking-packages-for-deployment-by-adoube-cloud-manager

Por padrão, o Adobe Cloud Manager coleta todos os pacotes produzidos pela compilação Maven. No entanto, como o contêiner (all) é o artefato de implantação singular que contém todos os pacotes de código e conteúdo, você deve garantir somente o contêiner (all) é implantado. Para garantir isso, outros pacotes gerados pela compilação Maven devem ser marcados com a configuração do Plug-in FileVault Content Package Maven do <properties><cloudManagerTarget>none</cloudManageTarget></properties>.

Inicialização do repositório repo-init

A Inicialização do repositório fornece instruções, ou scripts, que definem estruturas JCR, que variam de estruturas de nó comuns, como árvores de pastas, a usuários, usuários de serviço, grupos e definição de ACL.

Os principais benefícios do Repo Init são que eles têm permissões implícitas para executar todas as ações definidas por seus scripts. E esses scripts são chamados no início do ciclo de vida da implantação, garantindo que todas as estruturas JCR necessárias existam até o código ser executado.

Enquanto os scripts de inicialização do repositório vivem no ui.config projeto como scripts, eles podem e devem ser usados para definir as seguintes estruturas mutáveis:

Os scripts de inicialização do repositório são armazenados como scripts entradas de RepositoryInitializer Configurações de fábrica do OSGi. Dessa forma, eles podem ser direcionados implicitamente pelo modo de execução, permitindo diferenças entre o Autor do AEM e os scripts de Inicialização de repositório do AEM Publish Services ou até mesmo entre ambientes (Desenvolvimento, Preparo e Produção).

As configurações de OSGi de inicialização de repositório são melhor gravadas no .config Formato de configuração do OSGi como suportam múltiplas linhas, o que constitui uma exceção às melhores práticas .cfg.json para definir configurações de OSGi.

Ao definir Usuários e Grupos, somente os grupos são considerados parte do aplicativo e parte integrante de sua função. Você ainda define Usuários e Grupos de Organização no tempo de execução no AEM. Por exemplo, se um fluxo de trabalho personalizado atribuir trabalho a um Grupo nomeado, defina esse Grupo por meio da Inicialização do repositório no aplicativo AEM. No entanto, se o Agrupamento é meramente organizacional, como "Wendy's Team" e "Sean's Team", esses grupos são melhor definidos e gerenciados no tempo de execução no AEM.

O vocabulário completo para scripts de inicialização de repositório está disponível no Documentação de inicialização do Apache Sling Repo.

Pacote de estrutura do repositório repository-structure-package

Os pacotes de código exigem a configuração do plug-in FileVault Maven para fazer referência a uma <repositoryStructurePackage> que impõe a correção de dependências estruturais (para garantir que um pacote de códigos não seja instalado sobre outro). Você pode criar seu próprio pacote de estrutura de repositório para o projeto.

Somente obrigatório para Pacotes de código, ou seja, qualquer pacote marcado com <packageType>application</packageType>.

Para saber como criar um pacote de estrutura do repositório para seu aplicativo, consulte Desenvolver um pacote de estrutura do repositório.

Pacotes de conteúdo (<packageType>content</packageType>) não exigir este pacote de estrutura do repositório.

Incorporação de subpacotes no pacote de contêiner embeddeds

O conteúdo ou os pacotes de código são colocados em uma pasta especial "lateral" e podem ser direcionados para instalação no autor do AEM, na publicação do AEM ou em ambos, usando o plug-in FileVault Maven <embeddeds> configuração. Não use o <subPackages> configuração.

Casos de uso comuns incluem:

Para direcionar o autor do AEM, o AEM publica ou ambos, o pacote é incorporado na all pacote de contêiner em um local de pasta especial, no seguinte formato:

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

Analisando a estrutura desta pasta:

Por exemplo, uma implantação que contém pacotes específicos do autor e da publicação do AEM pode ser semelhante ao seguinte:

Definição de filtro do pacote de contêiner container-package-filter-definition

Devido à incorporação dos subpacotes de código e conteúdo no pacote de contêiner, os caminhos de destino incorporados devem ser adicionados aos do projeto do contêiner filter.xml. Isso garante que os pacotes incorporados sejam incluídos no pacote de contêiner quando criados.

Basta adicionar o <filter root="/apps/<my-app>-packages"/> entradas para qualquer pasta de segundo nível que contenha subpacotes a serem implantados.

Incorporação de pacotes de terceiros embedding-3rd-party-packages

Todos os pacotes devem estar disponíveis por meio da Repositório de artefatos Maven público do Adobe ou um repositório de artefatos Maven de terceiros referenciável e público acessível.

Se os pacotes de terceiros estiverem em Repositório de artefatos Maven público do Adobe, nenhuma configuração adicional é necessária para o Adobe Cloud Manager resolver os artefatos.

Se os pacotes de terceiros estiverem em uma repositório público de artefatos Maven de terceiros, esse repositório deve ser registrado no repositório do pom.xml e incorporado seguindo o método descrito acima.

O aplicativo/conectores de terceiros devem ser incorporados usando sua all pacote como um contêiner no contêiner do projeto (all).

A adição de dependências do Maven segue as práticas padrão do Maven e a incorporação de artefatos de terceiros (pacotes de código e conteúdo) é descrito acima.

Dependências de pacote entre o ui.apps de ui.content Pacotes package-dependencies

Para garantir a instalação adequada dos pacotes, é recomendável que as dependências entre pacotes sejam estabelecidas.

A regra geral é pacotes com conteúdo mutável (ui.content) deve depender do código imutável (ui.apps) que suporta a renderização e uso do conteúdo mutável.

Uma exceção notável a essa regra geral é se o pacote de código imutável (ui.apps ou qualquer outro), somente contém pacotes OSGi. Em caso afirmativo, nenhum pacote AEM deve declarar uma dependência dele. O motivo é porque pacotes de código imutáveis que somente contêm pacotes OSGi, não estão registrados com AEM Gerenciador de pacotes. Portanto, qualquer pacote de AEM que dependa dele tem uma dependência insatisfeita e não é instalado.

Os padrões comuns para dependências de pacote de conteúdo são:

Dependências do Pacote de Implantação Simples simple-deployment-package-dependencies

O caso simples define o ui.content pacote de conteúdo mutável para depender do ui.apps pacote de código imutável.

Dependências complexas do pacote de implantação complex-deploxment-package-dependencies

Implantações complexas se expandem no caso simples e definem dependências entre o conteúdo mutável correspondente e pacotes de código imutáveis. Conforme necessário, as dependências também podem ser estabelecidas entre pacotes de código imutáveis.

Desenvolvimento e implantação local local-development-and-deployment

As estruturas e a organização do projeto descritas neste artigo são totalmente compatível instâncias de desenvolvimento local do AEM.

Trechos XML POM pom-xml-snippets

Veja a seguir o Maven pom.xml trechos de configuração que podem ser adicionados aos projetos Maven para se alinharem às recomendações acima.

Tipos de encapsulamento xml-package-types

Os pacotes de código e conteúdo, que são implantados como subpacotes, devem declarar um tipo de pacote de aplicativo ou conteúdo, dependendo do que eles contêm.

Tipos de pacote de contêiner container-package-types

O container all/pom.xml projeto não declarar um <packageType>.

Tipos de pacote de código (imutável) immutable-package-types

Os pacotes de código devem definir seus packageType para application.

No ui.apps/pom.xml, o <packageType>application</packageType> criar diretivas de configuração do filevault-package-maven-plugin declaração de plug-in declara seu tipo de pacote.

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

Tipos de encapsulamento de conteúdo (mutável) mutable-package-types

Os pacotes de conteúdo devem definir seus packageType para content.

No ui.content/pom.xml, o <packageType>content</packageType> diretiva de configuração de build do filevault-package-maven-plugin declaração de plug-in declara seu tipo de pacote.

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

Marcação de pacotes para implantação do Adobe Cloud Manager cloud-manager-target

Em todos os projetos que geram um pacote, exceto do projeto do contêiner (all), adicione <cloudManagerTarget>none</cloudManagerTarget> à configuração <properties> da declaração do plug-in filevault-package-maven-plugin para garantir que eles não sejam implantados pelo Adobe Cloud Manager. O container (all) deve ser o único pacote implantado pelo Cloud Manager, que, por sua vez, incorpora todos os pacotes de código e conteúdo necessários.

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

Inicialização do repositório snippet-repo-init

Os scripts de Inicialização de repositório que contêm os scripts de Inicialização de repositório são definidos no RepositoryInitializer Configuração de fábrica do OSGi por meio do scripts propriedade. Como esses scripts definidos nas configurações do OSGi, eles podem ser facilmente definidos pelo modo de execução usando o ../config.<runmode> semântica da pasta.

Como os scripts normalmente são declarações de várias linhas, é mais fácil defini-los na variável .config do que o arquivo baseado em JSON .cfg.json formato.

/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
"]

A variável scripts A propriedade OSGi contém diretivas conforme definidas pelo Idioma de inicialização do repositório do Apache Sling.

Pacote de estrutura do repositório xml-repository-structure-package

No ui.apps/pom.xml e qualquer outro pom.xml que declara um pacote de código (<packageType>application</packageType>), adicione a seguinte configuração de pacote de estrutura de repositório ao plug-in FileVault Maven. Você pode criar seu próprio pacote de estrutura de repositório para o projeto.

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

Incorporação de subpacotes no pacote de contêiner xml-embeddeds

No all/pom.xml, adicione o seguinte <embeddeds> diretivas para a filevault-package-maven-plugin declaração do plug-in. Lembre-se: não use o <subPackages> configuração. O motivo é porque inclui os subpacotes em /etc/packages em vez de /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>
...

Definição de filtro do pacote de contêiner xml-container-package-filters

No all do projeto filter.xml (all/src/main/content/jcr_root/META-INF/vault/definition/filter.xml), include qualquer -packages pastas que contêm subpacotes a serem implantados:

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

Se vários /apps/*-packages são usados nos destinos incorporados, todos eles devem ser enumerados aqui.

Repositórios Maven de terceiros xml-3rd-party-maven-repositories

No projeto do reator pom.xml, adicione as diretivas de repositório Maven públicas de terceiros necessárias. O conjunto <repository> A configuração do deve estar disponível no Provedor de repositório de terceiros.

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

Dependências de pacote entre o ui.apps de ui.content Pacotes xml-package-dependencies

No ui.content/pom.xml, adicione o seguinte <dependencies> diretivas para a filevault-package-maven-plugin declaração do plug-in.

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

Limpando a pasta de destino do projeto do contêiner xml-clean-container-package

No all/pom.xml, adicione o maven-clean-plugin plug-in que limpa o diretório de destino antes de uma compilação 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>

Recursos adicionais additional-resources