Agregar navegación y enrutamiento navigation-routing

Descargue el punto de partida para este tutorial mediante Git:

$ git clone git@github.com:adobe/aem-guides-wknd-spa.git
$ cd aem-guides-wknd-spa
$ git checkout Angular/navigation-routing-start

Implemente el código base en una instancia local de AEM mediante Maven:

$ mvn clean install -PautoInstallSinglePackage

Si usa AEM 6.x, agregue el perfil classic:

$ mvn clean install -PautoInstallSinglePackage -Pclassic

Instale el paquete terminado para el sitio de referencia WKND tradicional. Las imágenes proporcionadas por sitio de referencia WKND se reutilizarán en el SPA de WKND. El paquete se puede instalar usando Administrador de paquetes de AEM.

En el IDE de su elección, abra el proyecto de inicio de SPA para este capítulo.

Debajo del módulo ui.frontend, inspeccione el archivo header.component.ts en: ui.frontend/src/app/components/header/header.component.ts.

Se han realizado varias actualizaciones, incluida la adición de un HeaderEditConfig y un MapTo para permitir que el componente se asigne a un componente de AEM wknd-spa-angular/components/header.

/* header.component.ts */
...
const HeaderEditConfig = {
    ...
};

@Component({
selector: 'app-header',
templateUrl: './header.component.html',
styleUrls: ['./header.component.scss']
})
export class HeaderComponent implements OnInit {
@Input() items: object[];
    ...
}
...
MapTo('wknd-spa-angular/components/header')(withRouter(Header), HeaderEditConfig);

Observe la anotación @Input() para items. items contendrá una matriz de objetos de navegación pasados desde AEM.

En el módulo ui.apps, inspeccione la definición del componente del componente Header de AEM: ui.apps/src/main/content/jcr_root/apps/wknd-spa-angular/components/header/.content.xml:

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0"
    xmlns:jcr="http://www.jcp.org/jcr/1.0"
    jcr:primaryType="cq:Component"
    jcr:title="Header"
    sling:resourceSuperType="wknd-spa-angular/components/navigation"
    componentGroup="WKND SPA Angular - Structure"/>

El componente Header de AEM heredará toda la funcionalidad del componente principal de navegación a través de la propiedad sling:resourceSuperType.

Abra un explorador e inicie sesión en AEM, http://localhost:4502/. La base del código de inicio ya debería implementarse.

Vaya a la plantilla de página SPA: http://localhost:4502/editor.html/conf/wknd-spa-angular/settings/wcm/templates/spa-page-template/structure.html.

Seleccione el contenedor de diseño raíz más externo y haga clic en su icono directiva. Tenga cuidado no al seleccionar el contenedor de diseño desbloqueado para la creación.

Copie la directiva actual y cree una directiva nueva con el nombre Estructura de SPA:

En Componentes permitidos > General > seleccione el componente Contenedor de diseño.

En Componentes permitidos > WKND SPA ANGULAR - ESTRUCTURA > seleccione el componente Encabezado:

En Componentes permitidos > WKND SPA ANGULAR - Contenido > seleccione los componentes Imagen y Texto. Debe tener un total de 4 componentes seleccionados.

Haga clic en Listo para guardar los cambios.

Actualizar la página. Agregue el componente Header sobre el Contenedor de diseño desbloqueado:

Seleccione el componente Header y haga clic en su icono Policy para editar la directiva.

Cree una nueva directiva con un Título de directiva de "Encabezado de SPA de WKND".

En Propiedades:

• Establezca Raíz de navegación en /content/wknd-spa-angular/us/en.
• Establecer Excluir niveles de raíz en 1.
• Desmarque Recopilar todas las páginas secundarias.
• Establezca la profundidad de la estructura de navegación en 3.

Se recopilará la navegación 2 niveles por debajo de /content/wknd-spa-angular/us/en.

Después de guardar los cambios, debería ver los Header rellenados como parte de la plantilla:

Vaya a la consola de Sites: http://localhost:4502/sites.html/content/wknd-spa-angular/us/en/home. Seleccione la página de inicio de Angular de la SPA de WKND y haga clic en Crear > Página:

En Plantilla, seleccione Página de SPA. En Propiedades, escriba "Página 1" para Título y "Página-1" como nombre.

Haga clic en Crear y, en el cuadro de diálogo emergente, haga clic en Abrir para abrir la página en el Editor de SPA de AEM.

Agregue un nuevo componente Text al contenedor de diseño principal. Edite el componente e introduzca el texto: "Página 1" con el RTE y el elemento H1 (tendrá que ingresar al modo de pantalla completa para cambiar los elementos del párrafo)

No dude en añadir contenido adicional, como una imagen.

Vuelva a la consola de AEM Sites y repita los pasos anteriores, creando una segunda página denominada "Página 2" como elemento secundario de Página 1. Agregue contenido a Página 2 para que se pueda identificar fácilmente.

Por último, cree una tercera página, "Página 3", pero como elemento secundario de Página 2. Una vez completada, la jerarquía del sitio debe tener el siguiente aspecto:

En una pestaña nueva, abra la API del modelo JSON proporcionada por AEM: http://localhost:4502/content/wknd-spa-angular/us/en.model.json. Este contenido JSON se solicita cuando se carga la SPA por primera vez. La estructura exterior tiene el siguiente aspecto:

{
"language": "en",
"title": "en",
"templateName": "spa-app-template",
"designPath": "/libs/settings/wcm/designs/default",
"cssClassNames": "spa page basicpage",
":type": "wknd-spa-angular/components/spa",
":items": {},
":itemsOrder": [],
":hierarchyType": "page",
":path": "/content/wknd-spa-angular/us/en",
":children": {
    "/content/wknd-spa-angular/us/en/home": {},
    "/content/wknd-spa-angular/us/en/home/page-1": {},
    "/content/wknd-spa-angular/us/en/home/page-2": {},
    "/content/wknd-spa-angular/us/en/home/page-2/page-3": {}
    }
}

En :children debería ver una entrada para cada una de las páginas creadas. El contenido de todas las páginas se encuentra en esta solicitud JSON inicial. Una vez implementado el enrutamiento de navegación, las vistas posteriores de la SPA se cargan rápidamente, ya que el contenido ya está disponible en el lado del cliente.

No es aconsejable cargar ALL del contenido de una SPA en la solicitud JSON inicial, ya que esto ralentizaría la carga inicial de la página. A continuación, veamos cómo se recopila la profundidad de jerarquía de las páginas.

Vaya a la plantilla SPA Root en: http://localhost:4502/editor.html/conf/wknd-spa-angular/settings/wcm/templates/spa-app-template/structure.html.

Haga clic en el menú Propiedades de página > Directiva de página:

La plantilla SPA Root tiene una ficha Estructura jerárquica adicional para controlar el contenido JSON recopilado. La profundidad de la estructura determina la profundidad en la jerarquía del sitio para recopilar páginas secundarias debajo de la raíz. También puede usar el campo Patrones de estructura para filtrar páginas adicionales en función de una expresión regular.

Actualizar la profundidad de la estructura a "2":

Haga clic en Listo para guardar los cambios en la directiva.

Vuelva a abrir el modelo JSON http://localhost:4502/content/wknd-spa-angular/us/en.model.json.

{
"language": "en",
"title": "en",
"templateName": "spa-app-template",
"designPath": "/libs/settings/wcm/designs/default",
"cssClassNames": "spa page basicpage",
":type": "wknd-spa-angular/components/spa",
":items": {},
":itemsOrder": [],
":hierarchyType": "page",
":path": "/content/wknd-spa-angular/us/en",
":children": {
    "/content/wknd-spa-angular/us/en/home": {},
    "/content/wknd-spa-angular/us/en/home/page-1": {},
    "/content/wknd-spa-angular/us/en/home/page-2": {}
    }
}

Observe que la ruta de acceso Página 3 se ha eliminado: /content/wknd-spa-angular/us/en/home/page-2/page-3 del modelo JSON inicial.

Más adelante, observaremos cómo AEM SPA Editor SDK puede cargar dinámicamente contenido adicional.

Revise el JSON expuesto por el componente de AEM Header en http://localhost:4502/content/wknd-spa-angular/us/en.model.json:

...
"header": {
    "items": [
    {
    "level": 0,
    "active": true,
    "path": "/content/wknd-spa-angular/us/en/home",
    "description": null,
    "url": "/content/wknd-spa-angular/us/en/home.html",
    "lastModified": 1589062597083,
    "title": "WKND SPA Angular Home Page",
    "children": [
            {
            "children": [],
            "level": 1,
            "active": false,
            "path": "/content/wknd-spa-angular/us/en/home/page-1",
            "description": null,
            "url": "/content/wknd-spa-angular/us/en/home/page-1.html",
            "lastModified": 1589429385100,
            "title": "Page 1"
            },
            {
            "level": 1,
            "active": true,
            "path": "/content/wknd-spa-angular/us/en/home/page-2",
            "description": null,
            "url": "/content/wknd-spa-angular/us/en/home/page-2.html",
            "lastModified": 1589429603507,
            "title": "Page 2",
            "children": [
                {
                "children": [],
                "level": 2,
                "active": false,
                "path": "/content/wknd-spa-angular/us/en/home/page-2/page-3",
                "description": null,
                "url": "/content/wknd-spa-angular/us/en/home/page-2/page-3.html",
                "lastModified": 1589430413831,
                "title": "Page 3"
                }
            ],
            }
        ]
        }
    ],
":type": "wknd-spa-angular/components/header"

La naturaleza jerárquica de las páginas de AEM se modela en el JSON, que se puede utilizar para rellenar un menú de navegación. Recuerde que el componente Header hereda toda la funcionalidad del componente principal de navegación y que el contenido expuesto a través del JSON se asigna automáticamente a la anotación @Input de Angular.

Abra una nueva ventana de terminal y vaya a la carpeta ui.frontend del proyecto de SPA. Cree un nuevo(a) NavigationComponent mediante la herramienta CLI de Angular:

$ cd ui.frontend
$ ng generate component components/navigation
CREATE src/app/components/navigation/navigation.component.scss (0 bytes)
CREATE src/app/components/navigation/navigation.component.html (25 bytes)
CREATE src/app/components/navigation/navigation.component.spec.ts (656 bytes)
CREATE src/app/components/navigation/navigation.component.ts (286 bytes)
UPDATE src/app/app.module.ts (2032 bytes)

A continuación, cree una clase denominada NavigationLink utilizando la CLI de Angular en el directorio components/navigation recién creado:

$ cd src/app/components/navigation/
$ ng generate class NavigationLink
CREATE src/app/components/navigation/navigation-link.spec.ts (187 bytes)
CREATE src/app/components/navigation/navigation-link.ts (32 bytes)

Vuelva al IDE de su elección y abra el archivo en navigation-link.ts a las /src/app/components/navigation/navigation-link.ts.

Rellene navigation-link.ts con lo siguiente:

export class NavigationLink {

    title: string;
    path: string;
    url: string;
    level: number;
    children: NavigationLink[];
    active: boolean;

    constructor(data) {
        this.path = data.path;
        this.title = data.title;
        this.url = data.url;
        this.level = data.level;
        this.active = data.active;
        this.children = data.children.map( item => {
            return new NavigationLink(item);
        });
    }
}

Se trata de una clase simple que representa un vínculo de navegación individual. En el constructor de clase esperamos que data sea el objeto JSON pasado desde AEM. Esta clase se usa tanto en NavigationComponent como en HeaderComponent para rellenar fácilmente la estructura de exploración.

No se realiza ninguna transformación de datos, esta clase se crea principalmente para escribir de forma segura el modelo JSON. Observe que this.children tiene el tipo NavigationLink[] y que el constructor crea recursivamente nuevos objetos NavigationLink para cada uno de los elementos de la matriz children. Recuerde que el modelo JSON para Header es jerárquico.

Abra el archivo navigation-link.spec.ts. Este es el archivo de prueba para la clase NavigationLink. Actualícelo con lo siguiente:

import { NavigationLink } from './navigation-link';

describe('NavigationLink', () => {
    it('should create an instance', () => {
        const data = {
            children: [],
            level: 1,
            active: false,
            path: '/content/wknd-spa-angular/us/en/home/page-1',
            description: null,
            url: '/content/wknd-spa-angular/us/en/home/page-1.html',
            lastModified: 1589429385100,
            title: 'Page 1'
        };
        expect(new NavigationLink(data)).toBeTruthy();
    });
});

Observe que const data sigue el mismo modelo JSON inspeccionado anteriormente para un solo vínculo. No se trata de una prueba unitaria sólida; sin embargo, debería bastar con probar el constructor de NavigationLink.

Abra el archivo navigation.component.ts. Actualícelo con lo siguiente:

import { Component, OnInit, Input } from '@angular/core';
import { NavigationLink } from './navigation-link';

@Component({
selector: 'app-navigation',
templateUrl: './navigation.component.html',
styleUrls: ['./navigation.component.scss']
})
export class NavigationComponent implements OnInit {

    @Input() items: object[];

    constructor() { }

    get navigationLinks(): NavigationLink[] {

        if (this.items && this.items.length > 0) {
            return this.items.map(item => {
                return new NavigationLink(item);
            });
        }

        return null;
    }

    ngOnInit() {}

}

NavigationComponent espera un object[] denominado items que es el modelo JSON de AEM. Esta clase expone un único método get navigationLinks() que devuelve una matriz de NavigationLink objetos.

Abra el archivo navigation.component.html y actualícelo con lo siguiente:

<ul *ngIf="navigationLinks && navigationLinks.length > 0" class="navigation__group">
    <ng-container *ngTemplateOutlet="recursiveListTmpl; context:{ links: navigationLinks }"></ng-container>
</ul>

Esto genera un <ul> inicial y llama al método get navigationLinks() desde navigation.component.ts. Se utiliza un <ng-container> para realizar una llamada a una plantilla denominada recursiveListTmpl y se pasa el navigationLinks como una variable denominada links.

Agregar recursiveListTmpl siguiente:

<ng-template #recursiveListTmpl let-links="links">
    <li *ngFor="let link of links" class="{{'navigation__item navigation__item--' + link.level}}">
        <a [routerLink]="link.url" class="navigation__item-link" [title]="link.title" [attr.aria-current]="link.active">
            {{link.title}}
        </a>
        <ul *ngIf="link.children && link.children.length > 0">
            <ng-container *ngTemplateOutlet="recursiveListTmpl; context:{ links: link.children }"></ng-container>
        </ul>
    </li>
</ng-template>

Aquí se implementa el resto de la renderización del vínculo de navegación. Tenga en cuenta que la variable link es del tipo NavigationLink y que todos los métodos/propiedades creados por esa clase están disponibles. [routerLink] se usa en lugar del atributo href normal. Esto nos permite vincular a rutas específicas en la aplicación, sin una actualización de página completa.

La parte recursiva de la navegación también se implementa creando otro <ul> si el objeto link actual tiene una matriz children que no esté vacía.

Actualizar navigation.component.spec.ts para agregar compatibilidad con RouterTestingModule:

 ...
+ import { RouterTestingModule } from '@angular/router/testing';
 ...
 beforeEach(async(() => {
    TestBed.configureTestingModule({
+   imports: [ RouterTestingModule ],
    declarations: [ NavigationComponent ]
    })
    .compileComponents();
 }));
 ...

Se requiere agregar RouterTestingModule porque el componente usa [routerLink].

Actualice navigation.component.scss para agregar algunos estilos básicos a NavigationComponent:

Abra un terminal y vaya a la carpeta ui.frontend dentro del proyecto SPA. Inicie el servidor de desarrollo de Webpack:

$ npm start

Abra una ficha del explorador y vaya a http://localhost:4200/.

El servidor de desarrollo de Webpack debe configurarse para representar el modelo JSON desde una instancia local de AEM (ui.frontend/proxy.conf.json). Esto nos permite codificar directamente en el contenido creado en AEM anteriormente en el tutorial.

HeaderComponent tiene implementada actualmente la funcionalidad de alternancia de menús. A continuación, añada el componente de navegación.

Vuelva al IDE que desee y abra el archivo header.component.ts en ui.frontend/src/app/components/header/header.component.ts.

Actualice el método setHomePage() para quitar el objeto String codificado de forma rígida y utilice las props dinámicas pasadas por el componente AEM:

/* header.component.ts */
import { NavigationLink } from '../navigation/navigation-link';
...
 setHomePage() {
    if (this.hasNavigation) {
        const rootNavigationLink: NavigationLink = new NavigationLink(this.items[0]);
        this.isHome = rootNavigationLink.path === this.route.snapshot.data.path;
        this.homePageUrl = rootNavigationLink.url;
    }
}
...

Se crea una nueva instancia de NavigationLink basada en items[0], la raíz del modelo de navegación JSON pasado desde AEM. this.route.snapshot.data.path devuelve la ruta de acceso de la ruta de acceso de Angular actual. Este valor se usa para determinar si la ruta actual es la página principal. this.homePageUrl se usa para rellenar el vínculo de anclaje en el logotipo.

Abra header.component.html y reemplace el marcador de posición estático para la navegación con una referencia al NavigationComponent recién creado:

    <div class="header-navigation">
        <div class="navigation">
-            Navigation Placeholder
+           <app-navigation [items]="items"></app-navigation>
        </div>
    </div>

El atributo [items]=items pasa @Input() items de HeaderComponent a NavigationComponent, donde generará la navegación.

Abra header.component.spec.ts y agregue una declaración para NavigationComponent:

    /* header.component.spect.ts */
+   import { NavigationComponent } from '../navigation/navigation.component';

    describe('HeaderComponent', () => {
    let component: HeaderComponent;
    let fixture: ComponentFixture<HeaderComponent>;

    beforeEach(async(() => {
        TestBed.configureTestingModule({
        imports: [ RouterTestingModule ],
+       declarations: [ HeaderComponent, NavigationComponent ]
        })
        .compileComponents();
    }));

Dado que NavigationComponent se utiliza ahora como parte de HeaderComponent, debe declararse como parte del banco de pruebas.

Guardar cambios en cualquier archivo abierto y volver al servidor de desarrollo de Webpack: http://localhost:4200/

Abra la navegación haciendo clic en el botón de opción de menú y verá los vínculos de navegación rellenados. Debe poder navegar a diferentes vistas de la SPA.

En el IDE, abra el archivo app-routing.module.ts a las ui.frontend/src/app.

/* app-routing.module.ts */
import { AemPageDataResolver, AemPageRouteReuseStrategy } from '@adobe/cq-angular-editable-components';
import { NgModule } from '@angular/core';
import { RouteReuseStrategy, RouterModule, Routes, UrlMatchResult, UrlSegment } from '@angular/router';
import { PageComponent } from './components/page/page.component';

export function AemPageMatcher(url: UrlSegment[]): UrlMatchResult {
    if (url.length) {
        return {
            consumed: url,
            posParams: {
                path: url[url.length - 1]
            }
        };
    }
}

const routes: Routes = [
    {
        matcher: AemPageMatcher,
        component: PageComponent,
        resolve: {
            path: AemPageDataResolver
        }
    }
];
@NgModule({
    imports: [RouterModule.forRoot(routes)],
    exports: [RouterModule],
    providers: [
        AemPageDataResolver,
        {
        provide: RouteReuseStrategy,
        useClass: AemPageRouteReuseStrategy
        }
    ]
})
export class AppRoutingModule {}

La matriz routes: Routes = []; define las rutas o rutas de navegación a las asignaciones de componentes de Angular.

AemPageMatcher es un enrutador de Angular personalizado UrlMatcher, que coincide con cualquier elemento que "se parezca" a una página de AEM que forma parte de esta aplicación de Angular.

PageComponent es el componente de Angular que representa una página en AEM y que se utiliza para representar las rutas coincidentes. PageComponent se revisa más adelante en el tutorial.

AemPageDataResolver, proporcionado por AEM SPA Editor JS SDK, es un Angular Router Resolver personalizado que se usa para transformar la dirección URL de ruta, que es la ruta en AEM incluyendo la extensión .html, a la ruta de recurso en AEM, que es la ruta de página menos la extensión.

Por ejemplo, AemPageDataResolver transforma la dirección URL de una ruta de content/wknd-spa-angular/us/en/home.html en una ruta de acceso de /content/wknd-spa-angular/us/en/home. Se utiliza para resolver el contenido de la página en función de la ruta en la API del modelo JSON.

AemPageRouteReuseStrategy, proporcionado por AEM SPA Editor JS SDK, es una RouteReuseStrategy personalizada que evita la reutilización de PageComponent entre rutas. De lo contrario, el contenido de la página "A" podría mostrarse al navegar a la página "B".

Abra el archivo page.component.ts en ui.frontend/src/app/components/page/.

...
export class PageComponent {
    items;
    itemsOrder;
    path;

    constructor(
        private route: ActivatedRoute,
        private modelManagerService: ModelManagerService
    ) {
        this.modelManagerService
        .getData({ path: this.route.snapshot.data.path })
        .then(data => {
            this.path = data[Constants.PATH_PROP];
            this.items = data[Constants.ITEMS_PROP];
            this.itemsOrder = data[Constants.ITEMS_ORDER_PROP];
        });
    }
}

Se requiere PageComponent para procesar el JSON recuperado de AEM y se usa como componente de Angular para procesar las rutas.

ActivatedRoute, que proporciona el módulo Angular Router, contiene el estado que indica qué contenido JSON de la página de AEM debe cargarse en esta instancia de componente de página de Angular.

ModelManagerService, obtiene los datos JSON en función de la ruta y asigna los datos a las variables de clase path, items, itemsOrder. Estos se pasarán a AEMPageComponent

Abrir el archivo page.component.html en ui.frontend/src/app/components/page/

<aem-page
    class="structure-page"
    [attr.data-cq-page-path]="path"
    [cqPath]="path"
    [cqItems]="items"
    [cqItemsOrder]="itemsOrder">
</aem-page>

aem-page incluye AEMPageComponent. Las variables path, items y itemsOrder se pasan a AEMPageComponent. El AemPageComponent, proporcionado mediante el Editor de SPA de JavaScript SDK, iterará estos datos e instanciará dinámicamente componentes de Angular basados en los datos JSON, tal como se ve en el tutorial de componentes de mapa.

PageComponent es realmente solo un proxy para AEMPageComponent y es AEMPageComponent el que hace la mayor parte del trabajo pesado para asignar correctamente el modelo JSON a los componentes de Angular.

Abra un terminal y detenga webpack dev server si se inició. Vaya a la raíz del proyecto e implemente el proyecto en AEM con sus habilidades con Maven:

$ cd aem-guides-wknd-spa
$ mvn clean install -PautoInstallSinglePackage

Vaya a la página de inicio de SPA en AEM: http://localhost:4502/content/wknd-spa-angular/us/en/home.html y abra las herramientas para desarrolladores del explorador. Las capturas de pantalla a continuación se capturan desde el navegador Google Chrome.

Actualice la página y debería ver una solicitud XHR a /content/wknd-spa-angular/us/en.model.json, que es la raíz de la SPA. Tenga en cuenta que solo se incluyen tres páginas secundarias en función de la configuración de profundidad de jerarquía en la plantilla raíz de SPA realizada anteriormente en el tutorial. Esto no incluye Página 3.

Con las herramientas para desarrolladores abiertas, vaya a Página 3:

Observe que se hace una nueva solicitud XHR a: /content/wknd-spa-angular/us/en/home/page-2/page-3.model.json

El administrador de modelos de AEM comprende que el contenido JSON de la página 3 no está disponible y déclencheur automáticamente la solicitud XHR adicional.

Continúe navegando por la SPA utilizando los distintos vínculos de navegación. Observe que no se realizan solicitudes XHR adicionales y que no se actualiza la página completa. Esto hace que el SPA sea más rápido para el usuario final y reduce las solicitudes innecesarias a AEM.

Experimente con vínculos profundos directamente a: http://localhost:4502/content/wknd-spa-angular/us/en/home/page-2.html. Observe que el botón Atrás del explorador sigue funcionando.