Show Menu
TÓPICOS×

Arquétipo de projeto do AEM

O AEM Project Archetype é um modelo Maven que cria um projeto Adobe Experience Manager (AEM) mínimo baseado em práticas recomendadas como ponto de partida para seu site.
O AEM mais recente do Project Archetype pode ser encontrado no GitHub .

Recursos

  • Documentação do Archetype (este documento): Visão geral da arquitetura de arquétipo e seus diferentes módulos.
  • Os seguintes tutoriais têm por base este arquétipo:

Recursos

  • Prática recomendada: Bootstrap de seu site com todas as práticas recomendadas para o Adobe.
  • Código baixo: Edite seus modelos, crie conteúdo, implante seu CSS e seu site está pronto para ser lançado.
  • Pronto para nuvem: Se desejar, use AEM como Cloud Service para entrar em funcionamento em poucos dias e facilitar a escalabilidade e a manutenção.
  • Dispatcher: Um projeto é concluído somente com uma configuração do Dispatcher que garante velocidade e segurança.
  • Vários sites: Se necessário, o arquétipo gera a estrutura de conteúdo para uma configuração msm.html de vários idiomas e várias regiões.
  • Componentes principais: Os autores podem criar praticamente qualquer layout com nosso conjunto versátil de componentes padronizados.
  • Modelos editáveis: Montar praticamente qualquer modelo sem código e definir o que os autores têm permissão para editar.
  • Layout responsivo: Em modelos ou páginas individuais, defina como os elementos refluem para os pontos de interrupção definidos.
  • Cabeçalho e rodapé: Monte e localize-os sem código, usando os recursos de localização dos componentes .
  • Sistema de estilo: Evite criar componentes personalizados permitindo que os autores apliquem estilos diferentes a eles.
  • Compilação front-end: Os desenvolvedores de front-end podem criar páginas AEM e criar bibliotecas clientes com Webpack, TypeScript e SASS.
  • WebApp-Ready: Para sites que usam React ou Angular , use o SDK do SPA para manter a criação no contexto do aplicativo .
  • Comércio ativado: Para projetos que desejam integrar AEM Comércio com soluções de comércio como o Magento usando os Componentes principais de comércio.
  • Exemplo de código: Faça check-out do componente HelloWorld e dos modelos de amostra, servlets, filtros e scheduleres.
  • Abrir Origem: Se algo não for como deveria, contribua para as suas melhorias!

Uso

Para gerar um projeto, ajuste a seguinte linha de comando de acordo com suas necessidades:
mvn -B archetype:generate \
 -D archetypeGroupId=com.adobe.aem \
 -D archetypeArtifactId=aem-project-archetype \
 -D archetypeVersion=24 \
 -D appTitle="My Site" \
 -D appId="mysite" \
 -D groupId="com.mysite" \

  • Definir aemVersion=cloud para AEM como Cloud Service ; Defina aemVersion=6.5.0 para Serviços gerenciados da Adobe ou no local. A dependência dos Componentes principais só é adicionada para versões aem não nuvem, pois os Componentes principais são fornecidos como OOTB para AEM como Cloud Service.
  • Ajuste appTitle="My Site" para definir o título do site e os grupos de componentes.
  • Ajuste appId="mysite" para definir a Maven artiactualId, os nomes de componentes, configurações e pastas de conteúdo, bem como os nomes da biblioteca do cliente.
  • Ajuste groupId="com.mysite" para definir Maven groupId e o Pacote de origem Java.
  • Pesquise a lista das propriedades disponíveis para ver se há mais itens que você deseja ajustar.

Propriedades disponíveis

Nome
Padrão
Descrição
appTitle
O título do aplicativo será usado para o título do site e grupos de componentes (por exemplo, "My Site" ).
appId
O nome técnico será usado para nomes de pastas de componentes, configurações e conteúdo, bem como para nomes de bibliotecas de clientes (por exemplo, "mysite" ).
artifactId
${appId}
ID de artefato de Maven de base (por exemplo, "mysite" ).
groupId
ID de grupo do Maven de base (por exemplo, "com.mysite" ).
package
${groupId}
Pacote de código-fonte Java (por exemplo, "com.mysite" ).
version
1.0-SNAPSHOT
Versão do projeto (por exemplo, 1.0-SNAPSHOT ).
aemVersion
cloud
Versão AEM público alvo (pode ser cloud para AEM como Cloud Service ; ou 6.5.0 , ou 6.4.4 para serviços gerenciados da Adobe ou no local).
sdkVersion
latest
Quando é possível especificar aemVersion=cloud uma versão SDK (por exemplo, 2020.02.2265.20200217T222518Z-200130 ).
includeDispatcherConfig
y
Inclui uma configuração de despachante para nuvem ou para AMS/no local, dependendo do valor de aemVersion (pode ser y ou n ).
frontendModule
general
Inclui um módulo de construção de front-end do Webpack que gera as bibliotecas do cliente (pode ser general ou none para sites regulares; pode ser angular ou react para um aplicativo de página única que implemente o Editor editor-overview.html SPA).
language
en
Código de idioma (ISO 639-1) para criar a estrutura de conteúdo de (por exemplo, en , deu ).
country
us
Código do país (ISO 3166-1) para criar a estrutura de conteúdo de (por exemplo, US ).
singleCountry
y
Inclui uma estrutura de conteúdo principal de idioma (pode ser y , ou n ).
includeExamples
n
Inclui um site de exemplo da Biblioteca de componentes (pode ser y , ou n ).
includeErrorHandler
n
Inclui uma página de resposta 404 personalizada que será global para a instância inteira (pode ser y ou n ).
includeCommerce
n
Inclui dependências CIF dos componentes principais e gera artefatos correspondentes.
commerceEndpoint
Obrigatório apenas para CIF. Ponto de extremidade opcional do serviço GraphQL do sistema de comércio a ser usado (por exemplo, https://hostname.com/grapql ).
datalayer
y
Ative a integração com a Camada de dados do cliente Adobe.
amp
n
Ative o suporte AMP para modelos de projeto gerados.

Requisitos do sistema

Arquétipo
AEM as a Cloud Service
AEM 6.5
AEM 6.4
Java SE
Maven
Contínuo
6.5.5.0+
6.4.8.1+
8, 11
3.3.9+
Configure seu ambiente de desenvolvimento local para AEM como um SDK Cloud Service ou para versões mais antigas de AEM .

Problemas conhecidos

Ao executar no Windows e gerar a configuração do dispatcher, você deve estar em execução em um prompt de comando elevado ou no Subsistema do Windows para Linux (consulte #329 ).
Ao executar o arquétipo no modo interativo (sem o -B parâmetro), as propriedades com valores padrão não podem ser alteradas, a menos que a confirmação final seja descartada, o que repete as perguntas ao incluir as propriedades com valores padrão nas perguntas (consulte ARCHETYPE-308 para obter detalhes).

Leitura adicional

Para obter mais detalhes sobre como usar o arquétipo, incluindo seus benefícios, opções e como seus módulos funcionam, consulte Usando o documento Archetype.