SPA AEM快速入门- Angular

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

SPA创作功能优惠了在AEM内支持SPA的一个全面的解决方案。 本文介绍了Angular框架上简化的SPA应用程序,并解释了它是如何组合在一起的,使您能快速与自己的SPA一起运行。

NOTE

本文基于角框架。 有关React框架的相应文档,请参见SPA入门- React

NOTE

SPA编辑器是需要SPA框架的客户端渲染(例如,React或Angular)的项目的推荐解决方案。

简介

本文概括了简单的SPA的基本功能以及运行所需的最低要求。

有关SPA在AEM中的工作方式的详细信息,请参阅以下文档:

NOTE

要在SPA中创作内容,内容必须存储在AEM中并由内容模型公开。

如果SPA不遵守内容模型合同,则在AEM之外开发的将不可授权。

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

依赖关系、配置和构建

除了期望的角度依赖关系外,示例SPA还可以利用其他库来提高SPA创建的效率。

依赖关系

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上找到。

CAUTION

要求的aem-clientlib-generator的最低版本为1.4.1。

clientlib.config.js文件中配置aem-clientlib-generator,如下所示。

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"
            ]
        }
    }
};

正在生成

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

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

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

AEM 项目原型

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

应用程序结构

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

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

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

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引导应用程序。

静态实例化

当使用组件模板静态实例化组件时,必须将值从模型传递到组件的属性。 模型中的值作为属性传递,以后可作为组件属性使用。

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

通过处理页面,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

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

SPA AEM的核心思想是将SPA组件映射到AEM组件,并在内容被修改时更新组件(反之亦然)。 有关此通信模型的摘要,请参见文档SPA Editor概述

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

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

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

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

动态传递的属性

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

image.component.html

最后,可以在image.component.html中渲染图像。

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

在SPA组件之间共享信息

单页应用程序中的组件需要定期共享信息。 有几种推荐的方法可以这样做,其复杂程度按顺序增加如下所示。

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

后续步骤

有关创建自己的SPA的分步指南,请参阅AEM SPA编辑器入门- WKND事件教程

有关如何组织您自己开发SPA for AEM的详细信息,请参阅文章为AEM开发SPA

有关动态模型到组件映射以及它在AEM中的工作方式的更多详细信息,请参阅文章SPA的动态模型到组件映射

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

在此页面上