Renderização de SPA e do lado do servidor

OBSERVAÇÃO

O recurso Editor de aplicativo de página única (SPA) requer AEM service pack 2 ou mais recente do 6.4.

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

OBSERVAÇÃO

AEM 6.4.5.0 ou posterior é necessário para usar os recursos de renderização do lado do servidor SPA conforme descrito neste documento.

Visão geral

Aplicativos de página única (SPA) podem oferecer ao usuário experiências ricas e dinâmicas que reagem e se comportam de formas familiares, normalmente como aplicativos nativos. Isso é feito contando com o cliente para carregar o conteúdo antecipadamente e, em seguida, fazer o trabalho pesado de lidar com a interação do usuário e, assim, minimizar a quantidade de comunicação necessária entre o cliente e o servidor, tornando o aplicativo mais reativo.

No entanto, isso pode levar a tempos de carregamento iniciais mais longos, especialmente se o SPA for grande e rico em seu conteúdo. Para otimizar os tempos de carregamento, parte do conteúdo pode ser renderizado no lado do servidor. O uso da renderização do lado do servidor (SSR) pode acelerar a carga inicial da página e, em seguida, transmitir mais renderização para o cliente.

Quando utilizar o SSR

A RSS não é necessária em todos os projetos. Embora o AEM seja totalmente compatível com o JS SSR para SPA, o Adobe não recomenda implementá-lo sistematicamente para cada projeto.

Ao decidir implementar a SSR, você deve primeiro estimar qual complexidade adicional, esforço e custo adicional a SSR representa realisticamente para o projeto, incluindo a manutenção de longo prazo. Uma arquitetura RSS só deve ser escolhida quando o valor acrescentado exceder claramente os custos estimados.

O SSR geralmente fornece algum valor quando há um claro "sim" para qualquer uma das seguintes perguntas:

  • SEO: o SSR ainda é necessário para que seu site seja indexado corretamente pelos mecanismos de pesquisa que trazem tráfego? Lembre-se de que os principais rastreadores de mecanismo de pesquisa agora avaliam o JS.
  • Velocidade da página: o SSR fornece uma melhoria de velocidade mensurável em ambientes reais e adiciona à experiência geral do usuário?

Somente quando uma dessas duas perguntas for respondida com um "sim" claro para o seu projeto o Adobe recomenda a implementação do SSR. As seções a seguir descrevem como fazer isso usando o Adobe I/O Runtime.

Adobe I/O Runtime

Se você está confiante de que seu projeto requer a implementação do SSR, a solução recomendada do Adobe é usar o Adobe I/O Runtime.

Para obter mais informações sobre o Adobe I/O Runtime, consulte

As seções a seguir detalham como o Adobe I/O Runtime pode ser usado para implementar o SSR para seu SPA em dois modelos diferentes:

OBSERVAÇÃO

O Adobe recomenda um espaço de trabalho Adobe I/O Runtime separado por ambiente (estágio, produção, teste etc.). Isso permite padrões típicos de ciclo de vida de desenvolvimento de sistemas (SDLC) com diferentes versões de um único aplicativo implantado em diferentes ambientes. Consulte o documento CI/CD para Project Firefly Applications para obter mais informações.

Um espaço de trabalho separado não é necessário por instância (autor, publicação), a menos que haja diferenças na implementação de tempo de execução por tipo de instância.

Configuração do renderizador de conteúdo remoto

AEM deve saber onde o conteúdo renderizado remotamente pode ser recuperado. Independentemente de que modelo você escolher implementar para SSR, será necessário especificar para AEM como acessar esse serviço de renderização remota.

Isso é feito por meio do serviço OSGi RemoteContentRenderer - Configuration Fatory. Procure a string "RemoteContentRenderer" no console Configuração do console da Web em http://<host>:<port>/system/console/configMgr.

Os seguintes campos estão disponíveis para a configuração:

  • Padrão de caminho de conteúdo - Expressão regular para corresponder a uma parte do conteúdo, se necessário
  • URL do endpoint remoto - URL do endpoint responsável pela geração do conteúdo
    • Use o protocolo HTTPS seguro se não estiver na rede local.
  • Cabeçalhos de solicitação adicionais - Cabeçalhos adicionais a serem adicionados à solicitação enviada ao endpoint remoto
    • Padrão: key=value
  • Tempo limite da solicitação - Tempo limite da solicitação do host remoto em milissegundos
OBSERVAÇÃO

Independentemente de você optar por implementar o fluxo de comunicação orientado por AEM ou o fluxo orientado por Adobe I/O Runtime, deverá definir uma configuração de renderizador de conteúdo remoto.

Essa configuração também deve ser definida se você optar por usar um servidor Node.js personalizado.

OBSERVAÇÃO

Essa configuração aproveita o Renderizador de conteúdo remoto, que tem opções adicionais de extensão e personalização disponíveis.

Fluxo de comunicação orientado por AEM

Ao usar o SSR, o fluxo de trabalho de interação do componente do SPA no AEM inclui uma fase na qual o conteúdo inicial do aplicativo é gerado pelo Adobe I/O Runtime.

  1. O navegador solicita o conteúdo SSR do AEM.
  2. AEM publica o modelo no Adobe I/O Runtime.
  3. O Adobe I/O Runtime retorna o conteúdo gerado
  4. AEM serve o HTML retornado pelo Adobe I/O Runtime por meio do template HTL do componente de página de back-end.

server-side-rendering-cms-drivenaemnode

Fluxo de comunicação orientado pela Adobe I/O Runtime

A seção Fluxo de comunicação orientado por AEM descreve a implementação padrão e recomendada da renderização do lado do servidor no que diz respeito a SPA no AEM, onde AEM executa o bootstrapping e a veiculação de conteúdo.

Como alternativa, o SSR pode ser implementado para que a Adobe I/O Runtime seja responsável pelo bootstrapping, revertendo efetivamente o fluxo de comunicação.

Ambos os modelos são válidos e aceitos pela AEM. No entanto, deve-se considerar as vantagens e desvantagens de cada um antes de implementar um modelo específico.

Bootstrapping Vantagens Desvantagens
via AEM O AEM gerencia bibliotecas injetáveis onde necessário
Os recursos precisam ser mantidos apenas no AEM
Possivelmente desconhecido do desenvolvedor SPA
via Adobe I/O Runtime Mais familiar aos desenvolvedores de SPA Os recursos clientlib necessários para o aplicativo, como CSS e JavaScript, precisarão ser disponibilizados pelo desenvolvedor AEM por meio da propriedade allowProxy
Resources devem ser sincronizados entre AEM e Adobe I/O Runtime
Para habilitar a criação do SPA, pode ser necessário um servidor proxy para Adobe I/O Runtime

Planejamento para SSR

Geralmente, apenas parte de um aplicativo precisa ser renderizada no lado do servidor. O exemplo comum é o conteúdo que será exibido acima da dobra no carregamento inicial da página que precisa ser renderizado no lado do servidor. Isso economiza tempo fornecendo ao cliente conteúdo já renderizado. Conforme o usuário interage com a SPA, o conteúdo adicional é renderizado pelo cliente.

Ao considerar a implementação da renderização do lado do servidor para o seu SPA, é necessário revisar quais partes do aplicativo serão necessárias para SSR.

Desenvolvimento de um SPA usando SSR

SPA componentes podem ser renderizados pelo cliente (no navegador) ou pelo lado do servidor. Quando renderizado no lado do servidor, as propriedades do navegador, como tamanho e local da janela, não estarão presentes. Por conseguinte, os componentes SPA devem ser isóficos, não assumindo qualquer hipótese quanto ao local em que serão apresentados.

Para usar o SSR, será necessário implantar seu código no AEM e no Adobe I/O Runtime, que é responsável pela renderização do lado do servidor. A maioria do código será o mesmo, no entanto, as tarefas específicas do servidor serão diferentes.

SSR para SPA em AEM

O SSR para SPA no AEM requer o Adobe I/O Runtime, que é chamado para a renderização do lado do servidor de conteúdo do aplicativo. No HTL do aplicativo, um recurso no Adobe I/O Runtime é chamado para renderizar o conteúdo.

Assim como o AEM suporta as estruturas Angular e React SPA prontas para uso, a renderização do lado do servidor também é compatível com os aplicativos Angular e React. Para obter mais detalhes, consulte a documentação do NPM para ambas as estruturas.

Para obter um exemplo simplista, consulte o aplicativo We.Retail Journal. Ele renderiza todo o lado do servidor de aplicativos. Embora este não seja um exemplo real, ele ilustra o que é necessário para implementar o SSR.

ATENÇÃO

O aplicativo We.Retail Journal é somente para fins de demonstração e, portanto, usa Node.js como um exemplo simples, em vez da Adobe I/O Runtime recomendada. Este exemplo não deve ser usado para qualquer trabalho de projeto.

OBSERVAÇÃO

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

Uso de Node.js

O Adobe I/O Runtime é a solução recomendada para implementar o SSR para SPA no AEM.

Para instâncias de AEM no local, também é possível implementar o SSR usando uma instância Node.js personalizada da mesma forma como descrito acima. Embora isso seja suportado pelo Adobe, não é recomendado.

Node.js não é compatível com instâncias de AEM hospedadas por Adobe.

OBSERVAÇÃO

Se o SSR precisar ser implementado via Node.js, o Adobe recomenda uma instância diferente de Node.js para cada ambiente de AEM (autor, publicação, estágio etc.).

Renderizador de conteúdo remoto

A Configuração do Renderizador de Conteúdo Remoto que é necessária para usar o SSR com seu SPA AEM toque em um serviço de renderização mais generalizado que pode ser estendido e personalizado para atender às suas necessidades.

RemoteContentRenderingService

RemoteContentRenderingService é um serviço OSGi para recuperar conteúdo renderizado em um servidor remoto, como a partir do Adobe I/O. O conteúdo enviado para o servidor remoto é baseado no parâmetro de solicitação transmitido.

RemoteContentRenderingService pode ser inserido por inversão de dependência em um modelo Sling personalizado ou servlet, quando for necessária manipulação de conteúdo adicional.

Esse serviço é usado internamente pelo RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

O RemoteContentRendererRequestHandlerServlet pode ser usado para definir programaticamente a configuração da solicitação. DefaultRemoteContentRendererRequestHandlerImpl, a implementação do manipulador de solicitação padrão fornecida permite criar várias configurações de OSGi para mapear um local na estrutura de conteúdo a um terminal remoto.

Para adicionar um Manipulador de solicitação personalizado, implemente a interface RemoteContentRendererRequestHandler. Certifique-se de definir a propriedade do componente Constants.SERVICE_RANKING para um número inteiro superior a 100, que é a classificação do DefaultRemoteContentRendererRequestHandlerImpl.

@Component(immediate = true,
        service = RemoteContentRendererRequestHandler.class,
        property={
            Constants.SERVICE_RANKING +":Integer=1000"
        })
public class CustomRemoteContentRendererRequestHandlerImpl implements RemoteContentRendererRequestHandler {}

Configure a configuração OSGi do manipulador padrão

A configuração do manipulador padrão deve ser configurada conforme descrito na seção Configuração do Renderizador de Conteúdo Remoto.

Uso do renderizador de conteúdo remoto

Para ter uma busca de servlet e retornar algum conteúdo que possa ser inserido na página:

  1. Verifique se o servidor remoto está acessível.
  2. Adicione um dos seguintes trechos ao modelo HTL de um componente de AEM.
  3. Opcionalmente, crie ou modifique as configurações do OSGi.
  4. Procurar o conteúdo do seu site

Normalmente, o modelo HTL de um componente de página é o principal recipient de tal recurso.

<sly data-sly-resource="${resource @ resourceType='cq/remote/content/renderer/request/handler'}" />

Requisitos

Os servlets usam o Exportador de Modelo do Sling para serializar os dados do componente. Por padrão, os adaptadores com.adobe.cq.export.json.ContainerExporter e com.adobe.cq.export.json.ComponentExporter são compatíveis como Sling Model. Se necessário, você pode adicionar classes para as quais a solicitação deve ser adaptada ao uso de RemoteContentRendererServlet e implementar o RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. As classes adicionais devem estender o ComponentExporter.

Nesta página