AEM Developer Tools for Eclipse

Översikt

AEM Developer Tools for Eclipse är en Eclipse-plugin baserad på Eclipse-plugin för Apache Sling som släpps under Apache License 2.

Den har flera funktioner som gör AEM enklare:

  • Smidig integrering med AEM instanser via Eclipse Server Connector
  • Synkronisering för både innehåll och OSGi-paket
  • Felsökningsstöd med möjlighet att byta kod under drift
  • Enkel start av AEM projekt via en särskild projektguide
  • Enkel redigering av JCR-egenskaper

Krav

Innan du använder AEM Developer Tools måste du:

OBSERVERA

På macOS högerklickar du på Eclipse.app och sedan markera Visa paketinnehåll för att hitta eclipse.ini.

Installera AEM Developer Tools for Eclipse

När du har uppfyllt krav ovan kan du installera plugin-programmet på följande sätt:

  1. Öppna AEM Developer Tools Web Site.

  2. Kopiera Installationslänk.

    Observera att du kan hämta ett arkiv i stället för att använda installationslänken. Detta tillåter offlineinstallation men du kommer att sakna automatiska uppdateringsmeddelanden på det här sättet.

  3. Öppna Hjälp -menyn.

  4. Klicka Installera ny programvara.

  5. Klicka Lägg till….

  6. I Namn enter AEM Developer Tools.

  7. I Plats kopiera installations-URL:en.

  8. Klicka Lägg till.

  9. Markera båda AEM och Sling plugin-program.

  10. Klicka på Nästa.

  11. I Installationsinformation fönster, klicka Nästa igen.

  12. Godkänn licensavtalen och klicka på Slutför.

  13. Klicka Starta omNow för att starta om Eclipse.

AEM

I Eclipse bestämmer ett perspektiv vilka åtgärder och vyer som är tillgängliga i ett fönster och aktiverar uppgiftsorienterad interaktion med resurser i Eclipse. Mer information om Perspektiv finns i Eclipse-dokumentation.

AEM utvecklingsverktyg för Eclipse har ett AEM perspektiv som ger dig full kontroll över dina AEM projekt och instanser. Så här öppnar du AEM perspektiv:

  1. Välj Fönster -> Perspektiv -> Öppna perspektiv -> Övriga.
  2. Välj AEM i dialogrutan och klicka på Öppna.

AEM i Eclipse

Exempel på flermodulsprojekt

I AEM Developer Tools for Eclipse finns ett exempel på ett flermodulsprojekt som hjälper dig att snabbt komma igång med projektkonfigurationen i Eclipse, och som en praktisk guide till flera AEM funktioner. Läs mer om Project Archetype.

Så här skapar du exempelprojektet:

  1. I Fil > Nytt > Projekt -menyn, bläddra till AEM avsnitt och markera Exempel på AEM projekt med flera moduler.

    Exempel på AEM projekt med flera moduler

  2. Klicka på Nästa.

    OBSERVERA

    Det här steget kan ta en stund eftersom m2eclipse behöver skanna arkivtypskatalogerna.

  3. Välj com.adobe.granite.archetypes : sample-project-archetype : <highest-number> från menyn och sedan klicka på Nästa.

    Välj arkivtypsversion

  4. Ange följande fält för exempelprojektet:

    • Namn
    • Grupp-ID
    • Artefakt-ID
    • appId - Du kan behöva utöka Avancerat alternativ för att ange det här värdet.
    • appTitle - Du kan behöva utöka Avancerat alternativ för att ange det här värdet.
    • Paket - Du kan behöva utöka Avancerat alternativ för att ange det här värdet.

    Definiera egenskaper för arkityp

  5. Klicka på Nästa.

  6. Sedan konfigurerar du en AEM som Eclipse ska ansluta till.

    Om du vill använda felsökningsfunktionen måste du ha startat AEM i felsökningsläge, vilket du kan göra genom att lägga till följande på kommandoraden:

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

    Anslut till AEM server

  7. Klicka Slutför. Projektstrukturen skapas.

    OBSERVERA

    Vid en ny installation (närmare bestämt när större beroenden aldrig har laddats ned) kan du få projektet skapat med fel. I så fall, följ det förfarande som beskrivs i Löser ogiltig projektdefinition.

Importera befintliga projekt

Du kan använda Nytt projekt för att skapa rätt struktur för dig:

  1. Följ instruktionerna för att skapa en Exempel på flermodulsprojekt och följande projekt kommer att skapas åt dig, vilket gör att du kan separera dina problem på ett friskt sätt:

    • PROJECT.ui.apps for /apps och /etc innehåll
    • PROJECT.ui.content for /content som är skapad
    • PROJECT.core för Java-paket (dessa blir intressanta så fort du vill lägga till Java-kod)
    • PROJECT.it.launcher och PROJECT.it.tests för integreringstester
  2. Ersätta innehållet i PROJECT.ui.apps projektet med apps och etc mappar i ditt paket:

    1. I projektutforskarpanelen, visa PROJECT.ui.apps > src > main > content > jcr_root > apps.
    2. Högerklicka på apps mapp och välj Visa i > Systemutforskaren.
    3. Ta bort apps och etc mappar som du nu ska visa och placera här apps och etc mappar med ditt innehållspaket.
    4. I Eclipse högerklickar du på PROJECT.ui.apps projekt och välj Uppdatera.
  3. Gör sedan samma sak med PROJECT.ui.content och ersätta innehållsmappen med den i paketet:

    1. I projektutforskarpanelen, visa PROJECT.ui.content > src > main > content > jcr_root > content.
    2. Högerklicka på den djupare innehållsmappen och välj Visa i -> Systemutforskaren.
    3. Ta bort innehållsmappen som du nu ska se och placera innehållsmappen i innehållspaketet här.
    4. I Eclipse högerklickar du på PROJECT.ui.content projekt och välj Uppdatera.
  4. Nu måste du uppdatera filter.xml filer i dessa två projekt så att de motsvarar innehållet i ditt innehållspaket. Öppna META-INF/vault/filter.xml en fil med ditt innehållspaket i en separat text-/kodredigerare.

    • Detta är ett exempel på hur filter.xml filen kan se ut:
    <?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. När det gäller innehållet i ditt paket som delats upp i två projekt måste du också dela upp dessa filterregler i två och uppdatera i enlighet med det filter.xml filer från de två projekten.

    1. Öppna i Eclipse PROJECT.ui.apps/src/main/content/META-INF/filter.xml.

    2. Ersätta innehållet i <workspaceFilter> -element med reglerna i paketet som börjar med /apps och /etc

      • Till exempel:

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

    4. Ersätt reglerna med reglerna i paketet som börjar med /content.

      • Till exempel:

        <?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. Spara alla ändringar. Nu kan du synkronisera det nya innehållet med din AEM.

  7. Kontrollera att anslutningen har startats på serverpanelen och starta den om den inte redan har startats.

  8. Klicka på Rensa och publicera ikon.

När du är klar bör du låta paketet köras på din instans, och när du sparar synkroniseras alla ändringar automatiskt till instansen.

Om du vill återskapa ett paket från ditt projekt högerklickar du på PROJECT.ui.apps eller PROJECT.ui.content och välja Kör som -> Maven Install.

Nu har du en målmapp som har skapats med ditt paket (som till exempel anropas) PROJECT.ui.apps-0.0.1-SNAPSHOT.zip).

Felsökning

Löser ogiltig projektdefinition

Så här löser du ogiltiga beroenden och projektdefinitioner:

  1. Markera alla skapade projekt.
  2. Högerklicka.
  3. Välj Maven -> Uppdatera projekt.
  4. Kontrollera Tvinga uppdateringar av ögonblicksbild/releaser.
  5. Klicka OK.

Eclipse hämtar nödvändiga beroenden. Det här kan ta en stund.

Mer information

Den officiella versionen av Apache Sling IDE-verktygen för Eclipse-webbplatsen innehåller användbar information:

Följande tjänsteman Eclipse dokumentation kan hjälpa dig att konfigurera miljön:

På denna sida