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 front-end para desarrollar una SPA para AEM y ofrece una visión general de la arquitectura de AEM en relación con la implementación de SPA en AEM.
- El Editor universal para editar contenido sin encabezado de forma visual.
- El Editor de fragmentos de contenido para la edición de contenido sin encabezado basada en formularios.
Principios de desarrollo de 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 front-end sigue estas prácticas recomendadas generales y algunos principios específicos de AEM, su SPA funciona con AEM y sus capacidades de creación de contenido.
- Portabilidad: al igual que con cualquier componente, los componentes deben crearse para que sean lo más portátiles posible. La SPA debe crearse con componentes transferibles y reutilizables.
- AEM impulsa la estructura del sitio: el desarrollador front-end crea componentes y posee su estructura interna, pero depende de AEM para definir la estructura de contenido del sitio.
- Procesamiento dinámico: todo el procesamiento debe ser dinámico.
- Enrutamiento dinámico: la SPA es responsable del enrutamiento, y AEM la atiende y recupera en función de esta. Cualquier enrutamiento también debe ser dinámico.
Si tiene en cuenta estos principios al desarrollar la SPA, esta se vuelve lo más flexible y segura posible de cara al futuro, al tiempo que se habilitan todas las funcionalidades de creación de AEM admitidas.
Si no necesita admitir características de creación de AEM, considere un modelo de diseño de SPA diferente.
Portabilidad portability
Al igual que al desarrollar cualquier componente, los componentes deben diseñarse de tal manera que maximice su portabilidad. Debe evitarse cualquier patrón que vaya en contra de la portabilidad o reutilización de los componentes para garantizar la compatibilidad, flexibilidad y capacidad de mantenimiento en el futuro.
El SPA resultante debe crearse con componentes altamente portátiles y reutilizables.
Estructura del sitio de unidades AEM aem-drives-site-structure
El desarrollador front-end debe considerarse responsable de crear una biblioteca de componentes de SPA utilizados para crear la aplicación. El desarrollador front-end tiene un control total de la estructura interna de los componentes. Sin embargo, AEM siempre posee la estructura del sitio.
Este control significa que el desarrollador front-end puede agregar contenido de cliente antes o después del punto de entrada de los componentes y también puede realizar una llamada de terceros dentro del componente. Sin embargo, el desarrollador front-end no tiene control total sobre cómo anidan los componentes, por ejemplo.
Procesamiento dinámico dynamic-rendering
La SPA solo debe depender de la renderización dinámica del contenido. Esta expectativa es la predeterminada en la que AEM recupera y procesa todos los elementos secundarios de la estructura de contenido.
Cualquier representación explícita que apunte a contenido específico se considera una representación estática y, aunque se admite, es compatible con las funciones de creación de contenido de AEM. También va en contra del principio de portabilidad.
Enrutamiento dinámico dynamic-routing
Al igual que con el procesamiento, todo el enrutamiento también debe ser dinámico. En AEM, la SPA siempre debe ser propietaria del enrutamiento, y AEM lo escucha y recupera contenido basado en él.
Cualquier enrutamiento estático funciona en contra del principio de portabilidad y limita al autor al no ser compatible con las características 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, debe pedirle al desarrollador front-end que lo haga.
Arquetipo del proyecto AEM aem-project-archetype
Cualquier proyecto AEM debería utilizar el Tipo de archivo del proyecto AEM, que admite proyectos de SPA que utilizan React o Angular y aprovecha el SDK de SPA.
Modelos de diseño SPA spa-design-models
Si se siguen los principios del desarrollo de SPA en AEM, su SPA funcionará con todas las funciones de creación de contenido de AEM admitidas.
Sin embargo, puede haber casos en los que esta funcionalidad no sea completamente necesaria. En la tabla siguiente se 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 los Principios de desarrollo de SPA para AEM, su SPA funciona en AEM y se puede editar con el Editor de SPA de AEM.
Siga estos pasos para poder preparar su SPA existente para trabajar con AEM.
- Haga que sus componentes JS sean modulares.: haga que se puedan procesar en cualquier orden, posición y tamaño.
- Use los contenedores proporcionados por SDK para colocar los componentes en la pantalla.: AEM proporciona un componente del sistema de páginas y párrafos para que lo utilice.
- Cree un componente de AEM para cada componente JS.: los componentes de 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 al involucrar a un desarrollador front-end para crear una SPA para AEM es acordar los componentes y sus modelos JSON.
A continuación se describen los pasos que debe seguir un desarrollador front-end al desarrollar una SPA para AEM.
-
Aceptar componentes y su modelo JSON
Los desarrolladores de front-end y de back-end de AEM deben acordar qué componentes son necesarios y un modelo, de modo que haya una coincidencia individualizada entre los componentes de SPA y los componentes de back-end.
Los componentes de AEM siguen siendo necesarios principalmente para proporcionar cuadros de diálogo de edición y para exportar el modelo de componente.
-
En los componentes de React, acceda al modelo a través de
this.props.cqModelUna vez acordados los componentes y configurado el modelo JSON, el desarrollador front-end puede desarrollar la SPA y simplemente acceder al modelo JSON a través de
this.props.cqModel. -
Implementar el método
render()del componenteEl desarrollador front-end implementa el método
render()como crea conveniente y puede utilizar los campos de la propiedadcqModel. Este método genera los fragmentos DOM y HTML que se insertan en la página. Este método es también la forma estándar de crear una aplicación en React. -
Asigne el componente al tipo de recurso de AEM mediante
MapTo()La asignación almacena clases de componentes y el componente
Containerproporcionado la utiliza internamente para recuperar y crear instancias de componentes de forma dinámica en función del tipo de recurso dado.Este mapa sirve como "pegamento" entre el front-end y el back-end para que el editor sepa a qué componentes corresponden los componentes de react.
PageyResponsiveGridson buenos ejemplos de clases que amplían la baseContainer. -
Defina
EditConfigdel componente como parámetro paraMapTo()Este parámetro es necesario para indicar al editor cómo se debe asignar un nombre al componente, siempre que no se haya procesado aún o no tenga contenido para procesar.
-
Extender la clase
Containerproporcionada para páginas y contenedoresLos sistemas de páginas y párrafos deben ampliar esta clase para que la delegación a los componentes internos funcione según lo esperado.
-
Implementar una solución de enrutamiento que use la API HTML5
History.Cuando
ModelRouterestá habilitado, al llamar a las funcionespushStateyreplaceStatese déclencheur una solicitud aPageModelManagerpara recuperar un fragmento que falta del modelo.La versión actual de
ModelRoutersolo admite el uso de direcciones URL que apunten a la ruta de recursos real de los puntos de entrada del modelo Sling. No admite el uso de direcciones URL o alias de vanidad.ModelRouterse puede deshabilitar o configurar para que ignore una lista de expresiones regulares.
AEM-Agnostic aem-agnostic
Estos bloques de código ilustran cómo los componentes de React y Angular no necesitan nada específico de Adobe o AEM.
- Todo lo que se encuentra dentro del componente JavaScript no depende de 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.
El asistente de MapTo es el "pegado" que permite hacer coincidir los componentes del back-end y del front-end:
- Indica al contenedor de JS (o sistema de párrafos de JS) qué componente de JS es responsable de procesar cada uno de los componentes presentes en el JSON.
- Agrega un atributo de datos de HTML a HTML que procesa el componente JS, 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 la creación de SPA para AEM en general, consulte la guía de introducción para el marco de trabajo elegido.
Arquitectura de 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 encaja el desarrollo de SPA en esta arquitectura.
-
Entorno de compilación
En este entorno es donde se extrae el origen de la aplicación SPA y del componente.
- El generador clientlib de NPM crea una biblioteca de cliente a partir del proyecto de SPA.
- Esa biblioteca la toma Maven y la implementa el complemento de compilación de Maven junto con el componente al autor de AEM.
-
Autor de AEM
El contenido se crea en el autor de AEM, incluidas las SPA de creación.
Cuando se edita una SPA con el Editor de SPA en el entorno de creación:
- La SPA solicita la HTML externa.
- Se carga el CSS.
- Se carga la JavaScript de la aplicación SPA.
- Cuando se ejecuta la aplicación SPA, se solicita el JSON, lo que permite a la aplicación crear el DOM de la página, incluidos los atributos
cq-data. - Los atributos
cq-datapermiten al editor cargar información de página adicional para saber qué configuraciones de edición están disponibles para los componentes.
-
Publicación de AEM
Donde el contenido creado y las bibliotecas compiladas, incluidos los artefactos de la aplicación SPA, las bibliotecas de cliente y los componentes, se publican para el consumo público.
-
Dispatcher / CDN
Dispatcher sirve como capa de almacenamiento en caché de AEM para los visitantes del sitio.
- Las solicitudes se procesan de forma similar a como se encuentran en AEM Author. Sin embargo, no se solicita la información de la página porque solo la necesita el editor.
- JavaScript, CSS, JSON y HTML se almacenan en caché, lo que optimiza la página para una entrega rápida.
Próximos pasos next-steps
- Introducción a SPA en AEM con React muestra cómo se crea un SPA básico para trabajar con el Editor de SPA en AEM con React.
- Introducción a SPA en AEM con Angular muestra cómo se crea un SPA básico para trabajar con el Editor de SPA en AEM con Angular.
- La Información general del Editor de SPA profundiza en el modelo de comunicación entre AEM y el SPA.
- Proyecto de SPA de WKND es un tutorial paso a paso para implementar un proyecto de SPA simple en AEM.
- Asignación de modelos dinámicos a componentes para SPA explica el modelo dinámico a la asignación de componentes y cómo funciona dentro de SPA en AEM.
- Modelo SPA proporciona una explicación detallada del funcionamiento de SPA SDK para AEM en caso de que desee implementar SPA en AEM para un módulo que no sea React o Angular. O, simplemente, desea una comprensión más profunda.