Configuração do projeto

Última atualização em 2024-01-26
  • Criado para:
  • Beginner
    Developer

Este tutorial aborda a criação de um projeto de vários módulos do Maven para gerenciar o código e as configurações de um site do Adobe Experience Manager.

Pré-requisitos

Analisar as ferramentas e instruções necessárias para a configuração de um ambiente de desenvolvimento local. Verifique se você tem uma nova instância do Adobe Experience Manager disponível localmente e se nenhum pacote de amostra/demonstração adicional foi instalado (além dos Service Packs necessários).

Objetivo

  1. Saiba como gerar um novo projeto AEM usando um arquétipo Maven.
  2. Entenda os diferentes módulos gerados pelo Arquétipo de projeto AEM e como eles trabalham juntos.
  3. Entenda como os Componentes principais do AEM são incluídos em um projeto AEM.

O que você vai criar

Neste capítulo, você gera um novo projeto do Adobe Experience Manager usando o Arquétipo de projeto AEM. Seu projeto AEM contém código, conteúdo e configurações completos usados para uma implementação do Sites. O projeto gerado neste capítulo serve como base para uma implementação do Site da WKND e será incorporado em capítulos futuros.

O que é um projeto Maven? - Apache Maven O é uma ferramenta de gerenciamento de software para criar projetos. Todos os Adobe Experience Manager As implementações do usam projetos Maven para criar, gerenciar e implantar código personalizado sobre o AEM.

O que é um arquétipo Maven? - A Arquétipo Maven é um modelo ou padrão para gerar novos projetos. O arquétipo do Projeto AEM ajuda a gerar um novo projeto com um namespace personalizado e inclui uma estrutura de projeto que segue as práticas recomendadas, acelerando bastante o desenvolvimento do projeto.

Criar o projeto

Há algumas opções para criar um projeto de vários módulos do Maven para AEM. Este tutorial usa o Arquétipo de projeto Maven AEM 35. O Cloud Manager também fornece um assistente de interface para iniciar a criação de um projeto de aplicativo AEM. O projeto subjacente gerado pela interface do usuário do Cloud Manager resulta na mesma estrutura que o uso direto do arquétipo.

OBSERVAÇÃO

Este tutorial usa a versão 35 do arquétipo. É sempre uma prática recomendada usar a variável mais recente do arquétipo para gerar um novo projeto.

A próxima série de etapas ocorrerá usando um terminal de linha de comando baseado em UNIX®, mas deverá ser semelhante se estiver usando um terminal Windows.

  1. Abra um terminal de linha de comando. Verifique se o Maven está instalado:

    $ mvn --version
    Apache Maven 3.6.2
    Maven home: /Library/apache-maven-3.6.2
    Java version: 11.0.4, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk-11.0.4.jdk/Contents/Home
    
  2. Navegue até o diretório em que deseja gerar o projeto AEM. Pode ser qualquer diretório no qual você deseja manter o código-fonte do projeto. Por exemplo, um diretório chamado code abaixo do diretório inicial do usuário:

    $ cd ~/code
    
  3. Cole o seguinte na linha de comando para gerar o projeto no modo de lote:

    mvn -B org.apache.maven.plugins:maven-archetype-plugin:3.2.1:generate \
        -D archetypeGroupId=com.adobe.aem \
        -D archetypeArtifactId=aem-project-archetype \
        -D archetypeVersion=39 \
        -D appTitle="WKND Sites Project" \
        -D appId="wknd" \
        -D groupId="com.adobe.aem.guides" \
        -D artifactId="aem-guides-wknd" \
        -D package="com.adobe.aem.guides.wknd" \
        -D version="0.0.1-SNAPSHOT" \
        -D aemVersion="cloud"
    
    OBSERVAÇÃO

    Para direcionar o AEM 6.5.14+, substitua aemVersion="cloud" com aemVersion="6.5.14".

    Além disso, sempre use o mais recente archetypeVersion por remissão para o Arquétipo de projeto AEM > Uso

    Uma lista completa de propriedades disponíveis para configurar um projeto pode ser encontrado aqui.

  4. A seguinte pasta e estrutura de arquivo são geradas pelo arquétipo Maven no sistema de arquivos local:

     ~/code/
        |--- aem-guides-wknd/
            |--- all/
            |--- core/
            |--- ui.apps/
            |--- ui.apps.structure/
            |--- ui.config/
            |--- ui.content/
            |--- ui.frontend/
            |--- ui.tests /
            |--- it.tests/
            |--- dispatcher/
            |--- pom.xml
            |--- README.md
            |--- .gitignore
    

Implantar e criar o projeto

Crie e implante o código do projeto em uma instância local do AEM.

  1. Verifique se você tem uma instância de autor do AEM em execução localmente na porta 4502.

  2. Na linha de comando, navegue até o aem-guides-wknd diretório do projeto.

    $ cd aem-guides-wknd
    
  3. Execute o seguinte comando para criar e implantar o projeto inteiro no AEM:

    $ mvn clean install -PautoInstallSinglePackage
    

    A build leva cerca de um minuto e deve terminar com a seguinte mensagem:

    ...
    [INFO] ------------------------------------------------------------------------
    [INFO] Reactor Summary for WKND Sites Project 0.0.1-SNAPSHOT:
    [INFO]
    [INFO] WKND Sites Project ................................. SUCCESS [  0.113 s]
    [INFO] WKND Sites Project - Core .......................... SUCCESS [  3.136 s]
    [INFO] WKND Sites Project - UI Frontend ................... SUCCESS [  4.461 s]
    [INFO] WKND Sites Project - Repository Structure Package .. SUCCESS [  0.359 s]
    [INFO] WKND Sites Project - UI apps ....................... SUCCESS [  1.732 s]
    [INFO] WKND Sites Project - UI content .................... SUCCESS [  0.956 s]
    [INFO] WKND Sites Project - UI config ..................... SUCCESS [  0.064 s]
    [INFO] WKND Sites Project - All ........................... SUCCESS [  8.229 s]
    [INFO] WKND Sites Project - Integration Tests ............. SUCCESS [  3.329 s]
    [INFO] WKND Sites Project - Dispatcher .................... SUCCESS [  0.027 s]
    [INFO] WKND Sites Project - UI Tests ...................... SUCCESS [  0.032 s]
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time:  23.189 s
    [INFO] Finished at: 2023-01-10T11:12:23-05:00
    [INFO] ------------------------------------------------------------------------
    

    O perfil Maven autoInstallSinglePackage compila os módulos individuais do projeto e implanta um único pacote na instância do AEM. Por padrão, esse pacote é implantado em uma instância AEM executada localmente na porta 4502 e com as credenciais de admin:admin.

  4. Navegue até o Gerenciador de pacotes na instância local do AEM: http://localhost:4502/crx/packmgr/index.jsp. Você deve ver pacotes para aem-guides-wknd.ui.apps, aem-guides-wknd.ui.config, aem-guides-wknd.ui.content, e aem-guides-wknd.all.

  5. Navegue até o console Sites: http://localhost:4502/sites.html/content. O site da WKND é um dos sites. Ele inclui uma estrutura de site com uma hierarquia dos EUA e de Idiomas principais. Esta hierarquia do site é baseada nos valores para language_country e isSingleCountryWebsite ao gerar o projeto usando o arquétipo.

  6. Abra o EUA > Inglês selecionando a página e clicando no ícone Editar botão na barra de menus:

    console do site

  7. O conteúdo inicial já foi criado e vários componentes estão disponíveis para serem adicionados a uma página. Experimente esses componentes para ter uma ideia da funcionalidade. Você aprenderá as noções básicas de um componente no próximo capítulo.

    Conteúdo inicial da página inicial

    Conteúdo de exemplo gerado pelo Arquétipo

Inspect do projeto

O projeto AEM gerado é composto de módulos Maven individuais, cada um com uma função diferente. Este tutorial e a maioria dos desenvolvimentos se concentram nestes módulos:

  • core - Código Java, principalmente desenvolvedores de back-end.

  • ui.frontend - Contém código-fonte para CSS, JavaScript, Sass, TypeScript, principalmente para desenvolvedores de front-end.

  • ui.apps - Contém definições de componentes e caixas de diálogo, incorpora CSS compilado e JavaScript como bibliotecas de clientes.

  • ui.content - contém conteúdo estrutural e configurações como modelos editáveis, esquemas de metadados (/content,%20/conf?lang=pt-BR).

  • all - é um módulo Maven vazio que combina os módulos acima em um único pacote que pode ser implantado em um ambiente AEM.

Diagrama de projeto Maven

Consulte a Documentação do Arquétipo de projeto do AEM para saber mais detalhes sobre all os módulos Maven.

Inclusão dos Componentes principais

Componentes principais do AEM são um conjunto de componentes padronizados de Gerenciamento de Conteúdo na Web (WCM, Web Content Management) para AEM. Esses componentes fornecem um conjunto de linha de base de uma funcionalidade e são estilizados, personalizados e estendidos para projetos individuais.

O ambiente as a Cloud Service do AEM inclui a versão mais recente do Componentes principais do AEM. Portanto, os projetos gerados para o AEM as a Cloud Service fazem não incluir uma incorporação dos Componentes principais do AEM.

Para projetos gerados pelo AEM 6.5/6.4, o arquétipo incorpora automaticamente Componentes principais do AEM no projeto. É uma prática recomendada para o AEM 6.5/6.4 incorporar os Componentes principais do AEM para garantir que a versão mais recente seja implantada com o seu projeto. Mais informações sobre como os Componentes principais são incluídos no projeto podem ser encontrados aqui.

Gerenciamento do Controle do Código-Fonte

É sempre uma boa ideia usar alguma forma de controle do código-fonte para gerenciar o código em seu aplicativo. Este tutorial usa Git e GitHub. Há vários arquivos que são gerados pelo Maven e/ou pelo IDE de escolha que devem ser ignorados pelo SCM.

O Maven cria uma pasta de destino sempre que você cria e instala o pacote de código. A pasta de destino e o conteúdo devem ser excluídos do SCM.

Em, a variável ui.apps módulo observe que muitos .content.xml arquivos são criados. Esses arquivos XML mapeiam os tipos de nó e as propriedades do conteúdo instalado no JCR. Esses arquivos são essenciais e não é possível ser ignorada.

O arquétipo do projeto AEM gera uma amostra .gitignore arquivo que pode ser usado como ponto de partida para o qual os arquivos podem ser ignorados com segurança. O arquivo é gerado em <src>/aem-guides-wknd/.gitignore.

Parabéns.

Parabéns, você criou seu primeiro projeto AEM!

Próximas etapas

Compreender a tecnologia subjacente de um componente de sites do Adobe Experience Manager (AEM) por meio de uma HelloWorld exemplo com o Noções básicas sobre componentes tutorial.

Comandos Maven avançados (Bônus)

Durante o desenvolvimento, você pode estar trabalhando apenas com um dos módulos e deseja evitar criar o projeto inteiro para economizar tempo. Talvez você também queira implantar diretamente em uma instância de publicação do AEM ou talvez em uma instância do AEM que não esteja em execução na porta 4502.

Em seguida, vamos rever alguns perfis e comandos Maven adicionais que você pode usar para obter mais flexibilidade durante o desenvolvimento.

Módulo principal

A variável core contém todo o código Java™ associado ao projeto. A criação de core O módulo implanta um pacote OSGi no AEM. Para criar apenas este módulo:

  1. Navegue até o core pasta (abaixo de aem-guides-wknd):

    $ cd core/
    
  2. Execute o seguinte comando:

    $ mvn clean install -PautoInstallBundle
    ...
    [INFO] --- sling-maven-plugin:2.4.0:install (install-bundle) @ aem-guides-wknd.core ---
    [INFO] Installing Bundle aem-guides-wknd.core(~/code/aem-guides-wknd/core/target/aem-guides-wknd.core-0.0.1-SNAPSHOT.jar) to http://localhost:4502/system/console via WebConsole
    [INFO] Bundle installed
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time:  8.558 s
    
  3. Navegue até http://localhost:4502/system/console/bundles. Este é o console OSGi da Web e contém informações sobre todos os pacotes instalados na instância do AEM.

  4. Alterne a ID classificar e você verá o pacote WKND instalado e ativo.

    Pacote principal

  5. Você pode ver a localização "física" do jar em CRXDE-Lite:

    Localização do CRXDE no Jar

Módulos Ui.apps e Ui.content

A variável ui.apps o módulo maven contém todo o código de renderização necessário para o site sob /apps. Isso inclui CSS/JS armazenado em um formato AEM chamado clientlibs. Isso também inclui HTL scripts para renderização de HTML dinâmico. Pense no ui.apps módulo como um mapa para a estrutura no JCR, mas em um formato que pode ser armazenado em um sistema de arquivos e comprometido com o controle de origem. A variável ui.apps o módulo contém apenas o código.

Para criar apenas este módulo:

  1. Na linha de comando. Navegue até o ui.apps pasta (abaixo de aem-guides-wknd):

    $ cd ../ui.apps
    
  2. Execute o seguinte comando:

    $ mvn clean install -PautoInstallPackage
    ...
    Package installed in 70ms.
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD SUCCESS
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time:  2.987 s
    [INFO] Finished at: 2023-01-10T11:35:28-05:00
    [INFO] ------------------------------------------------------------------------
    
  3. Navegue até http://localhost:4502/crx/packmgr/index.jsp. Você deve ver o ui.apps pacote como o primeiro pacote instalado e deve ter um carimbo de data e hora mais recente do que qualquer outro pacote.

    Pacote Ui.apps instalado

  4. Retorne à linha de comando e execute o seguinte comando (dentro do ui.apps pasta):

    $ mvn -PautoInstallPackagePublish clean install
    ...
    [INFO] --- content-package-maven-plugin:1.0.2:install (install-package-publish) @ aem-guides-wknd.ui.apps ---
    [INFO] Installing aem-guides-wknd.ui.apps (/Users/sachinmali/Desktop/code/wknd-tutorial/aem-guides-wknd/ui.apps/target/aem-guides-wknd.ui.apps-0.0.1-SNAPSHOT.zip) to http://localhost:4503/crx/packmgr/service.jsp
    [INFO] I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
    [INFO] Retrying request
    [INFO] I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
    [INFO] Retrying request
    [INFO] I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
    [INFO] Retrying request
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD FAILURE
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time:  2.812 s
    [INFO] Finished at: 2023-01-10T11:37:28-05:00
    [INFO] ------------------------------------------------------------------------
    [ERROR] Failed to execute goal com.day.jcr.vault:content-package-maven-plugin:1.0.2:install (install-package-publish) on project aem-guides-wknd.ui.apps: Connection refused (Connection refused) -> [Help 1]
    

    O perfil autoInstallPackagePublish O deve implantar o pacote em um ambiente de publicação em execução na porta 4503. O erro acima é esperado se uma instância do AEM em execução em http://localhost:4503 não puder ser encontrada.

  5. Por fim, execute o seguinte comando para implantar o ui.apps pacote na porta 4504:

    $ mvn -PautoInstallPackage clean install -Daem.port=4504
    ...
    [INFO] --- content-package-maven-plugin:1.0.2:install (install-package) @ aem-guides-wknd.ui.apps ---
    [INFO] Installing aem-guides-wknd.ui.apps (/Users/dgordon/code/aem-guides-wknd/ui.apps/target/aem-guides-wknd.ui.apps-0.0.1-SNAPSHOT.zip) to http://localhost:4504/crx/packmgr/service.jsp
    [INFO] I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
    [INFO] Retrying request
    [INFO] I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
    [INFO] Retrying request
    [INFO] I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
    [INFO] Retrying request
    [INFO] ------------------------------------------------------------------------
    [INFO] BUILD FAILURE
    [INFO] --------------------------------------------------------------------
    

    Novamente, espera-se que ocorra uma falha de criação se nenhuma instância do AEM estiver em execução na porta 4504 está disponível. O parâmetro aem.port está definido no arquivo POM em aem-guides-wknd/pom.xml.

A variável ui.content O módulo está estruturado da mesma forma que a variável ui.apps módulo. A única diferença é que a ui.content O módulo contém o que é conhecido como mutável conteúdo. Mutável o conteúdo se refere essencialmente a configurações não relacionadas a código, como Modelos, Políticas ou estruturas de pastas armazenadas no controle do código-fonte mas pode ser modificado diretamente em uma instância do AEM. Isso é explorado com mais detalhes no capítulo sobre Páginas e modelos.

Os mesmos comandos Maven usados para criar o ui.apps o módulo pode ser usado para criar o ui.content módulo. Sinta-se à vontade para repetir as etapas acima dentro do ui.content pasta.

Resolução de problemas

Se houver um problema ao gerar o projeto usando o Arquétipo de projeto AEM, consulte a lista de problemas conhecidos e lista de aberturas problemas.

Parabéns novamente!

Parabéns, por ter passado pelo material bônus.

Próximas etapas

Compreender a tecnologia subjacente de um componente de sites do Adobe Experience Manager (AEM) por meio de uma HelloWorld exemplo com o Noções básicas sobre componentes tutorial.

Nesta página