文档AEMAEM 教程AEM Headless 教程

集成SPA developer-workflow

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 初学者
  • 开发人员

了解如何将在React中编写的单页应用程序(SPA)的源代码与Adobe Experience Manager (AEM)项目集成。 了解如何使用现代前端工具（如webpack开发服务器）快速开发SPA以支持AEM JSON模型API。

目标

  1. 了解SPA项目如何与AEM和客户端库集成。
  2. 了解如何使用Webpack开发服务器进行专用前端开发。
  3. 探索使用​ proxy ​和静态​ mock ​文件来针对AEM JSON模型API进行开发。

您将构建的内容

在本章中，您将对SPA进行几项细微更改，以了解它如何与AEM集成。
本章将向SPA添加一个简单的Header组件。 在构建此​ 静态 Header组件的过程中，使用了多种方法来开发AEM SPA。

AEM中的新标头

已扩展SPA以添加静态Header组件

先决条件

查看设置本地开发环境所需的工具和说明。 本章是创建项目一章的延续，但您需要遵循的始终是启用了SPA的有效AEM项目。

集成方法 integration-approach

已创建两个模块作为AEM项目的一部分：ui.apps和ui.frontend。

ui.frontend模块是包含所有SPA源代码的webpack项目。 大多数SPA开发和测试都在webpack项目中完成。 触发生产内部版本后，将使用webpack构建和编译SPA。 编译的工件（CSS和Javascript）将复制到ui.apps模块，然后部署到AEM运行时。

ui.frontend高级体系结构

SPA集成的高级描述。

有关前端内部版本的其他信息可在此处找到。

Inspect与SPA集成 inspect-spa-integration

接下来，检查ui.frontend模块以了解AEM项目原型自动生成的SPA。

  1. 在您选择的IDE中，打开AEM项目。 本教程将使用Visual Studio Code IDE。

    VSCode - AEM WKND SPA项目

  2. 展开并检查ui.frontend文件夹。 打开文件ui.frontend/package.json

  3. 在dependencies下，您应该会看到多个与react相关的项，包括react-scripts

    ui.frontend是基于创建React应用程序或CRA的React应用程序。 react-scripts版本指示使用的CRA版本。

  4. 还有多个以@adobe为前缀的依赖项：

    code language-json 
    "@adobe/aem-react-editable-components": "~1.1.2",
"@adobe/aem-spa-component-mapping": "~1.1.0",
"@adobe/aem-spa-page-model-manager": "~1.3.3",
"@adobe/aem-core-components-react-base": "1.1.8",
"@adobe/aem-core-components-react-spa": "1.1.7",

    上述模块构成了AEM SPA Editor JS SDK，并提供了将SPA组件映射到AEM组件的功能。

    还包括AEM WCM组件 — React Core实施和AEM WCM组件 — Spa编辑器 — React Core实施。 这是一组可重复使用的UI组件，这些组件映射到开箱即用的AEM组件。 这些模板按原样设计和样式设计，以满足项目的需求。

  5. 在package.json文件中，定义了多个scripts：

    code language-json 
    "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build && clientlib",
    "test": "react-scripts test",
    "eject": "react-scripts eject",
}

    这些是创建React应用程序使可用的标准生成脚本。

    唯一的区别是将&& clientlib加到build脚本中。 此额外指令负责在生成期间将编译的SPA作为客户端库复制到ui.apps模块中。

    npm模块aem-clientlib-generator用于实现此目的。

  6. Inspect文件ui.frontend/clientlib.config.js。 aem-clientlib-generator使用此配置文件来确定如何生成客户端库。

  7. Inspect文件ui.frontend/pom.xml。 此文件将ui.frontend文件夹转换为Maven模块。 pom.xml文件已更新为在Maven生成期间使用frontend-maven-plugin到​ test ​和​ build SPA。

  8. 在ui.frontend/src/index.jsInspect文件index.js：

    code language-js 
    //ui.frontend/src/index.js
...
document.addEventListener('DOMContentLoaded', () => {
    ModelManager.initialize().then(pageModel => {
        const history = createBrowserHistory();
        render(
        <Router history={history}>
            <App
            history={history}
            cqChildren={pageModel[Constants.CHILDREN_PROP]}
            cqItems={pageModel[Constants.ITEMS_PROP]}
            cqItemsOrder={pageModel[Constants.ITEMS_ORDER_PROP]}
            cqPath={pageModel[Constants.PATH_PROP]}
            locationPathname={window.location.pathname}
            />
        </Router>,
        document.getElementById('spa-root')
        );
    });
});

    index.js是SPA的入口点。 ModelManager由AEM SPA编辑器JS SDK提供。 它负责调用pageModel（JSON内容）并将其插入到应用程序中。

  9. 在ui.frontend/src/components/import-components.jsInspect文件import-components.js。 此文件导入现成的​ React核心组件，并使它们可用于项目。 我们将在下一章中检查AEM内容到SPA组件的映射。

添加静态SPA组件 static-spa-component

接下来，将新组件添加到SPA并将更改部署到本地AEM实例。 这是一个简单的更改，只是为了说明SPA的更新方式。

  1. 在ui.frontend模块的ui.frontend/src/components下创建名为Header的新文件夹。

  2. 在Header文件夹下创建名为Header.js的文件。

    标头文件夹和文件

  3. 使用以下内容填充Header.js：

    code language-js 
    //Header.js
import React, {Component} from 'react';

export default class Header extends Component {

    render() {
        return (
                <header className="Header">
                    <div className="Header-container">
                        <h1>WKND</h1>
                    </div>
                </header>
        );
    }
}

    以上是将输出静态文本字符串的标准React组件。

  4. 打开文件ui.frontend/src/App.js。 这是应用程序的入口点。

  5. 对App.js进行以下更新以包含静态Header：

    code language-diff 
      import { Page, withModel } from '@adobe/aem-react-editable-components';
  import React from 'react';
+ import Header from './components/Header/Header';

  // This component is the application entry point
  class App extends Page {
  render() {
      return (
      <div>
+       <Header />
         {this.childComponents}
         {this.childPages}
     </div>

  6. 打开新终端并导航到ui.frontend文件夹并运行npm run build命令：

    code language-shell 
    $ cd aem-guides-wknd-spa
$ cd ui.frontend
$ npm run build
...
Compiled successfully.

File sizes after gzip:

118.95 KB (-33 B)  build/static/js/2.489f399a.chunk.js
1.11 KB (+48 B)    build/static/js/main.6cfa5095.chunk.js
806 B              build/static/js/runtime-main.42b998df.js
451 B              build/static/css/main.e57bbe8a.chunk.css

  7. 导航到ui.apps文件夹。 在ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/clientlibs/clientlib-react下，您应该会看到编译的SPA文件已从ui.frontend/build文件夹中复制。

    在ui.apps中生成的客户端库

  8. 返回终端并导航到ui.apps文件夹。 执行以下Maven命令：

    code language-shell 
    $ 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的本地正在运行的实例。

  9. 打开浏览器选项卡并导航到http://localhost:4502/editor.html/content/wknd-spa-react/us/en/home.html。 您现在应会看到Header组件的内容显示在SPA中。

    初始标头实现

    从项目的根目录（即mvn clean install -PautoInstallSinglePackage）触发Maven生成时，将自动执行上述步骤。 现在，您应该了解SPA和AEM客户端库之间集成的基础知识。 请注意，您仍然可以在AEM中的静态Header组件下编辑和添加Text组件。

Webpack开发服务器 — JSON API代理 proxy-json

如前面的练习所示，执行构建并将客户端库同步到AEM的本地实例需要几分钟时间。 虽然对于最终测试来说，这是可以接受的，但是对于大多数SPA开发来说，这是不理想的。

可以使用webpack-dev-server快速开发SPA。 SPA由AEM生成的JSON模型驱动。 在本练习中，来自AEM正在运行的实例的JSON内容被​ 代理 ​到开发服务器。

  1. 返回IDE并打开文件ui.frontend/package.json。

    查找类似于以下内容的行：

    code language-json 
    "proxy": "http://localhost:4502",

    创建React应用程序提供了一种代理API请求的简单机制。 所有未知请求均通过本地AEM快速入门localhost:4502代理。

  2. 打开终端窗口并导航到ui.frontend文件夹。 运行命令npm start：

    code language-shell 
    $ cd ui.frontend
$ npm start
...
Compiled successfully!

You can now view wknd-spa-react in the browser.

Local:            http://localhost:3000
On Your Network:  http://192.168.86.136:3000

Note that the development build is not optimized.
To create a production build, use npm run build.

  3. 打开新的浏览器选项卡（如果尚未打开）并导航到http://localhost:3000/content/wknd-spa-react/us/en/home.html。

    Webpack开发服务器 — 代理json

    您应会看到与AEM相同的内容，但未启用任何创作功能。

    note note
    NOTE
    由于AEM的安全要求，您将需要在同一浏览器中（但在其他选项卡中）登录到本地AEM实例(http://localhost:4502)。

  4. 返回到IDE并在src/components/Header文件夹中创建名为Header.css的文件。

  5. 使用以下内容填充Header.css：

    code language-css 
    .Header {
    background-color: #FFEA00;
    width: 100%;
    position: fixed;
    top: 0;
    left: 0;
    z-index: 99;
    box-shadow: 0px 0px 10px 0px rgba(0, 0, 0, 0.24);
}

.Header-container {
    display: flex;
    max-width: 1024px;
    margin: 0 auto;
    padding: 12px;
}

.Header-container h1 {
    letter-spacing: 0;
    font-size: 48px;
}

    VSCode IDE

  6. 重新打开Header.js并将以下行添加到引用Header.css：

    code language-diff 
      //Header.js
  import React, {Component} from 'react';
+ require('./Header.css');

    保存更改。

  7. 导航到http://localhost:3000/content/wknd-spa-react/us/en/home.html以查看样式更改自动反映出来。

  8. 在ui.frontend/src/components/Page处打开文件Page.css。 进行以下更改以修复内边距：

    code language-css 
    .page {
  max-width: 1024px;
  margin: 0 auto;
  padding: 12px;
  padding-top: 50px;
}

  9. 返回位于http://localhost:3000/content/wknd-spa-react/us/en/home.html的浏览器。 您应该会立即看到对应用程序所做的更改得到反映。

    样式已添加到标头

    您可以继续在AEM中进行内容更新，并在​ webpack-dev-server ​中反映这些更新，因为我们正在代理内容。

  10. 停止终端中带有ctrl+c的webpack开发服务器。

将SPA更新部署到AEM

对Header所做的更改当前仅通过​ webpack-dev-server ​可见。 将更新后的SPA部署到AEM以查看更改内容。

  1. 导航到项目的根目录(aem-guides-wknd-spa)，并使用Maven将该项目部署到AEM：

    code language-shell 
    $ cd ..
$ mvn clean install -PautoInstallSinglePackage

  2. 导航到http://localhost:4502/editor.html/content/wknd-spa-react/us/en/home.html。 您应会看到已应用的Header更新样式和样式。

    在AEM中更新了标头

    现在，更新后的SPA位于AEM中，创作可以继续进行。

恭喜！ congratulations

恭喜，您已更新SPA并探索了与AEM的集成！ 您现在知道如何使用​ webpack-dev-server ​针对AEM JSON模型API开发SPA。

后续步骤 next-steps

将SPA组件映射到AEM组件 — 了解如何使用AEM SPA编辑器JS SDK将React组件映射到Adobe Experience Manager (AEM)组件。 组件映射使用户能够对AEM SPA编辑器中的SPA组件进行动态更新，这与传统AEM创作类似。

（奖励） Webpack开发服务器 — Mock JSON API mock-json

快速开发的另一种方法是使用静态JSON文件充当JSON模型。 通过“模拟”JSON，我们删除了对本地AEM实例的依赖关系。 它还允许前端开发人员更新JSON模型，以测试功能并驱动对JSON API的更改，这些更改稍后将由后端开发人员实施。

模拟JSON的初始设置需要​ 本地AEM实例。

  1. 返回到IDE并导航到ui.frontend/public并添加名为mock-content的新文件夹。

  2. 在ui.frontend/public/mock-content下创建名为mock.model.json的新文件。

  3. 在浏览器中导航到http://localhost:4502/content/wknd-spa-react/us/en.model.json。

    这是由AEM导出的驱动应用程序的JSON。 复制JSON输出。

  4. 将上一步的JSON输出粘贴到文件mock.model.json中。

    模拟模型Json文件

  5. 在ui.frontend/public/index.html处打开文件index.html。 更新AEM页面模型的元数据属性以指向变量%REACT_APP_PAGE_MODEL_PATH%：

    code language-html 
        <!-- AEM page model -->
    <meta
       property="cq:pagemodel_root_url"
       content="%REACT_APP_PAGE_MODEL_PATH%"
    />

    为cq:pagemodel_root_url的值使用变量将更便于在代理和模拟json模型之间进行切换。

  6. 打开文件ui.frontend/.env.development并进行以下更新以注释掉REACT_APP_PAGE_MODEL_PATH和REACT_APP_API_HOST的上一个值：

    code language-diff 
    + PUBLIC_URL=/
- PUBLIC_URL=/etc.clientlibs/wknd-spa-react/clientlibs/clientlib-react/resources

- REACT_APP_PAGE_MODEL_PATH=/content/wknd-spa-react/us/en.model.json
+ REACT_APP_PAGE_MODEL_PATH=/mock-content/mock.model.json

- REACT_APP_API_HOST=http://localhost:4502
+ #REACT_APP_API_HOST=http://localhost:4502

REACT_APP_ROOT=/content/wknd-spa-react/us/en/home.html

  7. 如果当前正在运行，请停止​ webpack-dev-server。 从终端启动​ webpack-dev-server：

    code language-shell 
    $ cd ui.frontend
$ npm start

    导航到http://localhost:3000/content/wknd-spa-react/us/en/home.html，您应会看到内容与​ proxy json中使用的内容相同的SPA。

  8. 对之前创建的mock.model.json文件进行小幅更改。 您应该会看到更新的内容立即反映在​ webpack-dev-server ​中。

    模拟模型json更新

能够处理JSON模型并查看对实时SPA的影响可以帮助开发人员了解JSON模型API。 它还允许前端和后端开发并行进行。

您现在可以通过切换env.development文件中的条目来切换使用JSON内容的位置：

# JSON API via proxy to AEM
#REACT_APP_PAGE_MODEL_PATH=/content/wknd-spa-react/us/en.model.json
#REACT_APP_API_HOST=http://localhost:4502

# JSON API via static mock file
REACT_APP_PAGE_MODEL_PATH=/mock-content/mock.model.json
recommendation-more-help
e25b6834-e87f-4ff3-ba56-4cd16cdfdec4