Desenvolvimento de SPA para AEM

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 com facilidade no AEM para um site criado usando essas estruturas.

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

OBSERVAÇÃO

O Editor de SPA é a solução recomendada para projetos que exigem renderização do lado do cliente baseada em SPA estrutura (por exemplo, Reagir ou Angular).

Princípios de desenvolvimento SPA para AEM

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

  • Portabilidade - Assim como com qualquer componente, os componentes devem ser construídos para serem tão portáteis quanto possível. A SPA deve ser criada com componentes portáveis e reutilizáveis.
  • AEM orienta a estrutura do site - o desenvolvedor front-end cria componentes e é proprietário 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 AEM o escuta e busca com base nele. Qualquer roteamento também deve ser dinâmico.

Caso tenha esses princípios em mente ao desenvolver seu SPA, ele será o mais flexível e uma prova futura possível, além de ativar todas as funcionalidades de criação AEM compatíveis.

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

Portabilidade

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

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

AEM unidades Estrutura do Site

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

Isso significa que o desenvolvedor de front-end pode adicionar conteúdo de 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 são aninhados, por exemplo.

Renderização dinâmica

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 seja suportada, não será compatível com AEM recursos de criação de conteúdo. Isso também vai contra o princípio de portability.

Roteamento dinâmico

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

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

Arquétipo de projeto do AEM

Qualquer projeto AEM deve aproveitar o AEM Arquétipo de projeto, que suporta projetos SPA usando React ou Angular e aproveita o SDK SPA.

Modelos de design de SPA

Se os princípios de desenvolvimento de SPA no AEM forem seguidos, seu SPA funcionará com todos os recursos de criação de conteúdo AEM compatíveis.

No entanto, pode haver casos em que tal não seja totalmente necessário. A tabela a seguir apresenta uma visão geral dos vários modelos de design, suas vantagens e suas desvantagens.

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

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

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 modelo, portanto, o desenvolvedor de front-end deve manter modelos editáveis por meio do JCR.

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

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

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

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

O projeto aproveita totalmente o SDK do Editor de SPA e os componentes de primeiro plano são desenvolvidos como uma biblioteca e a estrutura de conteúdo do aplicativo é delegada à AEM.

O aplicativo é reutilizável e portátil.

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

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

O desenvolvedor não está no controle da estrutura do aplicativo e da 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.

OBSERVAÇÃO

Embora todos os modelos sejam compatíveis com o AEM, somente ao implementar o terceiro (e, portanto, seguir os SPA princípios de desenvolvimento recomendados no AEM), os autores de conteúdo poderão interagir e editar o conteúdo do SPA no AEM à medida que estiverem acostumados.

Migrando SPA existentes para AEM

Geralmente, se o SPA seguir os Princípios de desenvolvimento SPA para AEM, o SPA funcionará em AEM e poderá ser editado usando o editor de SPA de AEM.

Siga estas etapas para preparar seu SPA existente para trabalhar 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 para colocar seus componentes na tela.

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

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

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

Instruções para desenvolvedores front-end

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

Veja a seguir um esboço das etapas que um desenvolvedor de front-end precisa seguir ao desenvolver um SPA para AEM.

  1. Concordar em componentes e em seu modelo JSON

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

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

  2. Nos componentes React , acesse o modelo por meio dethis.props.cqModel

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

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

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

  4. Mapeie o componente para o tipo de recurso AEM por meio deMapTo()

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

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

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

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

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

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

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

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

    Quando ModelRouter estiver ativado, chamar as funções pushState e replaceState acionará uma solicitação para PageModelManager para buscar um fragmento ausente do modelo.

    A versão atual do ModelRouter suporta apenas o uso de URLs que apontam para o caminho de recurso real dos pontos de entrada do Modelo do Sling. Não é compatível com o uso de URLs personalizados ou aliases.

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

AEM-Agnóstico

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

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

screen_shot_2018-12-11at144019

A ajuda MapTo é a "cola" que permite que os componentes de back-end e de 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 HTML ao 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 MapTo e criar SPA para AEM em geral, consulte o guia de Introdução para a estrutura escolhida.

Arquitetura AEM e SPA

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

screen_shot_2018-12-11at145348

  • Ambiente de build

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

    • O gerador clientlib do NPM cria uma biblioteca do cliente do projeto do SPA.
    • Essa biblioteca será obtida pelo Maven e implantada pelo plug-in Maven Build, juntamente com o componente para o autor do AEM.
  • AEM Author

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

    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 de 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 ele saiba quais configurações de edição estão disponíveis para os componentes.
  • AEM Publish

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

  • Dispatcher / CDN

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

    • As solicitações são processadas de forma semelhante à forma como estão no Autor do AEM, no entanto, não há solicitação das informações da página, pois isso só é necessário para o editor.
    • Javascript, CSS, JSON e HTML são armazenados em cache, otimizando a página para entrega rápida.
OBSERVAÇÃO

No AEM, não há necessidade de executar mecanismos de criação do Javascript ou executar o próprio Javascript. AEM hospeda somente os artefatos compilados do aplicativo SPA.

Próximas etapas

Para obter uma visão geral de como um SPA simples no AEM está estruturado e como 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 o Guia de Introdução ao Editor de SPA AEM - Tutorial de eventos WKND.

Para obter mais detalhes sobre o modelo dinâmico para mapeamento de componentes e como ele funciona em SPA em AEM, consulte o artigo Dynamic Model to Component Mapping for SPA.

Se desejar implementar o SPA no AEM para uma estrutura diferente de React ou Angular ou simplesmente quiser aprofundar como o SDK SPA para AEM funciona, consulte o artigo SPA Blueprint.

Nesta página