Desarrollo de SPA para AEM developing-spas-for-aem
Las aplicaciones de una sola página (SPA) pueden ofrecer experiencias atractivas para los usuarios de sitios web. Los desarrolladores quieren poder generar sitios usando marcos de SPA y los autores quieren editar contenido dentro de AEM para un sitio generado usando dichos marcos.
Este artículo presenta preguntas importantes que se deben tener en cuenta al contratar a un desarrollador de front-end para que desarrolle un SPA para AEM y ofrece una visión general de la arquitectura de AEM con respecto a la implementación de SPA en AEM.
Tipo de archivo del proyecto AEM. aem-project-archetype
Cualquier proyecto AEM debería aprovechar el Tipo de archivo del proyecto AEM, que admite proyectos de SPA que utilizan React o Angular y aprovecha el SDK de SPA.
Principios de desarrollo SPA para AEM spa-development-principles-for-aem
El desarrollo de aplicaciones de una sola página en AEM supone que el desarrollador front-end sigue las prácticas recomendadas estándar al crear una SPA. Si como desarrollador de front-end sigue estas prácticas recomendadas generales, así como algunos principios específicos de AEM, su SPA funcionará con AEM y sus funciones de creación de contenido.
- Portabilidad - Al igual que con cualquier componente, los componentes deben construirse para que sean lo más portátiles posible. El SPA debe crearse con componentes transferibles y reutilizables, evitando rutas estáticas que hagan referencia a la estructura de contenido.
- AEM estructura del sitio : El desarrollador de front-end crea componentes y posee su estructura interna, pero depende de AEM para definir la estructura de contenido del sitio.
- Renderización dinámica - Todas las renderizaciones deben ser dinámicas.
- Enrutamiento dinámico - El SPA es responsable del enrutamiento y AEM lo escucha y obtiene los datos del componente en función de él. Cualquier enrutamiento también debe ser dinámico.
Si tiene en cuenta estos principios al desarrollar su SPA, será lo más flexible y la prueba más futura posible, al mismo tiempo que habilita todas las funciones de creación AEM compatibles.
Si no necesita admitir AEM funciones de creación, puede que tenga que considerar otra SPA modelo de diseño.
Portabilidad portability
Al igual que cuando se desarrolla cualquier componente, los componentes deben diseñarse de manera que se maximice su portabilidad. Cualquier patrón que funcione en contra de la portabilidad o reutilización de los componentes debe evitarse para garantizar la compatibilidad, flexibilidad y mantenimiento en el futuro.
El desarrollador debe evitar utilizar rutas estáticas que hagan referencia a la estructura de contenido, ya que los autores de contenido pueden modificar las rutas en cualquier momento. Esto también restringe la reutilización de la biblioteca y evita que se utilice el Editor de plantillas de AEM, ya que su estructura se encuentra en otra ubicación distinta al contenido.
El SPA resultante debe crearse con componentes altamente portátiles y reutilizables.
AEM estructura del sitio aem-drives-site-structure
El desarrollador principal debe considerarse a sí mismo como responsable de crear una biblioteca de componentes de SPA que se utilizan para crear la aplicación. El desarrollador de front-end tiene control total de la estructura interna de los componentes. Sin embargo, AEM en todo momento posee la estructura del sitio.
Esto significa que el desarrollador del front-end puede añadir contenido del cliente antes o después del punto de entrada de los componentes y también puede realizar llamadas de terceros dentro del componente. Sin embargo, el desarrollador de front-end no tiene control absoluto sobre cómo se anidan los componentes, por ejemplo.
Renderización dinámica dynamic-rendering
El SPA solo debe depender de la representación dinámica del contenido. Esta es la expectativa predeterminada en la que AEM recupera y procesa todos los elementos secundarios de la estructura de contenido.
Cualquier renderización explícita que señale a contenido específico se considera una renderización estática y aunque compatible, no será compatible con AEM funciones de creación de contenido. Esto también va en contra del principio de portabilidad.
Enrutamiento dinámico dynamic-routing
Al igual que con la renderización, todo el enrutamiento también debe ser dinámico. En AEM, el SPA siempre debe ser propietario del enrutamiento y AEM escucha y busca contenido basado en él.
Cualquier enrutamiento estático funciona con principio de portabilidad y limita al autor al no ser compatible con las funciones de creación de contenido de AEM. Por ejemplo, con el enrutamiento estático, si el autor de contenido desea cambiar una ruta o cambiar una página, tendría que pedirle al desarrollador del front-end que lo hiciera.
SPA modelos de diseño spa-design-models
Si la variable principios de desarrollo de SPA en AEM , su SPA funcionará con todas las funciones de creación de contenido AEM compatibles.
Sin embargo, puede haber casos en que esto no sea completamente necesario. La siguiente tabla ofrece una descripción general de los distintos modelos de diseño, sus ventajas y sus desventajas.
Migración de SPA existentes a AEM migrating-existing-spas-to-aem
Por lo general, si su SPA sigue la variable Principios de desarrollo SPA para AEM, su SPA funcionará en AEM y será editable mediante el AEM SPA Editor.
Siga estos pasos para preparar su SPA existente para trabajar con AEM.
-
Haga que los componentes de JS sean modulares.
Permiten procesarlos en cualquier orden, posición y tamaño.
-
Utilice los contenedores proporcionados por nuestro SDK para colocar sus componentes en la pantalla .
AEM proporciona un componente de sistema de páginas y párrafos para que lo utilice.
-
Cree un componente AEM para cada componente JS.
Los componentes AEM definen el cuadro de diálogo y la salida JSON.
Instrucciones para desarrolladores de front-end instructions-for-front-end-developers
La tarea principal de hacer que un desarrollador front-end cree un SPA para AEM es acordar los componentes y sus modelos JSON.
A continuación se describen los pasos que debe seguir un desarrollador de front-end al desarrollar un SPA para AEM.
-
Aceptar componentes y su modelo JSON
Los desarrolladores de front-end y los desarrolladores de AEM de back-end deben ponerse de acuerdo sobre qué componentes son necesarios y un modelo, de modo que exista una coincidencia individual entre los componentes de SPA y los componentes del back-end.
AEM componentes siguen siendo necesarios principalmente para proporcionar cuadros de diálogo de edición y exportar el modelo de componentes.
-
En Componentes de React, acceda al modelo a través de
this.props.cqModelUna vez que los componentes están acordados y el modelo JSON está en su lugar, el desarrollador front-end puede desarrollar el SPA y simplemente acceder al modelo JSON a través de
this.props.cqModel. -
Implementación del
render()methodEl desarrollador de front-end implementa el
render()como considere adecuado y puede utilizar los campos delcqModelpropiedad. Esto genera los fragmentos DOM y HTML que se insertan en la página. Esta es la forma estándar de crear una aplicación en React. -
Asigne el componente al tipo de recurso AEM mediante
MapTo()La asignación almacena clases de componentes y la utiliza internamente el
Containerpara recuperar y crear instancias de componentes de forma dinámica en función del tipo de recurso dado.Esto sirve como "pegamento" entre el front-end y el back-end para que el editor sepa a qué componentes corresponden los componentes de reacción.
La variable
PageyResponsiveGridson buenos ejemplos de clases que amplían la baseContainer. -
Defina el
EditConfigcomo parámetro paraMapTo()Este parámetro es necesario para indicar al editor cómo se debe nombrar el componente mientras no se haya procesado aún o no haya contenido para procesar.
-
Amplíe el
Containerclase para páginas y contenedoresLos sistemas de páginas y párrafos deben ampliar esta clase para que la delegación a componentes internos funcione según lo esperado.
-
Implementar una solución de enrutamiento que utilice el HTML 5
HistoryAPI.Cuando la variable
ModelRouterestá habilitado, llamando a la funciónpushStateyreplaceStatedéclencheur de una solicitud aPageModelManagerpara recuperar un fragmento que falta del modelo.La versión actual de
ModelRoutersolo admiten el uso de direcciones URL que apunten a la ruta de recurso real de los puntos de entrada del modelo Sling. No admite el uso de direcciones URL o alias personales.La variable
ModelRouterse puede deshabilitar o configurar para ignorar una lista de expresiones regulares.
AEM-agnóstico aem-agnostic
Estos bloques de código ilustran cómo los componentes React y Angular no necesitan nada que sea Adobe o AEM específico.
- Todo lo que se encuentra dentro del componente JavaScript no es AEM.
- Sin embargo, lo que es específico de AEM es que el componente JS debe asignarse a un componente AEM con el asistente de MapTo.
La variable MapTo helper es el "pegamento" que permite combinar los componentes del back-end y del front-end:
- Indica al contenedor de JS (o sistema de párrafos JS) qué componente JS es responsable de procesar cada uno de los componentes presentes en el JSON.
- Agrega un atributo de datos del HTML al HTML que el componente JS procesa, de modo que el Editor de SPA sepa qué cuadro de diálogo mostrar al autor al editar el componente.
Para obtener más información sobre el uso de MapTo y crear SPA para AEM en general, consulte la guía de introducción para la estructura elegida.
Arquitectura AEM y SPA aem-architecture-and-spas
La arquitectura general de AEM, incluidos los entornos de desarrollo, creación y publicación, no cambia al utilizar SPA. Sin embargo, es útil comprender cómo SPA desarrollo encaja en esta arquitectura.
-
Entorno de compilación
Aquí es donde se extrae el origen de la aplicación SPA y el origen de componentes.
- El generador clientlib de NPM crea una biblioteca de cliente del proyecto SPA.
- Maven la tomará y la implementará el complemento de compilación de Maven junto con el componente en AEM Author.
-
AEM Author
El contenido se crea en el autor AEM, incluido el SPA de creación.
Cuando se edita una SPA con el Editor de SPA en el entorno de creación:
- El SPA solicita al HTML exterior.
- Se carga el CSS.
- Se carga el JavaScript de la aplicación SPA.
- Cuando se ejecuta la aplicación SPA, se solicita el JSON, lo que permite que la aplicación cree el DOM de la página, incluido el
cq-dataatributos. - Esta
cq-datapermite que el editor cargue información de página adicional para que sepa qué configuraciones de edición están disponibles para los componentes.
-
AEM Publish
Aquí es donde el contenido creado y las bibliotecas compiladas, incluidos los artefactos de SPA aplicación, clientlibs y componentes, se publican para el consumo público.
-
Dispatcher/CDN
Dispatcher sirve como capa de AEM de almacenamiento en caché para los visitantes del sitio.
- Las solicitudes se procesan de forma similar a como se encuentran en AEM Author; sin embargo, no hay solicitud de la información de la página, ya que el editor solo lo necesita.
- Javascript, CSS, JSON y HTML se almacenan en caché, lo que optimiza la página para una entrega rápida.
Pasos siguientes next-steps
Para obtener una descripción general de cómo se estructura un SPA simple en AEM y cómo funciona, consulte la guía de introducción para ambos React y Angular.
Para obtener una guía paso a paso sobre cómo crear su propia SPA, consulte la Introducción al Editor de SPA de AEM: tutorial de eventos de WKND.
Para obtener más información sobre el modelo dinámico para la asignación de componentes y cómo funciona dentro de SPA en AEM, consulte el artículo Asignación de modelos dinámicos a componentes para SPA.
Si desea implementar SPA en AEM para un marco que no sea React o Angular o simplemente desea profundizar en cómo funciona el SDK de SPA para AEM, consulte la Modelo SPA artículo.