Herramientas para desarrolladores de AEM para Eclipse aem-developer-tools-for-eclipse

Logotipo de herramientas para desarrolladores de Experience Manager para Eclipse

Información general overview

Experience Manager Developer Tools for Eclipse es un complemento de Eclipse basado en el complemento Eclipse para Apache Sling lanzado bajo la licencia Apache 2.

Ofrece varias funciones que facilitan el desarrollo de AEM:

  • Integración perfecta con las instancias de AEM a través del conector de servidor Eclipse
  • Sincronización para paquetes OSGi y de contenido
  • Compatibilidad de depuración con la capacidad de intercambio en caliente de código
  • Bootstrap simple de proyectos de AEM mediante un asistente de creación de proyectos específico
  • Edición sencilla de propiedades JCR

Requisitos requirements

Antes de utilizar las herramientas para desarrolladores de AEM, debe hacer lo siguiente:

  • Descargue e instale Eclipse IDE para desarrolladores web y Java empresariales.
    • La versión 1.4.0 de las herramientas para desarrolladores de AEM para Eclipse es compatible con Eclipse 2022-12 (4.26) o posterior y requiere Java 17 o posterior para ejecutarse.
  • Configure su instalación de Eclipse para asegurarse de que tiene al menos 1 GB de memoria de pila editando el archivo de configuración eclipse.ini tal como se describe en las Preguntas frecuentes sobre Eclipse.
NOTE
En macOS, debes hacer clic con el botón derecho en Eclipse.app y, a continuación, seleccionar Mostrar contenido del paquete para encontrar tu eclipse.ini.

Cómo instalar las herramientas para desarrolladores de AEM para Eclipse how-to-install-the-aem-developer-tools-for-eclipse

Cuando haya cumplido los requisitos anteriores, puede instalar el complemento de herramientas para desarrolladores de la siguiente manera:

  1. Abra el sitio web de herramientas para desarrolladores de AEM.

  2. Copie el vínculo de instalación.

    • Como alternativa, puede descargar un archivo en lugar de utilizar el vínculo de instalación.
    • Este método permite la instalación sin conexión, pero no recibe notificaciones de actualización automáticas.
  3. En Eclipse, abre el menú Ayuda.

  4. Haga clic en Instalar nuevo software.

  5. Haga clic en Agregar….

  6. En el campo Nombre, escriba AEM Developer Tools.

  7. En el campo Ubicación, copie la URL de instalación.

  8. Haga clic en Agregar.

  9. Compruebe los complementos de AEM y Sling.

  10. Haga clic en Siguiente.

  11. En la ventana Detalles de la instalación, revise los elementos que se van a instalar y haga clic de nuevo en Siguiente.

  12. Acepte los contratos de licencia y haga clic en Finalizar.

  13. En el cuadro de diálogo Autoridades de confianza que aparece, seleccione la autoridad o el sitio https://eclipse.adobe.com y haga clic en Confiar en seleccionados.

  14. En el cuadro de diálogo Artefactos de confianza que aparece, seleccione los firmantes de código y haga clic en Confiar en seleccionados.

  15. Haz clic en Reiniciar ahora para reiniciar Eclipse.

La perspectiva de AEM the-aem-perspective

En Eclipse, una perspectiva determina las acciones y vistas disponibles dentro de una ventana y permite la interacción orientada a tareas con los recursos de Eclipse. Para obtener más información acerca de las perspectivas, consulte la documentación de Eclipse..

Las herramientas de desarrollo de Experience Manager para Eclipse proporcionan una perspectiva de AEM que le ofrece control total sobre sus proyectos e instancias de AEM. Para abrir la perspectiva de AEM:

  1. En la barra de menús de Eclipse, seleccione Ventana > Perspectiva > Abrir perspectiva > Otra.
  2. Seleccione AEM en el cuadro de diálogo y haga clic en Abrir.

La perspectiva de AEM en Eclipse

Ejemplo de proyecto de varios módulos sample-multi-module-project

Las herramientas para desarrolladores de Experience Manager para Eclipse incluyen un proyecto de varios módulos de ejemplo que le ayudará a ponerse al día rápidamente con la configuración de un proyecto en Eclipse. También sirve como guía de prácticas recomendadas sobre varias funciones de AEM, en las que se aprovecha el tipo de archivo del proyecto AEM.

Siga estos pasos para crear el proyecto de ejemplo:

  1. En el menú Archivo > Nuevo > Proyecto, vaya a la sección AEM y seleccione Proyecto de módulo múltiple de muestra de AEM.

    Proyecto de módulo múltiple de muestra de AEM

  2. Haga clic en Siguiente.

    note note
    NOTE
    Este paso podría demorar un poco porque m2eclipse debe analizar los catálogos de arquetipos.
  3. com.adobe.aem : aem-project-archetype : <highest-number> debe seleccionarse automáticamente en la lista desplegable Tipo de archivo. Seleccione una versión anterior si lo desea. Haga clic en Siguiente.

    Seleccionar versión de tipo de archivo

  4. Proporcione los siguientes campos para el proyecto de ejemplo:

    • Nombre
    • Id. de grupo
    • Id. de artefacto
    • appId: es posible que tenga que expandir las opciones de Avanzado para establecer este valor.
    • appTitle: es posible que tenga que expandir las opciones de Advanced para establecer este valor.
    • Paquete: es posible que tenga que expandir las opciones de Avanzado para establecer este valor.

    Definir propiedades de tipo de archivo

  5. Haga clic en Siguiente.

  6. Configure un servidor de AEM al que se conecte Eclipse seleccionando Configurar nuevo servidor y proporcionando un nombre de servidor y los detalles de conexión necesarios.

    Conectarse al servidor de AEM

    • Para utilizar la característica del depurador, debe iniciar AEM en modo de depuración proporcionando el parámetro -agentlib, por ejemplo:
    code language-text
    $ java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar aem-author-p4502.jar
    
    note tip
    TIP
    Para obtener más información sobre la depuración del proyecto que se ejecuta en un SDK de AEM local, consulte el documento Depuración remota de SDK de AEM.
  7. Haga clic en Finalizar.

Se crea la estructura del proyecto. Puede tardar un momento en descargar los artefactos necesarios en el proyecto.

NOTE
En una instalación nueva o cuando las dependencias de Maven no se han descargado anteriormente, Eclipse puede informar de que el proyecto se creó con errores. En este caso, siga el procedimiento descrito en la sección Resolver la definición de proyecto no válida.

Cómo Importar Proyectos Existentes how-to-import-existing-projects

Use la característica Nuevo proyecto para crear la estructura básica del proyecto.

  1. Siga las instrucciones para crear un Proyecto de módulo múltiple de ejemplo, que crea una estructura de proyecto básica con una separación correcta de preocupaciones:

    • PROJECT.ui.apps para el contenido /apps y /etc
    • PROJECT.ui.content para /content creado
    • PROJECT.core para paquetes Java
    • PROJECT.it.launcher y PROJECT.it.tests para pruebas de integración
  2. Reemplace el contenido de su proyecto PROJECT.ui.apps por las carpetas apps y etc de su paquete:

    1. En el panel Explorador del proyecto, expanda PROJECT.ui.apps > src > main > content > jcr_root > apps.
    2. Haga clic con el botón derecho en la carpeta apps y elija Mostrar en > Explorador del sistema.
    3. Elimine las carpetas apps y etc allí.
    4. En la misma ubicación, coloque las carpetas apps y etc del paquete de contenido.
    5. En Eclipse, haga clic con el botón secundario en el proyecto PROJECT.ui.apps y elija Actualizar.
  3. A continuación, haga lo mismo para PROJECT.ui.content y reemplace su carpeta de contenido por el de sus paquetes:

    1. En el panel Explorador del proyecto, expanda PROJECT.ui.content > src > main > content > jcr_root > content.
    2. Haga clic con el botón derecho en la carpeta de contenido más detallada y elija Mostrar en > Explorador del sistema.
    3. Elimine la carpeta de contenido allí.
    4. En la misma ubicación, coloque la carpeta de contenido del paquete de contenido.
    5. En Eclipse, haga clic con el botón secundario en el proyecto PROJECT.ui.content y elija Actualizar.
  4. Actualice los filter.xml archivos de estos dos proyectos para que se correspondan con el contenido del paquete de contenido. Para ello, abra el archivo META-INF/vault/filter.xml del paquete de contenido en un editor de texto/código independiente.

    • Este es un ejemplo del aspecto que puede tener el archivo filter.xml:
    code language-xml
    <?xml version="1.0" encoding="UTF-8"?>
    <workspaceFilter version="1.0">
        <filter root="/apps/foo"/>
        <filter root="/apps/foundation/components/bar"/>
        <filter root="/etc/designs/foo"/>
        <filter root="/content/foo"/>
        <filter root="/content/dam/foo"/>
        <filter root="/content/usergenerated/content/foo"/>
    </workspaceFilter>
    
  5. En cuanto al contenido del paquete que se dividió en dos proyectos, también debe dividir estas reglas de filtro en dos y actualizar los filter.xml archivos de los dos proyectos en consecuencia.

    1. En Eclipse, abra PROJECT.ui.apps/src/main/content/META-INF/filter.xml.

    2. Reemplace el contenido del elemento <workspaceFilter> por las reglas del paquete que comiencen por /apps y /etc

      • Por ejemplo:

        code language-xml
        <?xml version="1.0" encoding="UTF-8"?>
        <workspaceFilter version="1.0">
           <filter root="/apps/foo"/>
           <filter root="/apps/foundation/components/bar"/>
           <filter root="/etc/designs/foo"/>
        </workspaceFilter>
        
    3. Luego abra PROJECT.ui.content/src/main/content/META-INF/filter.xml.

    4. Reemplace las reglas por las del paquete que comiencen por /content.

      • Por ejemplo:

        code language-xml
        <?xml version="1.0" encoding="UTF-8"?>
        <workspaceFilter version="1.0">
           <filter root="/content/foo"/>
           <filter root="/content/dam/foo"/>
           <filter root="/content/usergenerated/content/foo"/>
        </workspaceFilter>
        
  6. Asegúrese de guardar todos los cambios. Ahora puede sincronizar ese nuevo contenido con la instancia de AEM.

  7. En el panel Servidores, asegúrese de que la conexión esté iniciada y, en caso afirmativo, no iníciela.

  8. Haga clic en el icono Limpiar y publicar.

Una vez finalizado, el paquete debería estar ejecutándose en su instancia. Al guardar, cualquier cambio se sincroniza automáticamente con la instancia.

Si desea volver a compilar un paquete a partir del proyecto, haga clic con el botón derecho en PROJECT.ui.apps o PROJECT.ui.content y elija Ejecutar como > Instalación de Maven.

Ahora tiene una carpeta de destino creada con el paquete dentro de (por ejemplo, PROJECT.ui.apps-0.0.1-SNAPSHOT.zip).

Resolución de problemas troubleshooting

Resolver definición de proyecto no válida resolving-invalid-project-definition

Para resolver dependencias no válidas y la definición del proyecto, siga estos pasos:

  1. Seleccione todos los proyectos creados.
  2. Haga clic con el botón derecho.
  3. En el menú contextual, seleccione Maven > Actualizar proyectos.
  4. Compruebe Forzar actualizaciones de instantáneas/versiones.
  5. Haga clic en OK.

Eclipse descarga las dependencias requeridas. Esto puede tardar un momento.

Más información more-information

La herramienta oficial del IDE de Apache Sling para el sitio web de Eclipse proporciona información adicional útil:

La siguiente documentación oficial de Eclipse puede ayudar a configurar su entorno:

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2