AEM中的SPA快速入門 — Angular

單頁應用程式 (SPA) 可為網站使用者提供引人入勝的體驗。開發人員希望能使用SPA架構建立網站，而作者則想在AEM中順暢地編輯使用SPA架構建立之網站的內容。

SPA編寫功能提供全方位的解決方案，可支援AEM中的SPA。 本文介紹Angular架構上的簡化SPA應用程式，說明其如何整合，好讓您快速啟動並執行自己的SPA。

注意

本文章根據Angular架構。 如需React架構的對應檔案，請參閱 AEM中的SPA快速入門 — React.

注意

對於需要以SPA框架為基礎的使用者端轉譯(例如React或Angular)專案，建議使用SPA編輯器解決方案。

簡介

本文概述簡單的SPA的基本功能，以及您需要瞭解的最少運作資訊。

如需SPA在AEM中運作方式的詳細資訊，請參閱下列檔案：

注意

為了能夠在SPA內製作內容，內容必須儲存在AEM中，並由內容模型公開。

若在AEM外部開發的SPA未遵循內容模型合約，將無法編寫。

本檔案將逐步解說簡化SPA的結構，並說明其運作方式，以便您將這種瞭解套用至您自己的SPA。

相依性、設定和建置

除了預期的Angular相依性之外，範例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.

注意

的最低版本 aem-clientlib-generator 「必要」為1.4.1。

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

正在建置

實際建立應用程式 Webpack 用於整合，以及自動建立使用者端程式庫的aem-clientlib-generator。 因此， build指令將類似於：

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

建置後，封裝可以上傳到AEM執行個體。

AEM 專案原型

任何 AEM 專案都應利用 AEM 專案原型，它支援使用 React 或 Angular 的 SPA 專案並利用 SPA SDK。

應用程式結構

如前所述，包含相依性並建置您的應用程式後，您將會擁有可上傳至SPA執行個體的有效AEM套件。

本檔案的下一節將帶您瞭解AEM中SPA的結構、驅動應用程式的重要檔案，以及它們如何協同運作。

簡化的影像元件可作為範例，但應用程式的所有元件都根據相同的概念。

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

AEM中SPA的核心構想是將該SPA元件對應至AEM元件，並在修改內容時更新元件（反之亦然）。 檢視檔案 SPA編輯器概觀 以取得此通訊模式的摘要。

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事件教學課程.

如需有關如何組織自己以開發適用於AEM的SPA的詳細資訊，請參閱文章 為AEM開發SPA.

如需有關動態模型到元件對應的更多詳細資訊，以及它如何在AEM的SPA中運作，請參閱文章 SPA的動態模型至元件對應.

如果您想在AEM中為React或Angular以外的框架實作SPA，或只是想深入瞭解適用於AEM的SPA SDK的運作方式，請參閱 SPA Blueprint 文章。

本頁內容