使用Angular在AEM中开始使用SPA getting-started-with-spas-in-aem-using-angular

Last update: Thu Aug 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
开发中

创建对象：

管理员
开发人员

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

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

NOTE

本文基于Angular框架。有关React框架的相应文档，请参阅AEM中的SPA快速入门 — React。

简介 introduction

本文总结了简单的SPA的基本功能以及运行它所需了解的最少信息。

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

NOTE

为了能够在SPA中创作内容，内容必须存储在AEM中并由内容模型公开。

如果不遵守内容模型合同，则在AEM之外开发的SPA将无法创作。

本文档将逐步介绍简化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。

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

实际构建应用程序时，除了使用aem-clientlib-generator自动创建客户端库之外，还使用Webpack进行转换。因此，构建命令将类似于：

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

构建后，可以将包上传到AEM实例。

AEM 项目原型 aem-project-archetype

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

应用程序结构 application-structure

如前所述，包括依赖项和构建应用程序将为您提供一个有效的SPA包，您可以将该包上传到您的AEM实例。

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

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

app.module.ts app-module-ts

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

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

单页应用程序中的组件经常需要共享信息。有几种推荐的方法可以做到这一点，按复杂性递增的顺序如下所示。

选项1： 将逻辑集中并广播到必需的组件，例如，通过使用util类作为纯面向对象解决方案。
选项2： 使用状态库（如NgRx）共享组件状态。
选项3： 通过自定义和扩展容器组件来利用对象层次结构。

后续步骤 next-steps

使用React在AEM中开始使用SPA显示了如何使用React在AEM中构建基本SPA以与SPA编辑器一起使用。
SPA 编辑器概述更深入地介绍了 AEM 和 SPA 之间的通信模型。
WKND SPA项目是在AEM中实施简单SPA项目的分步教程。
SPA的动态模型到组件映射说明了动态模型到组件映射以及它在AEM中的SPA中的工作方式。
SPA Blueprint让您深入了解SPA SDK for AEM的工作原理，以防您想在AEM中为React或Angular以外的框架实施SPA，或者只是想更深入地了解。

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab