SPA y renderización del lado del servidor

NOTA

La función Editor de aplicaciones de una sola página (SPA) requiere AEM 6.4 service pack 2 o posterior.

El Editor de SPA es la solución recomendada para proyectos que requieren SPA procesamiento del lado del cliente basado en el marco de trabajo (por ejemplo, React o Angular).

NOTA

AEM 6.4.5.0 o posterior es necesario para utilizar las funciones de renderización del lado del servidor de SPA como se describe en este documento.

Información general

Las aplicaciones de una sola página (SPA) pueden ofrecer al usuario experiencias dinámicas y enriquecidas que reaccionan y se comportan de formas familiares, a menudo como las aplicaciones nativas. Esto se consigue confiando en que el cliente cargue el contenido por adelantado y luego realice el trabajo pesado de gestionar la interacción del usuario, minimizando así la cantidad de comunicación necesaria entre el cliente y el servidor, lo que hace que la aplicación sea más reactiva.

Sin embargo, esto puede provocar tiempos de carga iniciales más largos, especialmente si el SPA es grande y tiene un contenido enriquecido. Para optimizar los tiempos de carga, parte del contenido se puede representar en el lado del servidor. El uso de la renderización del lado del servidor (SSR) puede acelerar la carga inicial de la página y luego pasar una renderización adicional al cliente.

Cuándo se utiliza SSR

La SSR no es necesaria en todos los proyectos. Aunque AEM admite totalmente la SSR de JS para SPA, Adobe no recomienda implementarla sistemáticamente para cada proyecto.

Al decidir implementar SSR, primero debe estimar qué complejidad adicional, esfuerzo y costo de agregar SSR representa de manera realista para el proyecto, incluido el mantenimiento a largo plazo. Una arquitectura SSR solo debe elegirse cuando el valor añadido exceda claramente los costes estimados.

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

  • SEO: ¿Es necesario realizar una SSR para que el sitio esté correctamente indexado por los motores de búsqueda que traen tráfico? Tenga en cuenta que los principales rastreadores de motores de búsqueda ahora evalúan JS.
  • Velocidad de página: ¿La SSR proporciona una mejora de velocidad medible en entornos reales y contribuye a la experiencia del usuario en general?

Solo cuando al menos una de estas dos preguntas se responde con un claro "sí" para el proyecto, Adobe recomienda implementar SSR. Las secciones siguientes describen cómo hacerlo mediante 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 de Adobe es utilizar Adobe I/O Runtime.

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

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

NOTA

Adobe recomienda un espacio de trabajo de Adobe I/O Runtime independiente por entorno (etapa, producto, prueba, etc.). Esto permite patrones típicos del ciclo de vida del desarrollo de sistemas (SDLC) con distintas versiones de una sola aplicación implementada en diferentes entornos. Consulte el documento CI/CD para Project Firefly Applications para obtener más información.

No se necesita un espacio de trabajo independiente por instancia (autor, publicación) a menos que haya diferencias en la implementación de tiempo de ejecución por tipo de instancia.

Configuración del procesador de contenido remoto

AEM saber dónde se puede recuperar el contenido procesado de forma remota. Independientemente del modelo que elija implementar para SSR, deberá especificar cómo AEM acceder a este servicio de procesamiento remoto.

Esto se realiza a través del servicio OSGi RemoteContentRenderer - Configuration Factory. 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:

  • Patrón de ruta de contenido : expresión regular para que coincida con una parte del contenido, si es necesario
  • Dirección URL de extremo remoto : dirección URL del extremo responsable de la generación del contenido
    • Utilice el protocolo HTTPS protegido si no está en la red local.
  • Encabezados de solicitud adicionales : encabezados adicionales que se agregarán a la solicitud enviada al extremo remoto.
    • Patrón: key=value
  • Tiempo de espera de solicitud : tiempo de espera de solicitud de host remoto en milisegundos
NOTA

Independientemente de si decide implementar el flujo de comunicación AEM o el flujo impulsado por Adobe I/O Runtime, debe definir una configuración del procesador de contenido remoto.

Esta configuración también debe definirse si elige utilizar un servidor Node.js personalizado.

NOTA

Esta configuración aprovecha el Procesador de contenido remoto, que tiene opciones de personalización y extensión adicionales disponibles.

Flujo de comunicación impulsado por AEM

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

  1. El navegador solicita el contenido SSR a AEM.
  2. AEM publica el modelo en Adobe I/O Runtime.
  3. Adobe I/O Runtime devuelve el contenido generado
  4. AEM proporciona el HTML devuelto por Adobe I/O Runtime a través de la plantilla HTL del componente de página back-end.

server-side-rendering-cms-drivenaemnode

Flujo de comunicación impulsado por Adobe I/O Runtime

En la sección Flujo de comunicación impulsado por AEM se describe la implementación estándar y recomendada del procesamiento del lado del servidor con respecto a la SPA en AEM, donde AEM realiza el arranque y la entrega del contenido.

Alternativamente, SSR puede implementarse para que Adobe I/O Runtime sea responsable del arranque, revirtiendo efectivamente el flujo de comunicación.

Ambos modelos son válidos y son compatibles con AEM. Sin embargo, hay que tener en cuenta las ventajas y desventajas de cada uno antes de aplicar un modelo determinado.

Agrupamiento Ventajas Desventajas
a través de AEM AEM administra las bibliotecas de inyección donde sea necesario
Los recursos solo deben mantenerse en AEM
Posiblemente no esté familiarizado con SPA desarrollador
a través de Adobe I/O Runtime Más familiarizado con los desarrolladores de SPA Los recursos de Clientlib requeridos por la aplicación, como CSS y JavaScript, deberán estar disponibles para el desarrollador de AEM a través de la propiedad allowProxy
Los recursos deben sincronizarse entre AEM y Adobe I/O Runtime
Para habilitar la creación de la SPA, puede que sea necesario un servidor proxy para Adobe I/O Runtime

Planificación de SSR

Por lo general, solo una parte de una aplicación debe representarse en el servidor. El ejemplo común es que el contenido que se mostrará encima del pliegue en la carga inicial de la página debe representarse en el servidor. Esto ahorra tiempo al enviar al cliente contenido ya procesado. A medida que el usuario interactúa con el SPA, el cliente procesa el contenido adicional.

Al considerar la implementación del procesamiento del lado del servidor para su SPA, debe revisar qué partes de la aplicación requerirán reenvío del lado del servidor.

Desarrollo de una SPA con SSR

SPA componentes podrían ser procesados por el cliente (en el navegador) o por el servidor. Cuando se procesa en el servidor, las propiedades del explorador, como el tamaño de la ventana y la ubicación, no están presentes. Por lo tanto, SPA componentes deben ser isomórficos, sin suponer dónde se procesarán.

Para aprovechar SSR, deberá implementar su código en AEM así como en Adobe I/O Runtime, que es responsable de la renderización del lado del servidor. La mayoría del código será el mismo, pero las tareas específicas del servidor diferirán.

SSR para SPA en AEM

El SSR para SPA en AEM requiere Adobe I/O Runtime, que se llama para la representación del servidor de contenido de la aplicación. Dentro de HTL de la aplicación, se llama a un recurso en Adobe I/O Runtime para procesar el contenido.

Del mismo modo que AEM admite los marcos de SPA Angular y React de forma predeterminada, el procesamiento en el servidor también se admite para aplicaciones de Angular y React. Para más detalles, consulte la documentación de NPM para ambos marcos.

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

PRECAUCIÓN

La aplicación We.Retail Journal solo tiene fines de demostración y, por lo tanto, utiliza Node.js como ejemplo simple en lugar de la Adobe I/O Runtime recomendada. Este ejemplo no debe utilizarse para ningún trabajo de proyecto.

NOTA

Cualquier proyecto AEM debe aprovechar el AEM tipo de archivo del proyecto, que admite SPA proyectos con React o Angular y aprovecha el SDK de SPA.

Uso de Node.js

Adobe I/O Runtime es la solución recomendada para implementar SSR para SPA en AEM.

Para las instancias de AEM locales, también es posible implementar SSR mediante una instancia de Node.js personalizada de la misma manera que se describió anteriormente. Aunque el Adobe lo admite, no se recomienda.

Node.js no es compatible con instancias de AEM alojadas en Adobe.

NOTA

Si SSR debe implementarse mediante Node.js, Adobe recomienda una instancia de Node.js independiente para cada entorno AEM (autor, publicación, etapa, etc.).

Procesador de contenido remoto

La Configuración del procesador de contenido remoto necesaria para utilizar SSR con su SPA en AEM toca en un servicio de renderización más generalizado que se puede ampliar y personalizar para satisfacer sus necesidades.

RemoteContentRenderingService

RemoteContentRenderingService es un servicio OSGi para recuperar contenido procesado en un servidor remoto, como desde el 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 dependencias en un modelo Sling personalizado o servlet cuando se requiere una manipulación de contenido adicional.

Este servicio lo utiliza internamente RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

El RemoteContentRendererRequestHandlerServlet se puede usar para establecer programáticamente la configuración de la solicitud. DefaultRemoteContentRendererRequestHandlerImpl, la implementación predeterminada del controlador de solicitud proporcionada, le permite crear varias configuraciones OSGi para asignar una ubicación en la estructura de contenido a un punto final 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 entero mayor que 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

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

Uso del procesador de contenido remoto

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

  1. Asegúrese de que el servidor remoto es accesible.
  2. Agregue uno de los siguientes fragmentos a la plantilla HTL de un componente AEM.
  3. De forma opcional, cree o modifique las configuraciones de OSGi.
  4. Explorar el contenido del sitio

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

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

Requisitos

Los servlets aprovechan el Exportador del modelo de Sling para serializar los datos del componente. De forma predeterminada, tanto com.adobe.cq.export.json.ContainerExporter como com.adobe.cq.export.json.ComponentExporter son compatibles como adaptadores del modelo Sling. Si es necesario, puede añadir clases en las que la solicitud debe adaptarse para utilizar RemoteContentRendererServlet e implementar el RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. Las clases adicionales deben ampliar el ComponentExporter.

En esta página