AEM SPA快速入门 — Angular getting-started-with-spas-in-aem-angular

单页应用程序 (SPA) 可以为网站用户提供引人入胜的良好体验。开发人员希望能够使用SPA框架构建站点，而作者则希望在AEM中无缝编辑使用SPA框架构建的站点的内容。

SPA创作功能提供了一个全面的解决方案，可在AEM中支持SPA。 本文介绍了Angular框架上的一个简化的SPA应用程序，并说明了它的组合方式，使您能够快速启动并运行自己的SPA。

简介 introduction

本文概述了简单SPA的基本功能以及运行运行所需了解的最低值。

有关SPA在AEM中工作方式的更多详细信息，请参阅以下文档：

本文档将介绍简化的SPA的结构并说明其工作方式，以便您能够将此理解应用于您自己的SPA。

依赖关系、配置和构建 dependencies-configuration-and-building

除了预期的Angular依赖关系之外，示例SPA还可以利用其他库来更高效地创建SPA。

依赖项 dependencies

的 package.json 文件定义了整个SPA包的要求。 此处列出了所需的最低AEM依赖项。

"dependencies": {
  "@adobe/aem-angular-editable-components": "~1.0.3",
  "@adobe/aem-spa-component-mapping": "~1.0.5",
  "@adobe/aem-spa-page-model-manager": "~1.0.3"
}

的 aem-clientlib-generator 可让客户端库的创建在生成过程中自动进行。

"aem-clientlib-generator": "^1.4.1",

有关该报表的更多详细信息，请参阅 在GitHub上，单击此处.

的 aem-clientlib-generator 在 clientlib.config.js 文件，如下所示。

module.exports = {
    // default working directory (can be changed per 'cwd' in every asset option)
    context: __dirname,

    // path to the clientlib root folder (output)
    clientLibRoot: "./../content/jcr_root/apps/my-angular-app/clientlibs",

    libs: {
        name: "my-angular-app",
        allowProxy: true,
        categories: ["my-angular-app"],
        embed: ["my-angular-app.responsivegrid"],
        jsProcessor: ["min:gcc"],
        serializationFormat: "xml",
        assets: {
            js: [
                "dist/**/*.js"
            ],
            css: [
                "dist/**/*.css"
            ]
        }
    }
};

正在生成 building

实际构建应用程序需要利用 Webpack ，以便除用于自动创建客户端库的aem-clientlib-generator之外进行转换。 因此，build命令将类似于：

"build": "ng build --build-optimizer=false && clientlib",

生成后，可将包上传到AEM实例。

AEM 项目原型 aem-project-archetype

任何 AEM 项目都应使用 AEM 项目原型，它支持使用 React 或 Angular 的 SPA 项目并利用 SPA SDK。

应用程序结构 application-structure

如前所述，包括依赖项和构建应用程序时，您将获得一个可上传到AEM实例的工作SPA包。

本文档的下一部分将介绍AEM中SPA的结构方式、驱动应用程序的重要文件以及它们如何协同工作。

以简化的图像组件为例，但应用程序的所有组件都基于相同的概念。

app.module.ts app-module-ts

进入SPA的入口点是 app.module.ts 此处显示的文件经过简化，可重点关注重要内容。

// app.module.ts
import { BrowserModule, BrowserTransferStateModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { SpaAngularEditableComponentsModule } from '@adobe/aem-angular-editable-components';
import { AppRoutingModule } from './app-routing.module';

@NgModule({
  imports: [ BrowserModule.withServerTransition({ appId: 'my-angular-app' }),
    SpaAngularEditableComponentsModule,
    AppRoutingModule,
    BrowserTransferStateModule ],
  providers: ...,
  declarations: [ ... ],
  entryComponents: [ ... ],
  bootstrap: [ AppComponent ]
})
export class AppModule {}

的 app.module.ts 文件是应用程序的起点，包含初始项目配置和使用 AppComponent 引导应用程序。

静态实例化 static-instantiation

使用组件模板静态实例化组件时，必须将值从模型传递到组件的属性。 模型中的值将作为属性传递，以便稍后作为组件属性提供。

app.component.ts app-component-ts

一次 app.module.ts 引导 AppComponent，则可以初始化应用程序，该应用程序将以简化版本显示在此处，以重点关注重要内容。

// app.component.ts
import { Component } from '@angular/core';
import { ModelManager } from '@adobe/aem-spa-page-model-manager';
import { Constants } from "@adobe/aem-angular-editable-components";

@Component({
  selector: 'app-root',
  template: `
    <router-outlet></router-outlet>
  `
})

export class AppComponent {
  items;
  itemsOrder;
  path;

  constructor() {
    ModelManager.initialize().then(this.updateData.bind(this));
  }

  private updateData(model) {
    this.path = model[Constants.PATH_PROP];
    this.items = model[Constants.ITEMS_PROP];
    this.itemsOrder = model[Constants.ITEMS_ORDER_PROP];
  }
}

main-content.component.ts main-content-component-ts

通过处理页面， app.component.ts 调用 main-content.component.ts 以简化版本列于此处。

import { Component } from '@angular/core';
import { ModelManagerService }     from '../model-manager.service';
import { ActivatedRoute } from '@angular/router';
import { Constants } from "@adobe/aem-angular-editable-components";

@Component({
  selector: 'app-main',
  template: `
    <aem-page class="structure-page" [attr.data-cq-page-path]="path" [cqPath]="path" [cqItems]="items" [cqItemsOrder]="itemsOrder" ></aem-page>
  `
})

export class MainContentComponent {
  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];
    });
  }
}

的 MainComponent 摄取页面模型的JSON表示形式并处理内容以包装/装饰页面的每个元素。 有关 Page 可以在文档中找到 SPA Blueprint.

image.component.ts image-component-ts

的 Page 由组件组成。 摄取JSON后， Page 可以处理这些组件，例如 image.component.ts 如此处所示。

/// image.component.ts
import { Component, Input } from '@angular/core';

const ImageEditConfig = {

    emptyLabel: 'Image',

    isEmpty: function(cqModel) {
        return !cqModel || !cqModel.src || cqModel.src.trim().length < 1;
    }
};

@Component({
  selector: 'app-image',
  templateUrl: './image.component.html',
})

export class ImageComponent {
  @Input() src: string;
  @Input() alt: string;
  @Input() title: string;
}

MapTo('my-angular-app/components/image')(ImageComponent, ImageEditConfig);

AEM中SPA的核心思想是将SPA组件映射到AEM组件，并在修改内容时更新组件（反之亦然）。 查看文档 SPA编辑器概述 以了解此通信模型的摘要。

MapTo('my-angular-app/components/image')(Image, ImageEditConfig);

的 MapTo 方法将SPA组件映射到AEM组件。 它支持使用单个字符串或字符串数组。

ImageEditConfig 是一个配置对象，通过为编辑器提供生成占位符所需的元数据来有助于启用组件的创作功能

如果没有内容，则将提供标签作为占位符来表示空内容。

动态传递的属性 dynamically-passed-properties

来自模型的数据将作为组件的属性动态传递。

image.component.html image-component-html

最后，图像可在 image.component.html.

// image.component.html
<img [src]="src" [alt]="alt" [title]="title"/>

在SPA组件之间共享信息 sharing-information-between-spa-components

单页应用程序中的组件需要定期共享信息。 有几种推荐的方法可以执行此操作，如下所示，它们的复杂性会越来越高。

后续步骤 next-steps

有关创建您自己的SPA的分步指南，请参阅 AEM SPA Editor - WKND事件入门教程.

有关如何组织自己开发SPA for AEM的更多信息，请参阅文章 开发SPA for AEM.

有关动态模型到组件映射以及它如何在AEM的SPA中工作的更多详细信息，请参阅文章 适用于SPA的动态模型到组件映射.

如果您希望在AEM中为除React或Angular之外的其他框架实施SPA，或者只想深入了解SPA SDK for AEM的工作方式，请参阅 SPA Blueprint 文章。