Show Menu
TOPICS×

Tipo de archivo del proyecto AEM

El arquetipo de proyecto de AEM crea un proyecto de Adobe Experience Manager mínimo basado en las prácticas recomendadas como punto de partida para sus propios proyectos de AEM. Las propiedades que se deben proporcionar al utilizar este arquetipo le permiten especificar los nombres de todas las partes de este proyecto, así como controlar determinadas funciones opcionales.

¿Por qué usar el arquetipo?

El uso del arquetipo de proyecto de AEM le permite avanzar hacia la creación de un proyecto de AEM basado en las prácticas recomendadas con solo unas pocas pulsaciones de tecla. Mediante el uso del arquetipo, todas las piezas ya estarán en su lugar, de modo que mientras el proyecto resultante sea mínimo, ya implementará todas las funciones Qué se obtiene usando el arquetipo clave de AEM para que todo lo que tenga que hacer sea construir en la parte superior y extender.
Por supuesto, hay muchos elementos que entran en un proyecto AEM exitoso, pero el uso del arquetipo de proyecto AEM es una base sólida y se recomienda encarecidamente para cualquier proyecto AEM.

Introducción

El arquetipo del proyecto facilita el inicio del desarrollo en AEM. Puede dar sus primeros pasos de varias maneras.
  • Tutorial de WKND: para obtener una buena introducción al desarrollo de AEM, incluida la forma de aprovechar el arquetipo, consulte el tutorial overview.html Introducción a AEM Sites - WKND para ver un ejemplo práctico de cómo usar el arquetipo para implementar un proyecto sencillo.
  • Tutorial de Eventos WKND: si está particularmente interesado en el desarrollo de aplicaciones de una sola página (SPA) en AEM, asegúrese de consultar el tutorial de Eventos WKND dedicado.
  • Descarga y inicio por su cuenta! - Puede descargar fácilmente el arquetipo de proyecto actual disponible en GitHub y crear su primer proyecto siguiendo los sencillos pasos a continuación .

Qué se obtiene usando el arquetipo

El arquetipo de AEM está compuesto de módulos:
  • : es un paquete Java que contiene toda la funcionalidad básica, como servicios OSGi, oyentes y Planificadoras, así como código Java relacionado con componentes, como servlets y filtros de solicitud.
  • : contiene las partes
    /apps
    y
    /etc
    partes del proyecto, es decir, clientes de JS y CSS, componentes, plantillas, configuraciones específicas de runmode, así como pruebas de Hobbes.
  • : contiene contenido de muestra utilizando los componentes del módulo ui.apps.
  • : es un paquete Java que contiene pruebas JUnit que se ejecutan en el servidor. Este paquete no debe implementarse en producción.
  • ui.launcher
    : contiene código de pegado que implementa el paquete ui.testing (y paquetes dependientes) en el servidor y activa la ejecución remota de JUnit.
  • :
    (opcional)
    ​contiene los artefactos necesarios para utilizar el módulo de compilación general basado en Webpack.
  • :
    (opcional)
    ​contiene los artefactos requeridos al utilizar el arquetipo para crear proyectos de SPA basados en React.
  • :
    (opcional)
    ​contiene los artefactos necesarios al utilizar el arquetipo para crear proyectos de SPA basados en Angular.
Los módulos de AEM Archetype representados en Maven se implementan en AEM como paquetes de contenido que representan la aplicación, el contenido y los paquetes OSGi necesarios.

Cómo usar el arquetipo

Para utilizar el arquetipo, primero debe crear un proyecto, que genere los módulos en una estructura de archivos local como se describió anteriormente. Como parte de la generación de proyectos, se pueden definir varias propiedades para el proyecto, como el nombre del proyecto, la versión, etc.
Al crear el proyecto con Maven se crean los artefactos (paquetes y paquetes OSGi) que se pueden implementar en AEM. Se pueden utilizar comandos y perfiles Maven adicionales para implementar los artefactos del proyecto en una instancia de AEM.

Creación de un proyecto

Para empezar, puede simplemente utilizar la extensión Eclipse de AEM y seguir el Asistente para nuevo proyecto y elegir Proyecto
multimódulo de muestra de
AEM para utilizar una versión publicada del arquetipo.
Por supuesto también puede invocar Maven directamente.
mvn -B archetype:generate \ -D archetypeGroupId=com.adobe.granite.archetypes \ -D archetypeArtifactId=aem-project-archetype \ -D archetypeVersion=XX \ -D aemVersion=cloud \ -D appTitle="My Site" \ -D appId="mysite" \ -D groupId="com.mysite" \ -D frontendModule=general \ -D includeExamples=n
  • Establezca
    XX
    el número de versión del último arquetipo de proyecto de AEM.
  • Set
    aemVersion=cloud
    for AEM as a Cloud Service ; Se configura
    aemVersion=6.5.0
    para Adobe Managed Services o in situ. La dependencia Componentes principales solo se agrega para las versiones de Aem que no son de nube, ya que los Componentes principales se proporcionan OOTB para AEM como un servicio de nube.
  • Ajuste
    appTitle="My Site"
    para definir el título del sitio web y los grupos de componentes.
  • Ajuste
    appId="mysite"
    para definir Maven artifactsId, los nombres de los componentes, la configuración y las carpetas de contenido, así como los nombres de las bibliotecas de cliente.
  • Ajuste
    groupId="com.mysite"
    para definir el groupId de Maven y el paquete de origen de Java.
  • Busque la lista de propiedades disponibles para ver si hay más que desea ajustar.
Se recomienda añadir el
adobe-public
perfil al archivo Maven
settings.xml
para añadir automáticamente repo.adobe.com al proceso de generación de lotes.
Aquí se puede encontrar un ejemplo de POM.

Propiedades

Las siguientes propiedades están disponibles al crear un proyecto con el arquetipo.
Nombre
Predeterminado
Descripción
appTitle
El título de la aplicación se utilizará para el título del sitio web y los grupos de componentes (p. ej.
"My Site"
).
appId
El nombre técnico se utilizará para los nombres de los componentes, la configuración y las carpetas de contenido, así como los nombres de las bibliotecas de cliente (p. ej.
"mysite"
).
artifactId
${appId}
ID de artefacto de la mueble base (p. ej.
"mysite"
).
groupId
ID de grupo de Maven base (p. ej.
"com.mysite"
).
package
${groupId}
Paquete de fuentes Java (p. ej.
"com.mysite"
).
version
1.0-SNAPSHOT
Versión del proyecto (p. ej.
1.0-SNAPSHOT
).
aemVersion
6.5.0
Versión de AEM de Destinatario (puede ser
cloud
para AEM como un servicio de nube; o
6.5.0
,
6.4.4
o
6.3.3
para Adobe Managed Services o in situ).
sdkVersion
latest
Cuando se puede especificar
aemVersion=cloud
una versión del SDK (p. ej.
2020.02.2265.20200217T222518Z-200130
).
includeDispatcherConfig
y
Incluye una configuración de distribuidor para cloud o para AMS/in situ, según el valor de
aemVersion
(puede ser
y
o
n
).
frontendModule
none
Incluye un módulo de compilación de front-end de Webpack que genera las bibliotecas de cliente (puede ser
general
o
none
para sitios normales; puede ser
angular
o
react
para una aplicación de una sola página que implemente el Editor de SPA).
languageCountry
en_us
Idioma y código de país desde los que crear la estructura de contenido (p. ej.
en_us
).
singleCountry
y
Incluye una estructura de contenido maestro-idioma (puede ser
y
o
n
).
includeExamples
y
Incluye un sitio de ejemplo de la biblioteca de componentes (puede ser
y
o
n
).
includeErrorHandler
n
Incluye una página de respuesta personalizada 404 que será global para toda la instancia (puede ser
y
o
n
).
Si el arquetipo se ejecuta en modo interactivo la primera vez, no se pueden cambiar las propiedades con valores predeterminados (consulte ARCHETYPE-308 para obtener más información). El valor se puede cambiar cuando se deniega la confirmación de la propiedad al final y se repite el cuestionario, o pasando el parámetro en la línea de comandos (p. ej.
-DoptionIncludeExamples=n
).
Cuando se ejecuta en Windows y se genera la configuración del despachante, debe estar ejecutando un símbolo del sistema elevado o el Subsistema de Windows para Linux (consulte el problema 329 ).

Perfiles

El proyecto principal generado admite diferentes perfiles de implementación al ejecutarse
mvn install
.
ID de Perfil
Descripción
autoInstallBundle
Monte el paquete principal con el complemento maven-sling en la consola felix
autoInstallPackage
Instale el paquete de contenido ui.content y ui.apps con el complemento content-package-maven-plugin en el administrador de paquetes para la instancia de creación predeterminada en localhost, puerto 4502. El nombre de host y el puerto se pueden cambiar con las propiedades definidas por el usuario
aem.host
y el
aem.port
usuario.
autoInstallPackagePublish
Instale el paquete de contenido ui.content y ui.apps con el complemento content-package-maven-plugin en el administrador de paquetes para publicar la instancia predeterminada en localhost, puerto 4503. El nombre de host y el puerto se pueden cambiar con las propiedades definidas por el usuario
aem.host
y el
aem.port
usuario.
autoInstallSinglePackage
Instale el paquete de
all
contenido con el content-package-maven-plugin en el administrador de paquetes para la instancia de creación predeterminada en localhost, puerto 4502. El nombre de host y el puerto se pueden cambiar con las propiedades definidas por el usuario
aem.host
y el
aem.port
usuario.
autoInstallSinglePackagePublish
Instale el paquete de
all
contenido con el complemento content-package-maven-plugin en el administrador de paquetes para publicar la instancia predeterminada en localhost, puerto 4503. El nombre de host y el puerto se pueden cambiar con las propiedades definidas por el usuario
aem.host
y el
aem.port
usuario.
integrationTests
Ejecuta las pruebas de integración proporcionadas en la instancia de AEM (solo para la
verify
fase)

Generación e instalación

Para generar todos los módulos ejecutados en el directorio raíz del proyecto, utilice el siguiente comando Maven.
mvn clean install
Si tiene una instancia de AEM en ejecución, puede compilar y empaquetar todo el proyecto e implementarlo en AEM con el siguiente comando Maven.
mvn clean install -PautoInstallPackage
Para implementarlo en una instancia de publicación, ejecute este comando.
mvn clean install -PautoInstallPackagePublish
Como alternativa, para implementar en una instancia de publicación, ejecute este comando.
mvn clean install -PautoInstallPackage -Daem.port=4503
O bien, para implementar únicamente el paquete para el autor, ejecute este comando.
mvn clean install -PautoInstallBundle

POM principal

El
pom.xml
en la raíz del proyecto (
<src-directory>/<project>/pom.xml
) se conoce como POM principal y dirige la estructura del proyecto, además de administrar dependencias y ciertas propiedades globales del proyecto.

Propiedades del proyecto global

La
<properties>
sección del POM principal define varias propiedades globales que son importantes para la implementación del proyecto en una instancia de AEM, como nombre de usuario/contraseña, nombre de host/puerto, etc.
Estas propiedades están configuradas para implementarse en una instancia de AEM local, ya que esta es la compilación más común que los desarrolladores van a realizar. Tenga en cuenta que hay propiedades que implementar en una instancia de autor, así como en una instancia de publicación. Aquí también se establecen las credenciales para la autenticación con la instancia de AEM. Se utilizan las credenciales predeterminadas admin:admin.
Estas propiedades se configuran para que se puedan anular al implementar en entornos de nivel superior. De este modo, los archivos POM no tienen que cambiar, pero las variables como
aem.host
y se pueden anular
sling.password
mediante argumentos de la línea de comandos:
mvn -PautoInstallPackage clean install -Daem.host=production.hostname -Dsling.password=productionpasswd

Estructura del módulo

La
<modules>
sección del POM principal define los módulos que el proyecto creará. De forma predeterminada, el proyecto crea los módulos estándar definidos anteriormente: core, ui.apps, ui.content, ui.testing y it.launcher. Siempre se pueden añadir más módulos a medida que evoluciona un proyecto.

Dependencias

La
<dependencyManagement>
sección del POM principal define todas las dependencias y versiones de las API que se utilizan en el proyecto. Las versiones se deben administrar en el POM principal. Los submódulos como core y ui.apps no deben incluir información de la versión.

Uber-Jar

Una de las dependencias clave es el subjar de AEM. Esto incluirá todas las API de AEM con una sola entrada de dependencia para la versión de AEM.
La práctica recomendada es actualizar la versión de subar-jar para que coincida con la versión de destinatario de AEM. Por ejemplo, si planea implementar en AEM 6.4, debe actualizar la versión de uber-jar a 6.4.0.

Componentes principales

Por supuesto, el arquetipo del proyecto de AEM aprovecha los componentes principales.
Los componentes principales se instalan automáticamente en AEM en el modo de ejecución predeterminado y se utilizan en el sitio de muestra de We.Retail. En un modo de ejecución de producción (
nosamplecontent
), los componentes principales no están disponibles.
Por lo tanto, para aprovechar los componentes principales en todas las implementaciones, es recomendable incluirlos como parte del proyecto Maven.
Cada versión de los componentes principales suele ir seguida de una versión del arquetipo de proyecto de AEM, de modo que el arquetipo más reciente utiliza la versión más reciente de los componentes principales.
Sin embargo, es posible que una nueva versión del arquetipo no siga directamente a una nueva versión de los componentes principales, por lo que puede que desee actualizar la dependencia de los componentes principales a la última versión.
core.wcm.components.samples es un conjunto de páginas de muestra que ilustran ejemplos de los componentes principales. Se recomienda eliminar esta dependencia y la inclusión de subpaquetes al implementar un proyecto para producción.

Pruebas

Hay tres niveles de prueba contenidos en el proyecto y, como son diferentes tipos de pruebas, se ejecutan de diferentes maneras o en diferentes lugares.
  • Prueba unitaria en el núcleo: Esto muestra las pruebas de unidades clásicas del código incluido en el paquete. Para realizar la prueba, ejecute:
    • mvn clean test
  • Pruebas de integración del lado del servidor: Estas pruebas unitarias se ejecutan en AEM-entorno, es decir, en el servidor AEM. Para realizar la prueba, ejecute:
    • mvn clean verify -PintegrationTests
  • Pruebas de Hobbes.js del lado del cliente: Son pruebas basadas en JavaScript en el navegador que verifican el comportamiento en el navegador. Para probar:
    1. Cargue AEM en el navegador como lo haría para crear una página.
    2. Open the page in Developer mode
    3. Abra el panel izquierdo y cambie a la ficha
      Pruebas
      .
    4. Busque las pruebas
      ​MyName generadas y ejecútelas.

Próximos pasos

Así que ha creado e instalado el Arquetipo de proyecto de AEM. ¿Y ahora qué? Bueno, el arquetipo es pequeño, pero consta de muchos ejemplos de potentes funciones de AEM configuradas según las optimizaciones recomendadas. Estas funciones indican cómo puede aprovechar estas funciones en el proyecto. Para cualquier proyecto que necesite: