DokumentationAEM as a Cloud ServiceAnvändarhandbok

Utveckla SPA för AEM developing-spas-for-aem

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Skapat för:

  • Administratör
  • Utvecklare

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 för AEM spa-development-principles-for-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 dess innehållsredigeringsfunktioner.

  • Portabilitet - Precis som med andra komponenter bör komponenterna byggas så att de blir så portabla som möjligt. SPA bör byggas med rörliga och återanvändbara komponenter.
  • AEM Drives Site Structure - Front-end-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 bör du överväga en annan SPA designmodell.

Portabilitet portability

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 aem-drives-site-structure

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 dynamic-rendering

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 för portability.

Dynamisk routning dynamic-routing

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

Statisk routning fungerar mot principen för bärbarhet och begränsar författaren genom att inte vara kompatibel med innehållsredigeringsfunktionerna 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 Archettype aem-project-archetype

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

SPA designmodeller spa-design-models

Om du följer principerna för att utveckla SPA i AEM fungerar SPA med alla funktioner som stöds AEM innehållsredigeringsfunktionen.

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 ett headless CMS utan att SPA Editor SDK-ramverket används.
Utvecklaren har fullständig kontroll över appen.

Innehållsförfattare kan inte använda AEM för innehållsredigering.

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.

Författare av innehåll är begränsade till en begränsad uppsättning AEM redigeringsupplevelser.

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 AEM redigeringsgränssnittet.

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.

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

Migrerar befintliga SPA till AEM migrating-existing-spas-to-aem

Om SPA följer SPA-utvecklingsprinciperna för AEM fungerar SPA i AEM och kan redigeras med AEM SPA.

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 instructions-for-front-end-developers

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 komponenter 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 kommer du åt modellen viathis.props.cqModel

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

  3. Implementera komponentens render()-metod

    Utvecklaren implementerar metoden render() så som den passar och kan använda fälten för egenskapen cqModel. 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 resurstyp viaMapTo()

    Mappningen lagrar komponentklasser och används internt av den angivna Container-komponenten 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.

    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-klassen 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 utlöser ett anrop till funktionerna pushState och replaceState en begäran till PageModelManager om att hämta ett saknat fragment av modellen.

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

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

AEM aem-agnostic

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 Agnostic approach

Hjälpprogrammet MapTo är den limma som gör att bakände och framände-komponenterna kan matchas tillsammans:

  • 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 skapar SPA för AEM i allmänhet finns i guiden Komma igång för det valda ramverket.

AEM och SPA aem-architecture-and-spas

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

  • Byggmiljö

    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 SPA.
    • Biblioteket tas av Maven och distribueras av Maven Build-pluginen tillsammans med komponenten till AEM författare.

  • AEM författare

    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 för SPA läses in.
    4. När SPA körs begärs JSON, vilket gör att programmet kan skapa sidans DOM inklusive attributen cq-data.
    5. Med attributen 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 författare. 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.
NOTE
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 next-steps

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab