SPA spa-model-routing

Voor toepassingen van één pagina in AEM, is app verantwoordelijk voor het verpletteren. Dit document beschrijft het verpletterende mechanisme, het contract, en beschikbare opties.

NOTE
De SPA Redacteur is de geadviseerde oplossing voor projecten die SPA op kader-gebaseerde cliënt-zijteruggeven (bijvoorbeeld, Reageren of Angular) vereisen.

Project routeren project-routing

App bezit het verpletteren en dan uitgevoerd door de ontwikkelaars van het projectfront. Dit document beschrijft specifiek het verpletteren voor het model dat door de AEM server is teruggekeerd. De gegevensstructuur van het paginamodel stelt URL van het onderliggende middel bloot. Het front-end project kan om het even welke douane of derdebibliotheek gebruiken die verpletterende functionaliteit verstrekt. Zodra een route een fragment van model verwacht, kan een vraag aan de PageModelManager.getData() functie worden gemaakt. Wanneer een modelroute is veranderd moet een gebeurtenis worden teweeggebracht om luisterbibliotheken zoals de Redacteur van de Pagina te waarschuwen.

Architectuur architecture

Voor een gedetailleerde beschrijving, zie de 🔗 sectie PageModelManager van het document van de SPA Vervaging.

ModelRouter modelrouter

ModelRouter - indien ingeschakeld - kapselt de HTML5 History API-functies pushState en replaceState in om te garanderen dat een bepaald fragment van het model vooraf wordt opgehaald en toegankelijk is. Vervolgens wordt de geregistreerde front-end component meegedeeld dat het model is gewijzigd.

Handmatig versus automatisch model routeren manual-vs-automatic-model-routing

Met ModelRouter worden fragmenten van het model automatisch opgehaald. Maar zoals elk geautomatiseerd gereedschap ook met beperkingen gepaard gaat. Wanneer nodig ModelRouter kan worden onbruikbaar gemaakt of worden gevormd om wegen te negeren gebruikend meta-eigenschappen (zie de sectie van Eigenschappen van Meta van het SPA het document van de Component van de Pagina). Ontwikkelaars aan de voorzijde kunnen vervolgens hun eigen model voor het routeren van lagen implementeren door PageModelManager te vragen een bepaald fragment van een model te laden met de functie getData() .

NOTE
Het {🔗 steekproefReageer project van het Dagboek van 0} Wij.Retail illustreert de geautomatiseerde benadering terwijl het project van de Angular handboek illustreert. Een semi-geautomatiseerde benadering zou ook een geldige gebruikscase zijn.
CAUTION
De huidige versie van de ModelRouter ondersteunt alleen het gebruik van URL's die verwijzen naar het feitelijke bronnenpad van de entry-punten Sling Model. Het ondersteunt het gebruik van URL's of aliassen van het type Vanity niet.

Routeringscontract routing-contract

De huidige implementatie is gebaseerd op de veronderstelling dat het SPA project HTML5 Geschiedenis API voor het verpletteren aan de verschillende toepassingspagina's gebruikt.

Configuratie configuration

ModelRouter steunt het concept model die verplettert aangezien het op pushState en replaceState vraag aan vooraf ingestelde modelfragmenten luistert. Intern activeert het PageModelManager om het model te laden dat overeenkomt met een opgegeven URL en wordt een cq-pagemodel-route-changed -gebeurtenis geactiveerd waarnaar andere modules kunnen luisteren.

Dit gedrag wordt standaard automatisch ingeschakeld. Om het onbruikbaar te maken, zou de SPA het volgende meta-bezit moeten teruggeven:

<meta property="cq:pagemodel_router" content="disabled"\>

Merk op dat elke route van de SPA aan een toegankelijke bron in AEM (bijvoorbeeld, " /content/mysite/mypage") zou moeten beantwoorden aangezien PageModelManager automatisch zal proberen om het overeenkomstige paginamodel te laden zodra de route wordt geselecteerd. Indien nodig kan de SPA echter ook een "lijst van gewezen personen" definiëren van routes die door de PageModelManager moeten worden genegeerd:

<meta property="cq:pagemodel_route_filters" content="route/not/found,^(.*)(?:exclude/path)(.*)"/>
recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2