Renderização do SPA e do servidor spa-and-server-side-rendering

Visão geral overview

Os aplicativos de página única (SPA) podem oferecer ao usuário uma experiência avançada e dinâmica que reage e se comporta de maneiras familiares, geralmente como um aplicativo nativo. Isso é feito confiando no cliente para carregar o conteúdo antecipadamente e, em seguida, fazer o trabalho pesado de manipulação da 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 inicial mais longos, especialmente se o SPA for grande e rico em 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, passar a renderização adicional para o cliente.

Quando usar o SSR when-to-use-ssr

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

Ao decidir implementar o SSR, você deve primeiro estimar a complexidade, o esforço e o custo adicionais que a adição do SSR representa realisticamente para o projeto, incluindo a manutenção a longo prazo. Uma arquitetura SSR 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:

Somente quando pelo menos uma dessas duas perguntas for respondida com um claro "sim" 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 adobe-i-o-runtime

Se você estiver 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 o seguinte:

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

Configuração do renderizador remoto remote-renderer-configuration

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

Isso é feito por meio do RemoteContentRenderer - serviço OSGi da Fábrica de Configurações. Procure a cadeia de caracteres "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:

Fluxo de comunicação orientado por AEM aem-driven-communication-flow

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

Fluxo de comunicação orientado pela Adobe I/O Runtime adobe-i-o-runtime-driven-communication-flow

A seção anterior descreve a implementação padrão e recomendada da renderização no lado do servidor em relação ao SPA AEM, onde o AEM executa o bootstrapping e a veiculação de conteúdo.

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

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

Planejamento para SSR planning-for-ssr

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

Ao considerar implementar a renderização do lado do servidor para o seu SPA, analise quais partes do aplicativo são necessárias.

Desenvolvimento de um SPA usando SSR developing-an-spa-using-ssr

Os componentes do SPA podem ser renderizados pelo cliente (no navegador) ou pelo servidor. Quando renderizadas no lado do servidor, as propriedades do navegador, como tamanho e localização da janela, não estão presentes. Portanto, os componentes SPA devem ser isomorfos, não fazendo suposições sobre onde serão renderizados.

Para usar o SSR, implante 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, tarefas específicas do servidor serão diferentes.

RSS para AEM no SPA ssr-for-spas-in-aem

O SSR para AEM no SPA exige 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 SPA do Angular e do React prontas para uso, a renderização no lado do servidor também é compatível com os aplicativos Angular e React. Consulte a documentação do NPM para ambas as estruturas para obter mais detalhes.

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

Usar Node.js using-node-js

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

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

Renderizador remoto de conteúdo remote-content-renderer

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

ServiçoDeRenderizaçãoDeConteúdoRemoto remotecontentrenderingservice

RemoteContentRenderingService é um serviço OSGi para recuperar conteúdo renderizado em um servidor remoto, como do Adobe I/O. O conteúdo enviado para o servidor remoto se baseia 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 uma manipulação de conteúdo adicional é necessária.

Este serviço é usado internamente pelo RemoteContentRendererRequestHandlerServlet.

ServletManipuladordeSolicitaçãodeRenderizadorDeConteúdoRemoto remotecontentrendererrequesthandlerservlet

O RemoteContentRendererRequestHandlerServlet pode ser usado para definir programaticamente a configuração da solicitação. DefaultRemoteContentRendererRequestHandlerImpl, a implementação do manipulador de solicitações padrão fornecido, permite que você crie várias configurações OSGi para mapear um local na estrutura de conteúdo para um ponto de extremidade 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 inteiro maior que 100, que é a classificação do DefaultRemoteContentRendererRequestHandlerImpl.

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

Configurar o OSGi do manipulador padrão configure-default-handler

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

Uso do renderizador de conteúdo remoto usage

Para fazer um servlet buscar e retornar algum conteúdo que possa ser inserido na página:

Normalmente, o modelo HTL de um componente de página é o principal destinatário desse recurso.

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

Requisitos requirements

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