使用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中，並由內容模型公開。

若在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。

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指令將類似於：

"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表示法，並處理內容以包裝/裝飾頁面的每個元素。在SPA Blueprint檔案中可以找到Page的更多詳細資料。

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

單頁應用程式內的元件定期需要共用資訊。有幾種建議的方法可以達成此目的，依複雜度遞增的順序列示如下。

選項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讓您深入瞭解AEM適用的SPA SDK如何運作，以防您想要在AEM中針對React或Angular以外的架構實作SPA，或只是想深入瞭解。

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab