整合SPA

了解以Angular撰寫的單頁應用程式(SPA)原始碼如何與Adobe Experience Manager(AEM)專案整合。了解如何使用現代化的前端工具（例如WebPack開發伺服器），針對AEM JSON模型API快速開發SPA。

目標

了解SPA專案如何與AEM與用戶端程式庫整合。
了解如何使用本機開發伺服器進行專屬的前端開發。
探索代理靜態模擬針對AEM JSON模型API進行開發的檔案

您將建置的

本章將添加一個簡單 Header 元件至SPA。在構建此靜態 Header 元件採用數種AEM SPA開發方法。

AEM中的新標題

擴充SPA以新增靜態 Header 元件

必備條件

檢閱設定本地開發環境.

取得程式碼

透過Git下載本教學課程的起始點：

$ git clone git@github.com:adobe/aem-guides-wknd-spa.git
$ cd aem-guides-wknd-spa
$ git checkout Angular/integrate-spa-start

使用Maven將程式碼基底部署至本機AEM例項：

$ mvn clean install -PautoInstallSinglePackage

若使用 AEM 6.x 新增 classic 設定檔：

$ mvn clean install -PautoInstallSinglePackage -Pclassic

您一律可以在上檢視完成的程式碼 GitHub 或切換到分支，本地檢出代碼 Angular/integrate-spa-solution.

整合方法

已在AEM專案中建立兩個模組： ui.apps 和 ui.frontend.

此 ui.frontend 模組是 webpack 包含所有SPA原始碼的專案。大部分的SPA開發和測試都是在Webpack專案中完成。觸發生產組建時，會使用webpack建置及編譯SPA。編譯的成品（CSS和Javascript）會複製到 ui.apps 模組，然後部署至AEM執行階段。

ui.frontend高階架構

對SPA整合的高階描述。

有關前端版本編號的其他資訊可以是此處找到.

Inspect SPA整合

接下來，檢查 ui.frontend 模組，了解由 AEM專案原型.

在您選擇的IDE中，開啟WKND SPA的AEM專案。本教學課程將使用 Visual Studio代碼IDE.
展開並檢查 ui.frontend 檔案夾。開啟檔案 ui.frontend/package.json

在 dependencies 您應會看到數個與 @angular:

"@angular/animations": "~9.1.11",
"@angular/common": "~9.1.11",
"@angular/compiler": "~9.1.11",
"@angular/core": "~9.1.11",
"@angular/forms": "~9.1.10",
"@angular/platform-browser": "~9.1.10",
"@angular/platform-browser-dynamic": "~9.1.10",
"@angular/router": "~9.1.10",

此 ui.frontend 模組是 Angular應用程式產生方式：使用 AngularCLI工具包括路由。

還有三個相依性會加上前置詞 @adobe:

"@adobe/cq-angular-editable-components": "^2.0.2",
"@adobe/cq-spa-component-mapping": "^1.0.3",
"@adobe/cq-spa-page-model-manager": "^1.1.3",

上述模組構成 AEM SPA Editor JS SDK 並提供功能，以便將SPA元件對應至AEM元件。

在 package.json 檔案數 scripts 定義：
```
"scripts": {
    "start": "ng serve --open --proxy-config ./proxy.conf.json",
    "build": "ng lint && ng build && clientlib",
    "build:production": "ng lint && ng build --prod && clientlib",
    "test": "ng test",
    "sync": "aemsync -d -w ../ui.apps/src/main/content"
}
```
這些指令碼是以通用 AngularCLI命令但已稍作修改，以搭配較大的AEM專案使用。

start — 使用本機Web伺服器在本機執行Angular應用程式。已更新，以代理本機AEM例項的內容。

build — 編譯Angular應用程式以進行生產發佈。此 && clientlib 負責將編譯的SPA複製至 ui.apps 模組做為建置期間的用戶端程式庫。 npm模組 aem-clientlib-generator 可方便執行。

有關可用指令碼的更多詳細資訊，請參見此處.
Inspect檔案 ui.frontend/clientlib.config.js. 此配置檔案由 aem-clientlib-generator 以決定如何產生用戶端程式庫。
Inspect檔案 ui.frontend/pom.xml. 此檔案會轉換 ui.frontend 資料夾 Maven模組. 此 pom.xml 檔案已更新，以使用 frontend-maven-plugin to 測試和建置 SPA。

Inspect檔案 app.component.ts at ui.frontend/src/app/app.component.ts:

import { Constants } from '@adobe/cq-angular-editable-components';
import { ModelManager } from '@adobe/cq-spa-page-model-manager';
import { Component } from '@angular/core';

@Component({
selector: '#spa-root', // tslint:disable-line
styleUrls: ['./app.component.css'],
templateUrl: './app.component.html'
})
export class AppComponent {
    ...

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

    private updateData = pageModel => {
        this.path = pageModel[Constants.PATH_PROP];
        this.items = pageModel[Constants.ITEMS_PROP];
        this.itemsOrder = pageModel[Constants.ITEMS_ORDER_PROP];
    }
}

app.component.js 是SPA的入口。 ModelManager 由AEM SPA Editor JS SDK提供。它負責呼叫和注入 pageModel （JSON內容）放入應用程式中。

新增標題元件

接著，將新元件新增至SPA，並將變更部署至本機AEM例項以查看整合。

開啟新的終端機視窗，並導覽至 ui.frontend 資料夾：
```
$ cd aem-guides-wknd-spa/ui.frontend
```
安裝 AngularCLI 全域而言，這可用來產生Angular元件，以及透過建置和提供Angular應用程式 ng 命令。
```
$ npm install -g @angular/cli
```
注意

版本 @angular/cli 由本項目使用 9.1.7. 建議保持AngularCLI版本同步。

建立新 Header 元件，方法是運行AngularCLI ng generate component 命令 ui.frontend 檔案夾。

$ ng generate component components/header

CREATE src/app/components/header/header.component.css (0 bytes)
CREATE src/app/components/header/header.component.html (21 bytes)
CREATE src/app/components/header/header.component.spec.ts (628 bytes)
CREATE src/app/components/header/header.component.ts (269 bytes)
UPDATE src/app/app.module.ts (1809 bytes)

這將為新Angular頭元件建立骨架，位於 ui.frontend/src/app/components/header.

開啟 aem-guides-wknd-spa 專案。導覽至 ui.frontend/src/app/components/header 檔案夾。
開啟檔案 header.component.html 並將內容替換為：
```

<header className="header">
    <div className="header-container">
        <h1>WKND</h1>
    </div>
</header>
```
請注意，這會顯示靜態內容，因此此Angular元件不需要對預設產生的任何調整 header.component.ts.
開啟檔案 app.component.html at ui.frontend/src/app/app.component.html. 新增 app-header:
```
<app-header></app-header>
<router-outlet></router-outlet>
```
這包括 header 元件。

開啟新終端機並導覽至 ui.frontend 資料夾和執行 npm run build 命令：

$ cd ui.frontend
$ npm run build

Linting "angular-app"...
All files pass linting.
Generating ES5 bundles for differential loading...
ES5 bundle generation complete.

導覽至 ui.apps 檔案夾。下方 ui.apps/src/main/content/jcr_root/apps/wknd-spa-angular/clientlibs/clientlib-angular 您應該會看到已編譯的SPA檔案已從ui.frontend/build 檔案夾。

返回終端並導覽至 ui.apps 檔案夾。執行以下Maven命令：

$ cd ../ui.apps
$ mvn clean install -PautoInstallPackage
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  9.629 s
[INFO] Finished at: 2020-05-04T17:48:07-07:00
[INFO] ------------------------------------------------------------------------

這會部署 ui.apps 套件至本機執行中的AEM例項。

開啟瀏覽器標籤並導覽至 http://localhost:4502/editor.html/content/wknd-spa-angular/us/en/home.html. 您現在應該會看到 Header 元件。

初始標題實作

步驟 7-9 會在從專案的根觸發Maven組建時自動執行(例如 mvn clean install -PautoInstallSinglePackage)。您現在應了解SPA和AEM用戶端程式庫之間整合的基本知識。請注意，您仍可以編輯和新增 Text 元件，但AEM Header 元件不可編輯。

Webpack開發伺服器 — 代理JSON API

如先前的練習所示，執行組建，並將用戶端程式庫同步至AEM的本機例項需要幾分鐘的時間。這是最終測試可接受的選項，但不適用於大部分SPA開發。

A webpack開發伺服器可用來快速開發SPA。 SPA是由AEM產生的JSON模型驅動。在本練習中，來自執行中AEM例項的JSON內容為代理到由 Angular專案.

返回到IDE並開啟檔案 proxy.conf.json at ui.frontend/proxy.conf.json.

[
    {
        "context": [
                    "/content/**/*.(jpg|jpeg|png|model.json)",
                    "/etc.clientlibs/**/*"
                ],
        "target": "http://localhost:4502",
        "auth": "admin:admin",
        "logLevel": "debug"
    }
]

此 Angular應用程式提供簡單的代理API請求機制。在 context 被強制 localhost:4502，即本機AEM快速入門。

開啟檔案 index.html at ui.frontend/src/index.html. 這是開發伺服器使用的根HTML檔案。

請注意，有 base href="/". 此基本標籤是應用程式解析相對URL的關鍵。
```
<base href="/">
```

開啟終端機視窗並導覽至 ui.frontend 檔案夾。運行命令 npm start:

$ cd ui.frontend
$ npm start

> wknd-spa-angular@0.1.0 start /Users/dgordon/Documents/code/aem-guides-wknd-spa/ui.frontend
> ng serve --open --proxy-config ./proxy.conf.json

10% building 3/3 modules 0 active[HPM] Proxy created: [ '/content/**/*.(jpg|jpeg|png|model.json)', '/etc.clientlibs/**/*' ]  ->  http://localhost:4502
[HPM] Subscribed to http-proxy events:  [ 'error', 'close' ]
ℹ ｢wds｣: Project is running at http://localhost:4200/webpack-dev-server/
ℹ ｢wds｣: webpack output is served from /
ℹ ｢wds｣: 404s will fallback to //index.html

開啟新的瀏覽器標籤（如果尚未開啟）並導覽至 http://localhost:4200/content/wknd-spa-angular/us/en/home.html.

您應該會看到與AEM相同的內容，但未啟用任何製作功能。
返回到IDE並建立名為 img at ui.frontend/src/assets.
下載下列WKND標誌並加入 img 資料夾：

開啟 header.component.html at ui.frontend/src/app/components/header/header.component.html 並加入標誌：

<header class="header">
    <div class="header-container">
        <div class="logo">
            <img class="logo-img" src="assets/img/wknd-logo-dk.png" alt="WKND SPA" />
        </div>
    </div>
</header>

將變更儲存至 header.component.html.

返回瀏覽器。您應會立即看到應用程式的變更反映在內。

您可以繼續在 AEM 看到它們在 webpack開發伺服器，因為我們代理內容。請注意，內容變更只會顯示在 webpack開發伺服器.
使用停止本地Web伺服器 ctrl+c 在終端機。

Webpack開發伺服器 — 模擬JSON API

另一種快速開發的方法是使用靜態JSON檔案作為JSON模型。借由「模擬」JSON，我們移除了對本機AEM例項的相依性。此外，前端開發人員也能更新JSON模型，以測試功能，並推動對JSON API的變更，JSON API稍後將由後端開發人員實作。

模擬JSON的初始設定可 需要本機AEM例項.

在瀏覽器中導覽至 http://localhost:4502/content/wknd-spa-angular/us/en.model.json.

這是由AEM匯出的JSON，此JSON會驅動應用程式。複製JSON輸出。
返回到IDE導航到 ui.frontend/src 添加名為吊床和 json 匹配以下資料夾結構：
```
|-- ui.frontend
    |-- src
        |-- mocks
            |-- json
```
建立名為 en.model.json 在 ui.frontend/public/mocks/json. 從貼上JSON輸出 步驟1 這裡。

建立新檔案 proxy.mock.conf.json 在 ui.frontend. 將下列項目填入檔案：

[
    {
    "context": [
        "/content/**/*.model.json"
    ],
    "pathRewrite": { "^/content/wknd-spa-angular/us" : "/mocks/json"} ,
    "target": "http://localhost:4200",
    "logLevel": "debug"
    }
]

此代理配置將重寫以開頭的請求 /content/wknd-spa-angular/us with /mocks/json 和提供對應的靜態JSON檔案，例如：

/content/wknd-spa-angular/us/en.model.json -> /mocks/json/en.model.json

開啟檔案 angular.json. 新增 dev 使用更新的設定資產要參考的陣列吊床資料夾。

 "dev": {
          "assets": [
            "src/mocks",
            "src/assets",
            "src/favicon.ico",
            "src/logo192.png",
            "src/logo512.png",
            "src/manifest.json"
          ]
    },

AngularJSON開發資產更新資料夾

建立專用 dev 設定可確保吊床資料夾僅在開發期間使用，且從未部署至生產組建中的AEM。

在 angular.json 檔案，下次更新 browserTarget 使用新 dev 配置：

  ...
  "serve": {
      "builder": "@angular-devkit/build-angular:dev-server",
      "options": {
+       "browserTarget": "angular-app:build:dev"
-       "browserTarget": "angular-app:build"
      },
  ...

AngularJSON建置開發更新

開啟檔案 ui.frontend/package.json 並新增 start:mock 命令以引用 proxy.mock.conf.json 檔案。

    "scripts": {
        "start": "ng serve --open --proxy-config ./proxy.conf.json",
+       "start:mock": "ng serve --open --proxy-config ./proxy.mock.conf.json",
        "build": "ng lint && ng build && clientlib",
        "build:production": "ng lint && ng build --prod && clientlib",
        "test": "ng test",
        "sync": "aemsync -d -w ../ui.apps/src/main/content"
    }

新增命令可讓您輕鬆在代理設定之間切換。

如果目前執行中，請停止 webpack開發伺服器. 啟動 webpack開發伺服器 使用 start:mock 指令碼：
```
$ npm run start:mock

> wknd-spa-angular@0.1.0 start:mock /Users/dgordon/Documents/code/aem-guides-wknd-spa/ui.frontend
> ng serve --open --proxy-config ./proxy.mock.conf.json
```
導覽至 http://localhost:4200/content/wknd-spa-angular/us/en/home.html 而您應該會看到相同的SPA，但系統現在會從模擬 JSON檔案。
對 en.model.json 檔案。更新的內容應立即反映在 webpack開發伺服器.

能夠操控JSON模型並查看即時SPA上的效果，可協助開發人員了解JSON模型API。它還允許前端和後端開發並行進行。

使用Sass新增樣式

接著，專案會新增一些已更新的樣式。此專案將新增薩斯支援變數等一些實用功能。

開啟終端窗口並停止 webpack開發伺服器 中。從內部 ui.frontend 資料夾輸入以下命令以更新要處理的Angular應用程式 .scs 檔案。
```
$ cd ui.frontend
$ ng config schematics.@schematics/angular:component.styleext scss
```
這會更新 angular.json 檔案底部有新條目：
```
"schematics": {
    "@schematics/angular:component": {
    "styleext": "scss"
    }
}
```
安裝 normalize-scss 若要跨瀏覽器標準化樣式：
```
$ npm install normalize-scss --save
```
返回到IDE和下面 ui.frontend/src 建立名為 styles.

在下方建立新檔案 ui.frontend/src/styles 已命名 _variables.scss 並填入下列變數：

//_variables.scss

//== Colors
//
//## Gray and brand colors for use across theme.

$black:                  #202020;
$gray:                   #696969;
$gray-light:             #EBEBEB;
$gray-lighter:           #F7F7F7;
$white:                  #FFFFFF;
$yellow:                 #FFEA00;
$blue:                   #0045FF;


//== Typography
//
//## Font, line-height, and color for body text, headings, and more.

$font-family-sans-serif:  "Helvetica Neue", Helvetica, Arial, sans-serif;
$font-family-serif:       Georgia, "Times New Roman", Times, serif;
$font-family-base:        $font-family-sans-serif;
$font-size-base:          18px;

$line-height-base:        1.5;
$line-height-computed:    floor(($font-size-base * $line-height-base));

// Functional Colors
$brand-primary:             $yellow;
$body-bg:                   $white;
$text-color:                $black;
$text-color-inverse:        $gray-light;
$link-color:                $blue;

//Layout
$max-width: 1024px;
$header-height: 75px;

// Spacing
$gutter-padding: 12px;

重新命名檔案的副檔名 styles.css at ui.frontend/src/styles.css to styles.scss. 將內容替換為：

/* styles.scss * /

/* Normalize */
@import '~normalize-scss/sass/normalize';

@import './styles/variables';

body {
    background-color: $body-bg;
    font-family: $font-family-base;
    margin: 0;
    padding: 0;
    font-size: $font-size-base;
    text-align: left;
    color: $text-color;
    line-height: $line-height-base;
}

body.page {
    max-width: $max-width;
    margin: 0 auto;
    padding: $gutter-padding;
    padding-top: $header-height;
}

更新 angular.json 並將所有參照重新命名為 style.css with styles.scss. 應該有3個參考。
```
  "styles": [
-    "src/styles.css"
+    "src/styles.scss"
   ],
```

更新標題樣式

接著，將一些品牌專屬樣式新增至標題元件（使用Sass）。

啟動 webpack開發伺服器 若要即時查看樣式更新：
```
$ npm run start:mock
```

在 ui.frontend/src/app/components/header 重新命名 header.component.css to header.component.scss. 將下列項目填入檔案：

@import "~src/styles/variables";

.header {
    width: 100%;
    position: fixed;
    top: 0;
    left:0;
    z-index: 99;
    background-color: $brand-primary;
    box-shadow: 0px 0px 10px 0px rgba(0, 0, 0, 0.24);
}

.header-container {
    display: flex;
    max-width: $max-width;
    margin: 0 auto;
    padding-left: $gutter-padding;
    padding-right: $gutter-padding;
}

.logo {
    z-index: 100;
    display: flex;
    padding-top: $gutter-padding;
    padding-bottom: $gutter-padding;
}

.logo-img {
    width: 100px;
}

更新 header.component.ts 參考 header.component.scss:

...
  @Component({
    selector: 'app-header',
    templateUrl: './header.component.html',
-   styleUrls: ['./header.component.css']
+   styleUrls: ['./header.component.scss']
  })
...

返回瀏覽器和 webpack開發伺服器:

您現在應該會看到新增至標題元件。

將SPA更新部署至AEM

對標題目前僅可透過 webpack開發伺服器. 將更新的SPA部署至AEM以查看變更。

停止 webpack開發伺服器.
導覽至專案的根目錄 /aem-guides-wknd-spa 並使用Maven將專案部署至AEM:
```
$ cd ..
$ mvn clean install -PautoInstallSinglePackage
```
導覽至 http://localhost:4502/editor.html/content/wknd-spa-angular/us/en/home.html. 您應會看到更新標題並套用標誌和樣式：

現在更新的SPA已在AEM中，製作即可繼續。

恭喜！

恭喜，您已更新SPA並探索與AEM的整合！您現在知道兩種不同的方法，可使用 webpack開發伺服器.

您一律可以在上檢視完成的程式碼 GitHub 或切換到分支，本地檢出代碼 Angular/integrate-spa-solution.

後續步驟

將SPA元件對應至AEM元件 — 了解如何使用AEM SPA Editor JS SDK將Angular元件對應至Adobe Experience Manager(AEM)元件。元件對應可讓作者在AEM SPA編輯器中對SPA元件進行動態更新，與傳統AEM製作類似。

整合SPA

目標

您將建置的

必備條件

取得程式碼

整合方法

Inspect SPA整合

新增標題元件

Webpack開發伺服器 — 代理JSON API

Webpack開發伺服器 — 模擬JSON API

使用Sass新增樣式

更新標題樣式

將SPA更新部署至AEM

恭喜！

後續步驟

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

說明文件

社群

技術支援

資源

Adobe 帳戶

Adobe