Utveckla SPA för AEM

Senaste uppdatering: 2023-06-29

Single page applications (SPA) can offer compelling experiences for website users. Utvecklare vill kunna skapa webbplatser med SPA ramverk och författare vill smidigt redigera innehåll i AEM för en webbplats som skapats med sådana ramverk.

I den här artikeln finns viktiga frågor att tänka på när en frontendutvecklare ska utveckla en SPA för AEM och en översikt över arkitekturen i AEM för att distribuera SPA på AEM.

SPA utvecklingsprinciper för AEM

Utveckla single page-applikationer AEM förutsätter att frontutvecklaren följer vedertagna standarder när han skapar en SPA. Om du som gränssnittsutvecklare följer dessa allmänna bästa metoder och några AEM specifika principer fungerar SPA med AEM och funktioner för att skapa innehåll.

  • Portabilitet - Precis som med andra komponenter bör komponenterna byggas så att de är så bärbara som möjligt. SPA bör byggas med rörliga och återanvändbara komponenter.
  • AEM diskar platsstruktur - Utvecklaren skapar komponenter och äger sin interna struktur, men använder AEM för att definiera webbplatsens innehållsstruktur.
  • Dynamisk återgivning - All återgivning ska vara dynamisk.
  • Dynamisk routning - SPA ansvarar för routningen och AEM lyssnar på den och hämtar baserat på den. Alla routningar ska också vara dynamiska.

Om du håller dessa principer i åtanke när du utvecklar SPA blir det så flexibelt och säkert som möjligt i framtiden, samtidigt som du aktiverar alla funktioner för AEM som stöds.

Om du inte behöver ha stöd AEM redigeringsfunktionerna kan du välja något annat SPA.

Portabilitet

Precis som när du utvecklar en komponent bör dina komponenter utformas på ett sådant sätt att de blir så bärbara som möjligt. Mönster som motverkar komponenternas bärbarhet eller återanvändbarhet bör undvikas för att säkerställa kompatibilitet, flexibilitet och underhållbarhet.

Den resulterande SPA ska byggas med mycket portabla och återanvändbara komponenter.

AEM diskar platsstruktur

Utvecklaren måste tänka på sig själv som ansvarig för att skapa ett bibliotek med SPA komponenter som används för att bygga appen. Utvecklaren har fullständig kontroll över komponenternas interna struktur. AEM äger dock alltid webbplatsens struktur.

Den här kontrollen innebär att gränssnittsutvecklaren kan lägga till kundinnehåll före eller efter komponenternas startpunkt och även göra ett tredjepartssamtal inuti komponenten. Utvecklaren har dock inte fullständig kontroll över hur komponenterna kapslas, till exempel.

Dynamisk återgivning

SPA ska endast förlita sig på dynamisk återgivning av innehåll. Detta är standardinställningen där AEM hämtar och återger alla underordnade element i innehållsstrukturen.

All explicit återgivning som pekar på visst innehåll betraktas som statisk återgivning och även om den stöds är kompatibel med AEM innehållsredigeringsfunktioner. Det går också emot principen om bärbarhet.

Dynamisk routning

Precis som vid återgivning ska all routning också vara dynamisk. AEM SPA ska alltid äga routningen och AEM lyssnar på den och hämtar innehåll baserat på den.

Alla statiska routningar fungerar mot bärbarhetsprincip och begränsar författaren genom att inte vara kompatibel med redigeringsfunktionerna i AEM. Om innehållsförfattaren till exempel vill ändra en väg eller ändra en sida för statisk routning måste han eller hon be den som utvecklar sidan att göra det.

AEM Project Archetype

Alla AEM ska använda AEM Project Archetype, som stöder SPA projekt med React eller Angular och använder SPA SDK.

SPA designmodeller

Om principer för utveckling av SPA inom AEM följs, SPA fungerar med alla funktioner som stöds AEM innehåll.

Det kan dock finnas fall då denna funktion inte är helt nödvändig. Tabellen nedan ger en översikt över de olika designmodellerna, deras fördelar och nackdelar.

Designmodell
Fördelar Nackdelar
AEM används som headless CMS utan att använda SPA SDK-ramverket. Utvecklaren har fullständig kontroll över appen.

Innehållsförfattare kan inte använda AEM.

Koden är inte portabel eller återanvändbar om den innehåller statiska referenser eller routning.

Det går inte att använda mallredigeraren, så frontendutvecklaren måste underhålla redigerbara mallar via JCR.

Utvecklaren använder SDK-ramverket för SPA Editor, men bara vissa områden öppnas för innehållsförfattaren. Utvecklaren behåller kontrollen över appen genom att endast aktivera redigering i begränsade delar av appen.

Innehållsförfattare är begränsade till en begränsad uppsättning AEM upplevelser.

Koden riskerar att inte vara flyttbar eller återanvändbar om den innehåller statiska referenser eller routning.

Det går inte att använda mallredigeraren, så frontendutvecklaren måste underhålla redigerbara mallar via JCR.

I projektet används SPA Editor SDK fullt ut och klientkomponenterna utvecklas som ett bibliotek och innehållsstrukturen i programmet delegeras till AEM.

Appen är återanvändbar och portabel.

Innehållsförfattaren kan redigera appen med hjälp av AEM.

SPA är kompatibelt med mallredigeraren.

Utvecklaren har inte kontroll över programmets struktur och den del av innehållet som har delegerats till AEM.

Utvecklaren kan fortfarande reservera områden i programmet för innehåll som inte ska redigeras med AEM.

OBSERVERA

Även om alla modeller stöds i AEM, är det bara genom att implementera den tredje (och följa de rekommenderade Principer för SPA) är det innehåll som författarna kan interagera med och redigera innehållet i SPA i AEM.

Migrerar befintliga SPA till AEM

Om SPA följer SPA utvecklingsprinciper för AEMfungerar SPA i AEM och kan redigeras med AEM SPA Editor.

Följ de här stegen för att göra dina befintliga SPA redo att arbeta med AEM.

  1. Gör dina JS-komponenter modulära. - Gör att de kan återges i valfri ordning, position och storlek.
  2. Använd behållarna från SDK för att placera dina komponenter på skärmen. - AEM innehåller en sid- och styckesystemkomponent som du kan använda.
  3. Skapa en AEM för varje JS-komponent. - AEM komponenter definierar dialogrutan och JSON-utdata.

Instruktioner för gränssnittsutvecklare

Den främsta uppgiften att engagera en gränssnittsutvecklare för att skapa en SPA för AEM är att komma överens om komponenterna och deras JSON-modeller.

Här följer en översikt över de steg som en frontendutvecklare måste följa när han utvecklar en SPA för AEM.

  1. Godkänn komponenterna och deras JSON-modell

    Utvecklare och AEM måste komma överens om vilka komponenter som är nödvändiga och en modell så att det går att hitta en exakt motsvarighet mellan komponenterna SPA bakomliggande komponenter.

    AEM är fortfarande nödvändiga för att kunna tillhandahålla redigeringsdialogrutor och exportera komponentmodellen.

  2. I Reagera-komponenter får du åtkomst till modellen viathis.props.cqModel

    När komponenterna är överenskomna och JSON-modellen är på plats kan den som utvecklar SPA utveckla den och enkelt komma åt JSON-modellen via this.props.cqModel.

  3. Implementera komponentens render() method

    Utvecklaren implementerar render() metoden så som den passar och kan använda fälten i cqModel -egenskap. Den här metoden matar ut DOM- och HTML-fragmenten som infogas på sidan. Den här metoden är också standardmetoden för att skapa en app i React.

  4. Mappa komponenten till AEM-resurstypen viaMapTo()

    Mappningen lagrar komponentklasser och används internt av den angivna Container för att hämta och dynamiskt instansiera komponenter baserat på den angivna resurstypen.

    Den här kartan fungerar som en"limma" mellan fram- och bakände så att redigeraren vet vilka komponenter som de olika reaktionskomponenterna motsvarar.

    The Page och ResponsiveGrid är bra exempel på klasser som utökar basen Container.

  5. Definiera komponentens EditConfig som parameter tillMapTo()

    Den här parametern är nödvändig för att tala om för redigeraren hur komponenten ska namnges så länge som den inte har återgetts eller inte har något innehåll att återge.

  6. Utöka den angivna Container klass för sidor och behållare

    Sidor och styckesystem bör utöka den här klassen så att delegering till inre komponenter fungerar som förväntat.

  7. Implementera en routningslösning som använder HTML5 History API.

    När ModelRouter är aktiverat, anropar pushState och replaceState funktioner som utlöser en begäran till PageModelManager för att hämta ett saknat fragment av modellen.

    Den aktuella versionen av ModelRouter stöder endast användning av URL:er som pekar på den faktiska resurssökvägen för Sling Model-startpunkter. Det stöder inte användning av vanity-URL:er eller alias.

    The ModelRouter kan inaktiveras eller konfigureras för att ignorera en lista med reguljära uttryck.

AEM

Dessa kodblock illustrerar hur komponenterna React och Angular inte behöver något som är specifikt för Adobe eller AEM.

  • Allt som finns inuti JavaScript-komponenten är AEM-agnostiskt.
  • Men det som är specifikt för AEM är att JS-komponenten måste mappas till en AEM med MapTo-hjälpen.

AEM

The MapTo helper är den limning som gör att bakände och framände kan matchas ihop:

  • Den talar om för JS-behållaren (eller JS-styckesystemet) vilken JS-komponent som ansvarar för återgivningen av varje komponent som finns i JSON.
  • Det lägger till ett dataattribut för HTML i HTML som JS-komponenten återger, så att SPA Editor vet vilken dialogruta som ska visas för författaren när komponenten redigeras.

Mer information om hur du använder MapTo och skapa SPA för AEM i allmänhet, se Komma igång-guiden för ditt valda ramverk.

AEM och SPA

Den allmänna arkitekturen för AEM, inklusive utvecklings-, skribent- och publiceringsmiljöer, förändras inte när SPA används. Men det är bra att förstå hur SPA kan integreras i arkitekturen.

AEM och SPA

  • Bygg miljö

    I den här miljön är källan för SPA program och komponentkälla utcheckad.

    • NPM-generatorn för klientlib skapar ett klientbibliotek från det SPA projektet.
    • Biblioteket tas av Maven och distribueras av Maven Build-pluginen tillsammans med komponenten till AEM Author.
  • AEM Author

    Innehåll skapas på AEM författare, inklusive SPA.

    När en SPA redigeras med SPA Editor i redigeringsmiljön:

    1. SPA begär yttre HTML.
    2. CSS läses in.
    3. JavaScript-koden för det SPA programmet läses in.
    4. När SPA körs begärs JSON, vilket gör att programmet kan skapa sidans DOM inklusive cq-data attribut.
    5. The cq-data kan redigeraren läsa in ytterligare sidinformation så att den vet vilka redigeringskonfigurationer som är tillgängliga för komponenterna.
  • AEM Publish

    Om det innehåll och de kompilerade biblioteken som innehåller SPA programartefakter, klientbibliotek och komponenter publiceras för offentlig konsumtion.

  • Dispatcher/CDN

    Dispatcher fungerar som AEM för webbplatsens besökare.

    • Förfrågningar behandlas på samma sätt som de behandlas i AEM Author. Det finns dock ingen begäran om sidinformationen eftersom den bara behövs av redigeraren.
    • JavaScript, CSS, JSON och HTML cachelagras, vilket optimerar sidan för snabb leverans.
OBSERVERA

I AEM finns ingen anledning att köra JavaScript-byggmekanismer eller själva JavaScript. AEM är bara värd för de kompilerade artefakterna från det SPA programmet.

Nästa steg

På denna sida