Representación en SPA y en el 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

Se necesita AEM 6.4.5.0 o posterior para utilizar las funciones de procesamiento del lado del servidor SPA, tal como se describe en este documento.

Información general

Las aplicaciones de una sola página (SPA) pueden oferta al usuario de 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, a continuación, realice el trabajo pesado de gestionar la interacción del usuario y, de este modo, se minimiza 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 llevar a tiempos de carga iniciales más largos, especialmente si el SPA es grande y rico en su contenido. Para optimizar los tiempos de carga, parte del contenido se puede representar en el servidor. El uso del procesamiento en el lado del servidor (SSR) puede acelerar la carga inicial de la página y, a continuación, pasar el procesamiento al cliente.

Cuándo utilizar SSR

No es necesaria la reforma del sector de la seguridad en todos los proyectos. Aunque AEM admite plenamente la SSR de JS para SPA, Adobe no recomienda implementarla sistemáticamente en todos los proyectos.

Al decidir implementar SSR, primero debe calcular qué complejidad adicional, esfuerzo y costo de adición de SSR representa de manera realista para el proyecto, incluido el mantenimiento a largo plazo. La arquitectura de SSR sólo debe elegirse cuando el valor añadido exceda claramente los costes estimados.

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

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

Solo cuando al menos una de estas dos preguntas se conteste con un claro "sí" para su proyecto, Adobe recomienda la implementación de SSR. Las siguientes secciones describen cómo hacerlo con 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 siguientes secciones detallan cómo se puede utilizar Adobe I/O Runtime para implementar SSR para su SPA en dos modelos diferentes:

NOTA

Adobe recomienda una instancia de Adobe I/O Runtime independiente para cada entorno de AEM (autor, publicación, etapa, etc.).

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 AEM cómo acceder a este servicio de procesamiento remoto.

Esto se realiza mediante el servicio de RemoteContentRenderer - Configuration Factory OSGi. Busque la cadena "RemoteContentRenderer" en la consola de configuración de la consola web en http://<host>:<port>/system/console/configMgr.

Los siguientes campos 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 del extremo remoto: dirección URL del extremo responsable de la generación del contenido
    • Utilice el protocolo HTTPS seguro 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 gobernado por Adobe I/O Runtime, debe definir una configuración del procesador de contenido remoto.

Esta configuración también se debe definir 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 explorador solicita el contenido de 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 de back-end.

server-side-renderizadennodo

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 SPA en AEM, donde AEM realiza el arranque y el servicio del contenido.

Como alternativa, 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 de ellos antes de aplicar un modelo determinado.

Bootstrap Ventajas Desventajas
mediante AEM AEM administra las bibliotecas que se inyectan cuando es necesario
Los recursos sólo deben mantenerse en AEM
Posiblemente no sea familiar para SPA programador
a través de Adobe I/O Runtime Más familiarizado con los desarrolladores de SPA Los recursos de la biblioteca de clientes requeridos por la aplicación, como CSS y JavaScript, deberán estar disponibles para el desarrollador de AEM mediante la propiedad allowProxy
Los recursos deben sincronizarse entre AEM y Adobe I/O Runtime
Para habilitar la creación de la SPA, puede ser necesario un servidor proxy para Adobe I/O Runtime

Planificación de SSR

Generalmente, 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 SSR.

Desarrollo de un SPA con SSR

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

Para aprovechar SSR, deberá implementar el código en AEM y en Adobe I/O Runtime, que es responsable del procesamiento en el servidor. La mayoría del código será el mismo, aunque 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. En el HTML de la aplicación, se llama a un recurso de Adobe I/O Runtime para procesar el contenido.

De la misma manera que AEM admite los marcos SPA Angular y Reaccionar de forma predeterminada, el procesamiento del lado del servidor también es compatible con las aplicaciones Angular y Reaccionar. Consulte la documentación de NPM para conocer ambos marcos para obtener más detalles.

Para ver un ejemplo simplista, consulte la aplicación de Historial We.Retail. Procesa todo el lado del servidor de aplicaciones. Aunque este no es un ejemplo real, ilustra lo que se necesita para implementar la reforma del sector de la seguridad.

ATENCIÓN

La aplicación de Historial We.Retail se utiliza únicamente con fines de demostración y, por lo tanto, Node.js es un ejemplo sencillo en lugar del Adobe I/O Runtime recomendado. Este ejemplo no debe utilizarse para ningún trabajo de proyecto.

NOTA

Cualquier proyecto AEM debe aprovechar el AEM Arquetipo de proyecto, que admite SPA proyectos usando React o Angular y aprovecha el SDK SPA.

Uso de Node.js

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

En el caso de instancias de AEM in situ, también es posible implementar SSR mediante una instancia de Node.js personalizada de la misma manera que se describe anteriormente. Aunque 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 de AEM (autor, publicación, etapa, etc.).

Procesador de contenido remoto

La Configuración del procesador de contenido remoto que se requiere para utilizar SSR con su SPA en AEM toca en un servicio de procesamiento 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 por ejemplo, de 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 en un servlet cuando se requiera una manipulación de contenido adicional.

Este servicio lo utiliza internamente RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

El RemoteContentRendererRequestHandlerServlet se puede utilizar para configurar la solicitud mediante programación. DefaultRemoteContentRendererRequestHandlerImpl, la implementación predeterminada del controlador de solicitudes 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 sea accesible.
  2. Añada uno de los siguientes fragmentos en la plantilla HTL de un componente AEM.
  3. Opcionalmente, 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 Sling Model Exporter 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 agregar clases que la solicitud debe adaptarse para utilizar RemoteContentRendererServlet e implementar el RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. Las clases adicionales deben ampliar el ComponentExporter.

En esta página