AEM Developer Tools for Eclipse

Panoramica

AEM Developer Tools for Eclipse è un plugin Eclipse basato sul plugin Eclipse per Apache Sling rilasciato sotto la licenza Apache 2.

Offre diverse funzioni che semplificano AEM sviluppo:

  • Integrazione perfetta con AEM istanze tramite il connettore Eclipse Server
  • Sincronizzazione per contenuti e bundle OSGi
  • Supporto per il debug con la funzionalità di sostituzione del codice a caldo
  • Avvio semplice di AEM progetti tramite una procedura guidata specifica per la creazione di progetti
  • Facile modifica delle proprietà JCR

Requisiti

Prima di utilizzare gli AEM Developer Tools, è necessario:

NOTA

In macOS, è necessario fare clic con il pulsante destro del mouse su Eclipse.app, quindi selezionare Mostra contenuto pacchetto per trovare il eclipse.ini.

Come installare AEM Developer Tools per Eclipse

Una volta soddisfatti i requisiti sopra, potete installare il plug-in come segue:

  1. Aprire il sito Web AEM Developer Tools.

  2. Copiare il collegamento di installazione.

    In alternativa potete scaricare un archivio invece di utilizzare il collegamento di installazione. Questo consente l'installazione offline, ma in questo modo non riceverete notifiche di aggiornamento automatiche.

  3. In Eclipse, aprire il menu Help.

  4. Fare clic su Installa nuovo software.

  5. Fate clic su Aggiungi….

  6. In Name immettere AEM Developer Tools.

  7. In Posizione copiare l'URL di installazione.

  8. Fate clic su Aggiungi.

  9. Controllare i plug-in AEM e Sling.

  10. Fai clic su Avanti.

  11. Nella finestra Install Details fare di nuovo clic su Next.

  12. Accettate i contratti di licenza e fate clic su Fine.

  13. Fare clic su RestartNow per riavviare Eclipse.

La prospettiva AEM

In Eclipse una prospettiva determina le azioni e le viste disponibili all’interno di una finestra e abilita l’interazione orientata alle attività con le risorse in Eclipse. Per ulteriori dettagli sulla prospettiva, consultare la documentazione di Eclipse.

AEM Strumenti di sviluppo per Eclipse fornisce una AEM prospettiva che offre il pieno controllo sui progetti e le istanze AEM. Per aprire la prospettiva AEM:

  1. Dalla barra dei menu Eclipse, selezionare Finestra -> Prospettiva -> Apri prospettiva -> Altro.
  2. Selezionare AEM nella finestra di dialogo e fare clic su Apri.

La prospettiva AEM in Eclipse

Esempio di progetto multi-modulo

AEM Developer Tools for Eclipse è dotato di un progetto multivodulo di esempio che consente di acquisire rapidamente la massima velocità grazie alla configurazione di un progetto in Eclipse, oltre a fungere da guida best practice per diverse funzioni AEM. Ulteriori informazioni su Project Archetype.

Per creare il progetto di esempio, effettuate le seguenti operazioni:

  1. Nel menu File > New > Project, passare alla sezione AEM e selezionare AEM Sample Multi-Module Project.

    AEM esempio di progetto con più moduli

  2. Fai clic su Avanti.

    NOTA

    Questo passaggio potrebbe richiedere alcuni minuti perché m2eclipse deve eseguire la scansione dei cataloghi archetype.

  3. Scegliere com.adobe.granite.archetypes : sample-project-archetype : <highest-number> dal menu, quindi fare clic su Next.

    Seleziona versione archetipo

  4. Immettete i seguenti campi per il progetto di esempio:

    • Nome
    • ID gruppo
    • Id Artifact
    • appId : per impostare questo valore potrebbe essere necessario espandere le ​opzioni Avanzate.
    • appTitle - Per impostare questo valore potrebbe essere necessario espandere le ​opzioni Avanzate.
    • Pacchetto : per impostare questo valore potrebbe essere necessario espandere le ​opzioni Avanzate.

    Definizione delle proprietà archetype

  5. Fai clic su Avanti.

  6. Quindi configurate un server AEM a cui Eclipse si connetterà.

    Per utilizzare la funzione Debugger, è necessario aver avviato AEM in modalità debug, che può essere ottenuta ad esempio aggiungendo quanto segue alla riga di comando:

        -nofork -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10123
    

    Connetti al server AEM

  7. Fare clic su Fine. La struttura del progetto viene creata.

    NOTA

    In una nuova installazione (più precisamente, quando le dipendenze di colore non sono mai state scaricate) è possibile che il progetto venga creato con errori. In questo caso, seguire la procedura descritta in Risoluzione della definizione di progetto non valida.

Come importare progetti esistenti

È possibile utilizzare la funzione Nuovo progetto per creare la struttura giusta:

  1. Seguite le istruzioni per creare un Esempio di progetto multi-modulo e avrete i seguenti progetti creati per voi, che consentiranno una sana separazione delle preoccupazioni:

    • PROJECT.ui.apps per /apps e /etc contenuto
    • PROJECT.ui.content per /content cui è stato creato
    • PROJECT.core per i bundle Java (questi diventeranno interessanti non appena si desidera aggiungere codice Java)
    • PROJECT.it.launcher e PROJECT.it.tests per test di integrazione
  2. Sostituite il contenuto del progetto PROJECT.ui.apps con le cartelle apps e etc del pacchetto:

    1. Nel pannello Esplora progetti, aprire PROJECT.ui.apps > src > main > content > jcr_root > apps.
    2. Fare clic con il pulsante destro del mouse sulla cartella apps e scegliere Mostra in > System Explorer.
    3. Eliminate le cartelle apps e etc che dovrebbero essere visualizzate e inserite qui le cartelle apps e etc del pacchetto di contenuti.
    4. In Eclipse, fare clic con il pulsante destro del mouse sul progetto PROJECT.ui.apps e scegliere Aggiorna.
  3. Quindi eseguite le stesse operazioni per PROJECT.ui.content e sostituite la cartella del contenuto con quella del pacchetto:

    1. Nel pannello Esplora progetti, aprire PROJECT.ui.content > src > main > content > jcr_root > content.
    2. Fare clic con il pulsante destro del mouse sulla cartella del contenuto più profondo e scegliere Mostra in -> System Explorer.
    3. Eliminate la cartella del contenuto da visualizzare e inserite qui la cartella del contenuto del pacchetto di contenuto.
    4. In Eclipse, fare clic con il pulsante destro del mouse sul progetto PROJECT.ui.content e scegliere Aggiorna.
  4. Ora è necessario aggiornare i file filter.xml di questi due progetti in modo che corrispondano al contenuto del pacchetto di contenuti. A questo scopo, aprite il file META-INF/vault/filter.xml del pacchetto di contenuti in un editor di testo/codice separato.

    • Questo è un esempio di come può essere visualizzato il file filter.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. Per quanto riguarda il contenuto del pacchetto suddiviso in due progetti, dovrete anche dividere queste regole di filtro in due e aggiornare di conseguenza i file filter.xml dei due progetti.

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

    2. Sostituire il contenuto dell'elemento <workspaceFilter> con le regole del pacchetto che iniziano con /apps e /etc

      • Esempio:

        <?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. Quindi aprire PROJECT.ui.content/src/main/content/META-INF/filter.xml.

    4. Sostituisci le regole con quelle del pacchetto che iniziano con /content.

      • Esempio:

        <?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. Assicuratevi di salvare tutte le modifiche. Ora potete sincronizzare il nuovo contenuto con l'istanza AEM.

  7. Nel pannello Server, accertatevi che la connessione sia avviata e, in caso contrario, avviatela.

  8. Fare clic sull'icona Pulisci e pubblica.

Al termine, il pacchetto deve essere eseguito sull'istanza e al momento del salvataggio, ogni modifica viene automaticamente sincronizzata con l'istanza.

Se desiderate rigenerare un pacchetto dal progetto, fate clic con il pulsante destro del mouse su PROJECT.ui.apps o PROJECT.ui.content e scegliete Esegui come -> Installazione Paradiso.

Ora disponete di una cartella di destinazione creata con il pacchetto all’interno (denominata ad esempio PROJECT.ui.apps-0.0.1-SNAPSHOT.zip).

Risoluzione dei problemi

Risoluzione della definizione di progetto non valida

Per risolvere dipendenze non valide e definire il progetto, procedere come segue:

  1. Seleziona tutti i progetti creati.
  2. Fare clic con il pulsante destro del mouse.
  3. Nel menu di scelta rapida, selezionare Maven -> Aggiorna progetti.
  4. Selezionare Forza aggiornamenti di snapshot/release.
  5. Fai clic su OK.

Eclipse scarica le dipendenze richieste. Questo potrebbe richiedere un momento.

Ulteriori informazioni

Il sito ufficiale Apache Sling IDE tooltool per Eclipse fornisce informazioni utili:

La seguente documentazione ufficiale Eclipse può aiutare a configurare l'ambiente:

In questa pagina