SPA Procesamiento del lado del servidor y de spa-and-server-side-rendering

Información general overview

SPA Las aplicaciones de una sola página () pueden ofrecer al usuario una experiencia enriquecida y dinámica que reacciona y se comporta de formas familiares, a menudo igual que una aplicación nativa. Esto se logra confiando en que el cliente cargue el contenido por adelantado y luego haga el trabajo pesado de administrar la interacción del usuario, minimizando así la cantidad de comunicación necesaria entre el cliente y el servidor, haciendo que la aplicación sea más reactiva.

SPA Sin embargo, esto puede conllevar tiempos de carga inicial más largos, especialmente si el contenido del es grande y rico. Para optimizar los tiempos de carga, parte del contenido se puede procesar en el servidor. El uso del procesamiento del lado del servidor (SSR) puede acelerar la carga inicial de la página y, a continuación, pasar más procesamiento al cliente.

Cuándo usar SSR when-to-use-ssr

No se requiere SSR en todos los proyectos. AEM SPA Aunque admite totalmente la SR de JS para la, Adobe no recomienda implementarla sistemáticamente en todos los proyectos.

Al decidir implementar SSR, primero debe estimar qué complejidad, esfuerzo y costo adicionales representan SSR de manera realista para el proyecto, incluido el mantenimiento a largo plazo. Sólo debe elegirse una arquitectura SSR cuando el valor añadido supere claramente los costes estimados.

SSR generalmente proporciona algún valor cuando hay un claro "sí" a cualquiera de las siguientes preguntas:

Solo cuando al menos una de estas dos preguntas se responda con un claro "sí" para su proyecto, el Adobe recomienda implementar SSR. En las secciones siguientes se describe cómo hacerlo con Adobe I/O Runtime.

Adobe I/O Runtime adobe-i-o-runtime

Si está seguro de que su proyecto requiere la implementación de SSR🔗, la solución recomendada por Adobe es usar Adobe I/O Runtime.

Para obtener más información sobre Adobe I/O Runtime, consulte lo siguiente:

Las siguientes secciones detallan cómo se puede utilizar Adobe I/O Runtime SPA para implementar SSR para su en dos modelos diferentes:

Configuración del procesador remoto remote-renderer-configuration

AEM Debe saber dónde se puede recuperar el contenido procesado de forma remota. AEM Independientemente del modelo que elija implementar para SSR,, debe especificar a los usuarios que deben obtener acceso a este servicio de representación remota para que puedan obtener acceso a él de forma remota.

Esto se hace a través del RemoteContentRenderer - servicio OSGi de fábrica de configuración. Busque la cadena "RemoteContentRenderer" en la consola de configuración de la consola web en http://<host>:<port>/system/console/configMgr.

Los campos siguientes están disponibles para la configuración:

AEM Flujo de comunicación impulsado por el aem-driven-communication-flow

SPA AEM Al utilizar SSR, el flujo de trabajo de interacción de componentes de la en incluye una fase en la que el contenido inicial de la aplicación se genera en Adobe I/O Runtime.

Flujo de comunicación impulsado por Adobe I/O Runtime adobe-i-o-runtime-driven-communication-flow

SPA AEM AEM En la sección anterior se describe la implementación estándar y recomendada del procesamiento del lado del servidor con respecto a la en la que el usuario realiza el arranque y la entrega de contenido de manera independiente, y se realiza una prueba de ello con el fin de obtener un resultado más eficaz en el.

Como alternativa, SSR se puede implementar de modo que Adobe I/O Runtime sea responsable del arranque, lo que invierte de forma eficaz el flujo de comunicación.

AEM Ambos modelos son válidos y compatibles con el servicio de asistencia de la aplicación de la. Sin embargo, se deben considerar las ventajas y desventajas de cada uno antes de implementar un modelo en particular.

Planificación de la SSR planning-for-ssr

Solo una parte de una aplicación debe procesarse en el servidor. El ejemplo más común es el contenido que se muestra encima del pliegue en la carga inicial de la página y que se procesa en el servidor. Esto ahorra tiempo al enviar al cliente contenido ya procesado. SPA A medida que el usuario interactúa con el usuario, el cliente procesa el contenido adicional.

SPA A medida que considere la posibilidad de implementar el procesamiento en el lado del servidor para su, revise qué partes de la aplicación son necesarias.

SPA Desarrollo de una mediante SSR developing-an-spa-using-ssr

SPA El cliente (en el explorador) o el servidor pueden procesar los componentes de la. Cuando se representan en el servidor, las propiedades del explorador como el tamaño y la ubicación de la ventana no están presentes. SPA Por lo tanto, los componentes de la deben ser isomórficos, sin dar por hecho dónde se procesarán.

AEM Para utilizar SSR, implemente su código en y en Adobe I/O Runtime, que es responsable del procesamiento en el servidor. La mayoría del código será el mismo, pero las tareas específicas del servidor diferirán.

SPA AEM SSR para la en el ssr-for-spas-in-aem

SPA AEM SSR para la en la práctica requiere Adobe I/O Runtime, que es necesario para el procesamiento del lado del servidor de contenido de la aplicación. Dentro del HTL de la aplicación, se llama a un recurso en Adobe I/O Runtime para procesar el contenido.

AEM Del mismo modo que admite los módulos Angular SPA y React de forma predeterminada, el procesamiento del lado del servidor también es compatible con las aplicaciones de Angular y React. Consulte la documentación de NPM para ambos marcos para obtener más información.

Para ver un ejemplo simplista, consulte Aplicación We.Retail Journal. Procesa todo el servidor de aplicaciones. Aunque este no es un ejemplo real, ilustra lo que se necesita para implementar la SSR.

Uso de Node.js using-node-js

Adobe I/O Runtime SPA AEM es la solución recomendada para implementar SSR para el uso de la en los entornos de trabajo de la.

AEM En el caso de instancias de locales, también es posible implementar SSR mediante una instancia personalizada de Node.js del mismo modo que se ha descrito anteriormente. Aunque esto es compatible con el Adobe, no se recomienda.

Procesador de contenido remoto remote-content-renderer

SPA AEM La configuración del procesador de contenido remoto necesaria para usar SSR con sus en el modo de trabajo, se utiliza en un servicio de procesamiento más generalizado que se puede ampliar y personalizar para satisfacer sus necesidades.

RemoteContentRenderingService remotecontentrenderingservice

RemoteContentRenderingService es un servicio OSGi para recuperar contenido procesado en un servidor remoto, como del Adobe I/O. El contenido enviado al servidor remoto se basa en el parámetro de solicitud pasado.

RemoteContentRenderingService se puede insertar mediante la inversión de dependencia en un modelo de Sling personalizado o servlet cuando se requiere una manipulación de contenido adicional.

Este servicio lo usa internamente RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet remotecontentrendererrequesthandlerservlet

RemoteContentRendererRequestHandlerServlet se puede usar para establecer la configuración de la solicitud mediante programación. DefaultRemoteContentRendererRequestHandlerImpl, la implementación del controlador de solicitudes predeterminada proporcionada, le permite crear varias configuraciones de OSGi para asignar una ubicación en la estructura de contenido a un extremo remoto.

Para agregar un controlador de solicitud personalizado, implemente la interfaz RemoteContentRendererRequestHandler. Asegúrese de establecer la propiedad del componente Constants.SERVICE_RANKING en un número entero superior a 100, que es la clasificación de DefaultRemoteContentRendererRequestHandlerImpl.

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

Configurar la configuración OSGi del controlador predeterminado configure-default-handler

La configuración del controlador predeterminado debe configurarse tal como se describe en la sección Configuración del procesador de contenido remoto.

Uso del procesador de contenido remoto usage

Para que un servlet recupere y devuelva contenido que se pueda insertar en la página:

Normalmente, la plantilla HTL de un componente de página es el destinatario principal de una función de este tipo.

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

Requisitos requirements

Los servlets utilizan el Exportador del modelo Sling para serializar los datos del componente. De manera predeterminada, com.adobe.cq.export.json.ContainerExporter y com.adobe.cq.export.json.ComponentExporter se admiten como adaptadores del modelo Sling. Si es necesario, puede agregar clases a las que se debe adaptar la solicitud mediante el RemoteContentRendererServlet y la implementación de RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. Las clases adicionales deben extender ComponentExporter.