添加导航和路由

Adobe Experience League

退出搜索

了解如何使用SPA页面和SPA Editor SDK支持AEM中的多个视图。动态导航是使用Angular路由实施的，并添加到现有的标题组件中。

目标

了解使用SPA编辑器时可用的SPA模型路由选项。
了解如何使用Angular路由在SPA的不同视图之间导航。
实施由AEM页面层次结构驱动的动态导航。

将构建的内容

本章将导航菜单添加到现有Header组件。导航菜单由AEM页面层次结构驱动，并使用导航核心组件提供的JSON模型。

已实施导航

前提条件

查看设置本地开发环境所需的工具和说明。

获取代码

通过Git下载本教程的起点：

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

使用Maven将代码库部署到本地AEM实例：

$ mvn clean install -PautoInstallSinglePackage

如果使用AEM 6.x添加classic配置文件：

$ mvn clean install -PautoInstallSinglePackage -Pclassic

为传统WKND引用站点安装完成的包。 WKND引用站点提供的图像将在WKND SPA上重新使用。可以使用AEM Package Manager安装包。

您始终可以在GitHub上查看完成的代码，或通过切换到分支Angular/navigation-routing-solution在本地签出代码。

Inspect HeaderComponent更新

在前几章中，将HeaderComponent组件添加为通过app.component.html包含的纯Angular组件。在本章中，将从应用程序中删除HeaderComponent组件，并将通过模板编辑器进行添加。这允许用户从AEM内配置HeaderComponent的导航菜单。

注意

已对代码库进行了多次CSS和JavaScript更新，以开始本章。为了重点关注核心概念，不讨论代码更改的所有。您可以在此处查看完整更改。

在您选择的IDE中，打开本章的SPA起始项目。

在ui.frontend模块下方，检查文件header.component.ts:ui.frontend/src/app/components/header/header.component.ts。

已进行多项更新，包括添加HeaderEditConfig和MapTo，以便将组件映射到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);

请注意items的@Input()注释。 items 将包含从AEM传入的导航对象数组。

在ui.apps模块中，检查AEM Header组件的组件定义：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"/>

AEM Header组件将通过sling:resourceSuperType属性继承导航核心组件的所有功能。

将HeaderComponent添加到SPA模板

打开浏览器并登录AEM, http://localhost:4502/。应该已部署起始代码库。
导航到SPA页面模板:http://localhost:4502/editor.html/conf/wknd-spa-angular/settings/wcm/templates/spa-page-template/structure.html。
选择最外部的根布局容器并单击其策略图标。要小心不要选择布局容器未锁定进行创作。
复制当前策略并创建名为SPA Structure的新策略：

在允许的组件 > 常规 >下，选择布局容器组件。

在允许的组件 > WKND SPAANGULAR- STRUCTURE下，选择标头组件：

在允许的组件 > WKND SPAANGULAR — 内容 >下，选择图像和文本组件。您应选择总共4个组件。

单击完成以保存更改。
刷新页面。在未锁定的布局容器上方添加标题组件：
选择标头组件并单击其策略图标以编辑策略。
使用策略标题的"WKND SPA标头"创建新策略。

在Properties下：
- 将导航根设置为/content/wknd-spa-angular/us/en。
- 将排除根级别设置为1。
- 取消选中收集所有子页面。
- 将导航结构深度设置为3。
这将收集/content/wknd-spa-angular/us/en下方深处的导航2级。
保存更改后，您应会看到填充的Header作为模板的一部分：

创建子页面

接下来，在AEM中创建其他页面，以用作SPA中的不同视图。我们还将检查AEM提供的JSON模型的层次结构。

导航到Sites控制台：http://localhost:4502/sites.html/content/wknd-spa-angular/us/en/home。选择WKND SPAAngular主页并单击创建 > 页面:
在Template下，选择SPA Page。在Properties下，输入Title的"Page 1"和"page-1"作为名称。

单击创建，然后在对话框弹出窗口中，单击打开以在AEM SPA编辑器中打开该页面。
向主布局容器添加新的Text组件。编辑组件并输入文本："Page 1"使用RTE和H1元素（必须进入全屏模式才能更改段落元素）

请随时添加其他内容，如图像。
返回到AEM Sites控制台并重复上述步骤，创建名为"Page 2"的第二个页面作为Page 1的同级页面。向Page 2添加内容，以便轻松识别内容。
最后，创建第三个页面，"Page 3"，但作为Page 2的子。完成网站层次结构后，应如下所示：
在新选项卡中，打开由AEM提供的JSON模型API:http://localhost:4502/content/wknd-spa-angular/us/en.model.json。首次加载SPA时，将请求此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": {},
    "/content/wknd-spa-angular/us/en/home/page-2/page-3": {}
    }
}
```
在:children下，您应会看到每个已创建页面的条目。所有页面的内容都位于此初始JSON请求中。一旦实施导航路由，将快速加载SPA的后续视图，因为内容已在客户端可用。

在初始JSON请求中加载SPA内容的ALL并不明智，因为这会减缓初始页面加载速度。接下来，我们将看一看页面的层级深度是如何收集的。
导航到SPA根模板：http://localhost:4502/editor.html/conf/wknd-spa-angular/settings/wcm/templates/spa-app-template/structure.html。

单击页面属性菜单 > 页面策略:
SPA根模板具有额外的分层结构选项卡，用于控制收集的JSON内容。 结构深度确定在站点层次结构中收集根下子页面的深度。您还可以使用结构模式字段根据正则表达式过滤掉其他页面。

将结构深度更新为"2":

单击完成以保存对策略所做的更改。

重新打开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": {}
    }
}

请注意，Page 3路径已被删除：/content/wknd-spa-angular/us/en/home/page-2/page-3。

稍后，我们将观察AEM SPA Editor SDK如何动态加载其他内容。

实施导航

接下来，使用新的NavigationComponent实施导航菜单。我们可以直接在header.component.html中添加代码，但最好的做法是避免出现较大的组件。相反，应实施一个NavigationComponent，该稍后可能会重新使用。

查看位于http://localhost:4502/content/wknd-spa-angular/us/en.model.json的AEM Header组件公开的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"

AEM页面的层次结构是使用JSON建模的，可用于填充导航菜单。请记住，Header组件继承了导航核心组件的所有功能，通过JSON公开的内容将自动映射到Angular@Input注释。

打开新的终端窗口，然后导航到SPA项目的ui.frontend文件夹。使用AngularCLI工具创建新的NavigationComponent:

$ 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)

接下来，使用新创建的components/navigation目录中的AngularCLI创建名为NavigationLink的类：

$ 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)

返回到您选择的IDE，然后在navigation-link.ts的/src/app/components/navigation/navigation-link.ts处打开文件。
使用以下内容填充navigation-link.ts :
```
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);
        });
    }
}
```
这是一个用于表示单个导航链接的简单类。在类构造函数中，我们希望data是从AEM传入的JSON对象。该类将在NavigationComponent和HeaderComponent中使用，以轻松填充导航结构。

不执行任何数据转换，此类主要用于强烈键入JSON模型。请注意，this.children键入为NavigationLink[]，且构造函数会递归地为children数组中的每个项目创建新的NavigationLink对象。请记住，Header的JSON模型是分层的。

打开文件navigation-link.spec.ts。这是NavigationLink类的测试文件。使用以下内容更新它：

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();
    });
});

请注意， const data遵循之前针对单个链接检查的相同JSON模型。这远非一个可靠的单元测试，但应该足以测试NavigationLink的构造函数。

打开文件navigation.component.ts。使用以下内容更新它：

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 应为 object[] AEM items 中的JSON模型的名称。此类会公开一个方法get navigationLinks()，该方法会返回NavigationLink对象的数组。

打开文件navigation.component.html，然后使用以下内容更新它：

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

这会生成一个初始的<ul>，并从navigation.component.ts调用get navigationLinks()方法。 <ng-container>用于调用名为recursiveListTmpl的模板，并将navigationLinks作为名为links的变量传递。

添加recursiveListTmpl下一个：

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

此处实现了导航链接的其余渲染。请注意，变量link的类型为NavigationLink，并且该类创建的所有方法/属性都可用。 [routerLink] 而不是常规属 href 性。这样，我们便无需刷新整页，即可链接到应用程序中的特定路由。

如果当前link具有非空children数组，则还通过创建另一个<ul>来实现导航的递归部分。

更新navigation.component.spec.ts以添加对RouterTestingModule的支持：

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

需要添加RouterTestingModule，因为组件使用[routerLink]。

更新navigation.component.scss以向NavigationComponent添加一些基本样式：

@import "~src/styles/variables";

$link-color: $black;
$link-hover-color: $white;
$link-background: $black;

:host-context {
    display: block;
    width: 100%;
}

.navigation__item {
    list-style: none;
}

.navigation__item-link {
    color: $link-color;
    font-size: $font-size-large;
    text-transform: uppercase;
    padding: $gutter-padding;
    display: flex;
    border-bottom: 1px solid $gray;

    &:hover {
        background: $link-background;
        color: $link-hover-color;
    }

}

更新标头组件

现在，NavigationComponent已实施，必须更新HeaderComponent才能引用它。

打开终端，然后导航到SPA项目中的ui.frontend文件夹。启动Webpack开发服务器:
```
$ npm start
```
打开浏览器选项卡，然后导航到http://localhost:4200/。

应将webpack dev server配置为从AEM的本地实例(ui.frontend/proxy.conf.json)代理JSON模型。这将允许我们从教程前面的部分直接针对在AEM中创建的内容进行代码。

HeaderComponent当前已实施菜单切换功能。接下来，添加导航组件。
返回到您选择的IDE，然后在ui.frontend/src/app/components/header/header.component.ts打开文件header.component.ts。

更新setHomePage()方法以删除硬编码字符串，并使用AEM组件传入的动态prop:

/* 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;
    }
}
...

基于从AEM传入的导航JSON模型的根items[0]创建NavigationLink的新实例。 this.route.snapshot.data.path 返回当前Angular路由的路径。此值用于确定当前路由是否为Home Page。 this.homePageUrl 用于填充徽标上的锚点链接。

打开header.component.html并将导航的静态占位符替换为对新创建的NavigationComponent的引用：
```
    <div class="header-navigation">
        <div class="navigation">
-            Navigation Placeholder
+           <app-navigation [items]="items"></app-navigation>
        </div>
    </div>
```
[items]=items 属性将从 @Input() items 传递到 HeaderComponent 其构 NavigationComponent 建导航的位置。

打开header.component.spec.ts并添加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();
    }));

由于NavigationComponent现在用作HeaderComponent的一部分，因此需要将其声明为测试台的一部分。

保存对任何打开的文件所做的更改并返回到Webpack开发服务器:http://localhost:4200/

单击菜单切换打开导航，此时您应会看到填充的导航链接。您应该能够导航到SPA的不同视图。

了解SPA路由

现在，导航已实施，请在AEM中检查路由。

在IDE中，在ui.frontend/src/app处打开文件app-routing.module.ts。
```
/* 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 {}
```
routes: Routes = [];数组定义到Angular组件映射的路由或导航路径。

AemPageMatcher 是自定义Angular路由器UrlMatcher，与AEM中属于此Angular应用程序一部分的任何“看起来”页面相匹配。

PageComponent 是AEM中表示页面的Angular组件，将调用匹配的路由。将进一步检查PageComponent。

AemPageDataResolver由AEM SPA Editor JS SDK提供的是一个自定义的 Angular路由器解析器，用于将路由URL(AEM中的路径，包括.html扩展)转换为AEM中的资源路径（页面路径，除以扩展名）。

例如，AemPageDataResolver会将路由的URL content/wknd-spa-angular/us/en/home.html转换为路径/content/wknd-spa-angular/us/en/home。用于根据JSON模型API中的路径解析页面内容。

AemPageRouteReuseStrategy由AEM SPA Editor JS SDK提供的是一个自定义的RouteReuseStrategy， 🔗 可阻止跨路由重 PageComponent 复使用。否则，页面“A”中的内容可能会在导航到页面“B”时显示。

在ui.frontend/src/app/components/page/处打开文件page.component.ts。

...
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];
        });
    }
}

需要PageComponent才能处理从AEM中检索到的JSON，并用作呈现路由的Angular组件。

ActivatedRoute，由Angular路由器模块提供，包含状态，指示应将哪个AEM页面的JSON内容加载到此Angular页组件实例中。

ModelManagerService，根据路由获取JSON数据，并将该数据映射到类变 path量 items、 itemsOrder。然后，这些值将传递到AEMPageComponent

在ui.frontend/src/app/components/page/处打开文件page.component.html
```
<aem-page 
    class="structure-page" 
    [attr.data-cq-page-path]="path" 
    [cqPath]="path" 
    [cqItems]="items" 
    [cqItemsOrder]="itemsOrder">
</aem-page>
```
aem-page 包括 AEMPageComponent。变量path、items和itemsOrder将传递到AEMPageComponent。然后，通过SPA编辑器JavaScript SDK提供的AemPageComponent将遍历此数据，并根据映射组件教程中所示的JSON数据动态实例化Angular组件。

PageComponent实际上只是AEMPageComponent的代理，它是执行大部分重力提升的AEMPageComponent代理，用于将JSON模型正确映射到Angular组件。

Inspect AEM中的SPA路由

打开终端并停止Webpack开发服务器（如果启动）。导航到项目的根，然后使用您的Maven技能将项目部署到AEM:
```
$ cd aem-guides-wknd-spa
$ mvn clean install -PautoInstallSinglePackage
```
注意

angular项目启用了一些非常严格的链接规则。如果Maven生成失败，请检查错误并查找在列出的文件中找到的Lint错误。. 修复了linter发现的任何问题，并重新运行Maven命令。
导航到AEM中的SPA主页：http://localhost:4502/content/wknd-spa-angular/us/en/home.html并打开浏览器的开发人员工具。下面的屏幕截图是从Google Chrome浏览器中捕获的。

刷新页面后，您应会看到对/content/wknd-spa-angular/us/en.model.json(SPA根)的XHR请求。请注意，根据本教程前面对SPA根模板进行的层次结构深度配置，只包含三个子页面。这不包括第3页。
打开开发人员工具后，导航到第3页：

请注意，新的XHR请求已发布到：/content/wknd-spa-angular/us/en/home/page-2/page-3.model.json

AEM模型管理器了解第3页JSON内容不可用，并自动触发其他XHR请求。
继续使用各种导航链接导航SPA。请注意，未发出任何其他XHR请求，并且未发生完整的页面刷新。这样，最终用户就可以快速获得SPA，并减少不必要的返回AEM请求。
通过直接导航到以下位置来体验深层链接：http://localhost:4502/content/wknd-spa-angular/us/en/home/page-2.html。请注意，浏览器的“返回”按钮可继续工作。

恭喜！

恭喜，您了解了如何通过SPA Editor SDK将SPA中的多个视图映射到AEM页面来支持这些视图。动态导航已使用Angular路由实现并添加到Header组件中。

您始终可以在GitHub上查看完成的代码，或通过切换到分支Angular/navigation-routing-solution在本地签出代码。

后续步骤

创建自定义组件 — 了解如何创建要与AEM SPA编辑器一起使用的自定义组件。了解如何开发创作对话框和Sling模型以扩展JSON模型以填充自定义组件。

全新改良搜索功能

目标

将构建的内容

前提条件

获取代码

Inspect HeaderComponent更新

将HeaderComponent添加到SPA模板

创建子页面

实施导航

更新标头组件

了解SPA路由

Inspect AEM中的SPA路由

恭喜！

后续步骤

adobe.com 上的资源

在此页面上

查看下一个：

学习

文档

社区

技术支持

资源

Adobe 帐户

Adobe