DocumentaçãoAEM 6.5Guia do usuário

Desenvolvimento de SPAs para o AEM developing-spas-for-aem

Last update: Tue Jun 17 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Aplica-se a:
  • Experience Manager 6.5
  • Tópicos:

Criado para:

  • Desenvolvedor

Aplicativos de página única (SPAs) podem oferecer experiências interessantes para usuários de sites. Os desenvolvedores desejam criar sites usando estruturas SPA, e os autores desejam editar o conteúdo no Adobe Experience Manager (AEM) para um site criado usando essas estruturas.

Este artigo apresenta perguntas importantes a serem consideradas ao envolver um desenvolvedor de front-end para desenvolver um SPA para o AEM e fornece uma visão geral da arquitetura do AEM com relação à implantação de SPAs no AEM.

IMPORTANT
O Editor de SPA foi descontinuado para novos projetos. Ele ainda é suportado pela Adobe para projetos existentes, mas não deve ser usado para novos projetos. Os editores preferidos para gerenciar conteúdo headless no AEM agora são:

Princípios de desenvolvimento de SPA para AEM spa-development-principles-for-aem

O desenvolvimento de aplicativos de página única no AEM parte do princípio de que o desenvolvedor de front-end segue as práticas recomendadas padronizadas ao criar um SPA. Se você, como desenvolvedor front-end, seguir essas práticas recomendadas gerais e alguns princípios específicos do AEM, seu SPA estará funcional com o AEM e seus recursos de criação de conteúdo.

  • Portabilidade - Como com qualquer componente, os componentes devem ser compilados para serem o mais portáteis possível. O SPA deve ser desenvolvido com componentes portáteis e reutilizáveis.
  • AEM controla a estrutura do site - O desenvolvedor de front-end cria componentes e tem a propriedade de sua estrutura interna, mas depende do AEM para definir a estrutura de conteúdo do site.
  • Renderização dinâmica - Todas as renderizações devem ser dinâmicas.
  • Roteamento dinâmico - O SPA é responsável pelo roteamento e a AEM o escuta e busca com base nele. Qualquer roteamento também deve ser dinâmico.

Se você considerar esses princípios ao desenvolver seu SPA, ele será o mais flexível e inovador possível e, ao mesmo tempo, ativará todas as funcionalidades de criação compatíveis do AEM.

Se você não precisar oferecer suporte aos recursos de criação do AEM, talvez precise considerar um modelo de design de SPA diferente.

Portabilidade portability

Assim como no desenvolvimento de qualquer componente, seus componentes devem ser projetados de forma a maximizar sua portabilidade. Quaisquer padrões que funcionem contra a portabilidade ou reutilização dos componentes devem ser evitados para garantir a compatibilidade, a flexibilidade e a manutenção no futuro.

O SPA resultante deve ser construído com componentes altamente portáteis e reutilizáveis.

Estrutura do site de unidades AEM aem-drives-site-structure

O desenvolvedor de front-end deve se considerar responsável pela criação de uma biblioteca de componentes de SPA que são usados para criar o aplicativo. O desenvolvedor de front-end tem controle total da estrutura interna dos componentes. No entanto, a AEM sempre é proprietária da estrutura do site.

Isso significa que o desenvolvedor de front-end pode adicionar conteúdo do cliente antes ou depois do ponto de entrada dos componentes e também pode fazer chamadas de terceiros dentro do componente. No entanto, o desenvolvedor de front-end não tem controle total sobre como os componentes se aninham, por exemplo.

Renderização dinâmica dynamic-rendering

O SPA deve depender apenas da renderização dinâmica do conteúdo. Essa é a expectativa padrão em que o AEM busca e renderiza todos os filhos da estrutura de conteúdo.

Qualquer renderização explícita que aponte para um conteúdo específico é considerada renderização estática e, embora suportada, não será compatível com os recursos de criação de conteúdo do AEM. Isso também vai contra o princípio de portabilidade.

Roteamento Dinâmico dynamic-routing

Assim como na renderização, todo o roteamento também deve ser dinâmico. No AEM, o SPA sempre deve ser o proprietário do roteamento, e o AEM escuta e busca conteúdo com base nele.

Qualquer roteamento estático funciona contra o princípio de portabilidade e limita o autor por não ser compatível com os recursos de criação de conteúdo do AEM. Por exemplo, com o roteamento estático, se o autor de conteúdo quiser alterar uma rota ou alterar uma página, ele terá que solicitar que o desenvolvedor de front-end faça isso.

Arquétipo de projeto do AEM aem-project-archetype

Qualquer projeto do AEM deve utilizar o Arquétipo de projeto do AEM, que aceita projetos SPA que usam o React ou o Angular e utiliza o SDK de SPA.

Modelos de design de SPA spa-design-models

Se os princípios de desenvolvimento de SPAs no AEM forem seguidos, seu SPA estará funcional com todos os recursos de criação de conteúdo do AEM com suporte.

Pode haver casos em que isso não seja totalmente necessário. A tabela a seguir fornece uma visão geral dos vários modelos de design, suas vantagens e suas desvantagens.

Modelo de design
Vantagens
Desvantagens
O AEM é usado como um CMS headless sem usar a estrutura SDK do Editor SPA.
O desenvolvedor front-end tem controle total sobre o aplicativo.

Os autores de conteúdo não podem usar a experiência de criação de conteúdo do AEM.

O código não é portátil nem reutilizável se contiver referências estáticas ou roteamento.

Não permite o uso do editor de modelos, portanto, o desenvolvedor de front-end deve manter modelos editáveis por meio do JCR.

O desenvolvedor de front-end usa a estrutura SDK do Editor de SPA, mas abre apenas algumas áreas para o autor de conteúdo.
O desenvolvedor mantém controle sobre o aplicativo, habilitando apenas a criação em áreas restritas do aplicativo.

Os autores de conteúdo estão restritos a um conjunto limitado de experiência de criação de conteúdo do AEM.

O código corre o risco de não ser portátil nem reutilizável se contiver referências estáticas ou roteamento.

Não permite o uso do editor de modelos, portanto, o desenvolvedor de front-end deve manter modelos editáveis por meio do JCR.

O projeto usa totalmente o Editor de SPA SDK, e os componentes de front-end são desenvolvidos como uma biblioteca e a estrutura de conteúdo do aplicativo é delegada ao AEM.

O aplicativo é reutilizável e portátil.

O autor de conteúdo pode editar o aplicativo usando a experiência de criação de conteúdo do AEM.

O SPA é compatível com o editor de modelo.

O desenvolvedor não controla a estrutura do aplicativo e a parte do conteúdo delegada ao AEM.

O desenvolvedor ainda pode reservar áreas do aplicativo para o conteúdo que não deve ser criado usando o AEM.

NOTE
Embora todos os modelos sejam compatíveis com o AEM, somente implementando o terceiro (e, portanto, seguindo os princípios de desenvolvimento de SPA recomendados no AEM), os autores de conteúdo podem interagir com o SPA e editar seu conteúdo no AEM da maneira como estão acostumados.

Migração de SPAs existentes para o AEM migrating-existing-spas-to-aem

Geralmente, se o SPA seguir os Princípios de desenvolvimento de SPA para o AEM, ele funcionará no AEM e poderá ser editado usando o Editor de SPA do AEM.

Siga estas etapas para preparar seu SPA existente para funcionar com o AEM.

  1. Torne seus componentes JS modulares.

    Torne-os capazes de ser renderizados em qualquer ordem, posição e tamanho.

  2. Use os contêineres fornecidos pelo SDK do Adobe para colocar seus componentes na tela.

    O AEM fornece um componente de sistema de página e parágrafo para você usar.

  3. Crie um componente do AEM para cada componente JS.

    Os componentes do AEM definem a caixa de diálogo e a saída JSON.

Instruções para desenvolvedores de front-end instructions-for-front-end-developers

A principal tarefa em envolver um desenvolvedor de front-end para criar um SPA para o AEM é concordar com os componentes e seus modelos JSON.

A seguir, um resumo das etapas que um desenvolvedor de front-end precisa seguir ao desenvolver um SPA para AEM.

  1. Concordar sobre os componentes e seu modelo JSON

    Os desenvolvedores de front-end e de back-end do AEM precisam concordar sobre quais componentes são necessários e um modelo para que haja uma correspondência individualizada entre os componentes de SPA e os componentes de back-end.

    Os componentes do AEM ainda são necessários, principalmente para fornecer caixas de diálogo de edição e exportar o modelo de componente.

  2. Em componentes do React, acesse o modelo viathis.props.cqModel

    Quando os componentes forem acordados e o modelo JSON estiver em vigor, o desenvolvedor de front-end poderá desenvolver o SPA e simplesmente acessar o modelo JSON por meio de this.props.cqModel.

  3. Implementar o método render() do componente

    O desenvolvedor de front-end implementa o método render() da maneira que ele achar adequada e pode usar os campos da propriedade cqModel. Isso gera o DOM e os fragmentos do HTML inseridos na página. Essa é a maneira padrão de criar um aplicativo no React.

  4. Mapear o componente para o tipo de recurso do AEM viaMapTo()

    O mapeamento armazena classes de componente e é usado internamente pelo componente Container fornecido para recuperar e instanciar dinamicamente componentes com base no tipo de recurso fornecido.

    Isso serve como "cola" entre o front-end e o back-end, para que o editor saiba a quais componentes os componentes de reação correspondem.

    Page e ResponsiveGrid são bons exemplos de classes que estendem a base Container.

  5. Definir EditConfig do componente como parâmetro paraMapTo()

    Esse parâmetro é necessário para informar ao editor como o componente deve ser nomeado, desde que ainda não tenha sido renderizado ou não tenha conteúdo para renderizar.

  6. Estender a classe Container fornecida para páginas e contêineres

    Os sistemas de páginas e parágrafos devem estender essa classe para que a delegação para componentes internos funcione conforme esperado.

  7. Implementar uma solução de roteamento que use a API History do HTML5.

    Quando o ModelRouter está habilitado, chamar as funções pushState e replaceState aciona uma solicitação ao PageModelManager para buscar um fragmento ausente do modelo.

    A versão atual do ModelRouter dá suporte apenas ao uso de URLs que apontam para o caminho de recurso real dos pontos de entrada do Modelo Sling. Ele não é compatível com o uso de URLs ou aliases personalizados.

    O ModelRouter pode ser desabilitado ou configurado para ignorar uma lista de expressões regulares.

AEM-Agnostic aem-agnostic

Esses blocos de código ilustram como os componentes do React e do Angular não precisam de nada específico do Adobe ou do AEM.

  • Tudo o que está dentro do componente do JavaScript é independente de AEM.
  • No entanto, o que é específico do AEM é que o componente JS deve ser mapeado para um componente AEM com o auxiliar MapTo.

screen_shot_2018-12-11at144019

O auxiliar do MapTo é a "cola" que permite que os componentes de back-end e front-end sejam combinados:

  • Informa ao contêiner JS (ou sistema de parágrafo JS) qual componente JS é responsável pela renderização de cada um dos componentes presentes no JSON.
  • Ele adiciona um atributo de dados do HTML à HTML que o componente JS renderiza, para que o Editor de SPA saiba qual caixa de diálogo exibir para o autor ao editar o componente.

Para obter mais informações sobre como usar o MapTo e criar SPAs para o AEM em geral, consulte o guia de Introdução da estrutura escolhida.

Arquitetura do AEM e SPAs aem-architecture-and-spas

A arquitetura geral do AEM, incluindo ambientes de desenvolvimento, criação e publicação, não é alterada ao usar SPAs. No entanto, é útil entender como o desenvolvimento de SPA se encaixa nessa arquitetura.

screen_shot_2018-12-11at145348

  • Ambiente de compilação

    É aqui que a origem da origem do aplicativo SPA e a origem do componente são verificadas.

    • O gerador de clientlib do NPM cria uma biblioteca do cliente a partir do projeto SPA.
    • Essa biblioteca é retirada pelo Maven e implantada pelo plug-in Maven Build junto com o componente no autor do AEM.

  • Autor do AEM

    O conteúdo é criado no autor do AEM, incluindo a criação de SPAs.

    Quando um SPA é editado usando o Editor de SPA no ambiente de criação:

    1. O SPA solicita o HTML externo.
    2. O CSS é carregado.
    3. O JavaScript do aplicativo SPA é carregado.
    4. Quando o aplicativo SPA é executado, o JSON é solicitado, permitindo que o aplicativo crie o DOM da página, incluindo os atributos cq-data.
    5. Esses atributos cq-data permitem que o editor carregue informações de página adicionais para que saiba quais configurações de edição estão disponíveis para os componentes.

  • Publicação AEM

    É aqui que o conteúdo criado e as bibliotecas compiladas, incluindo artefatos de aplicativos SPA, clientlibs e componentes, são publicados para consumo público.

  • Dispatcher/CDN

    O Dispatcher serve como a camada de cache do AEM para os visitantes do site.

    • As solicitações são processadas de forma semelhante à do Autor do AEM. No entanto, não há solicitação de informações da página, pois elas são necessárias somente para o editor.
    • JavaScript, CSS, JSON e HTML são armazenados em cache, otimizando a página para entrega rápida.
NOTE
No AEM, não há necessidade de executar os mecanismos de criação do JavaScript ou executar o próprio JavaScript. O AEM só hospeda os artefatos compilados do aplicativo SPA.

Próximas etapas next-steps

Para obter uma visão geral de como um SPA simples no AEM é estruturado e como ele funciona, consulte o guia de introdução para React e Angular.

Para obter um guia passo a passo sobre como criar seu próprio SPA, consulte a Introdução ao AEM SPA Editor - Tutorial de eventos do WKND.

Para obter mais detalhes sobre o modelo dinâmico para mapeamento de componentes e como ele funciona em SPAs no AEM, consulte o artigo Modelo dinâmico para mapeamento de componentes para SPAs.

Se você quiser implementar SPAs no AEM para uma estrutura diferente do React ou do Angular ou simplesmente quiser se aprofundar em como o SDK SPA para AEM funciona, consulte o artigo Blueprint de SPA.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2