将SPA组件映射到AEM组件 map-components

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

本章更深入地介绍了AEM JSON模型API,以及如何将由AEM组件公开的JSON内容作为prop自动插入到Angular组件中。

目标

  1. 了解如何将AEM组件映射到SPA组件。
  2. 了解两者之间的差异 容器 组件和 内容 组件。
  3. 创建映射到现有AEM组件的新Angular组件。

您将构建的内容

本章将检查提供的 Text SPA组件已映射到AEM Text组件。 新 Image SPA组件是创建出来的,可以在SPA中使用并在AEM中创作。 的开箱即用功能 布局容器模板编辑器 策略还将用于创建外观更加多样化的视图。

章节示例最终创作

先决条件

查看所需的工具和设置说明 本地开发环境.

获取代码

  1. 通过Git下载本教程的起点:

    code language-shell
    $ git clone git@github.com:adobe/aem-guides-wknd-spa.git
    $ cd aem-guides-wknd-spa
    $ git checkout Angular/map-components-start
    
  2. 使用Maven将代码库部署到本地AEM实例:

    code language-shell
    $ mvn clean install -PautoInstallSinglePackage
    

    如果使用 AEM 6.x 添加 classic 个人资料:

    code language-shell
    $ mvn clean install -PautoInstallSinglePackage -Pclassic
    

您始终可以在上查看完成的代码 GitHub 或通过切换到分支在本地签出代码 Angular/map-components-solution.

映射方法

基本概念是将SPA组件映射到AEM组件。 AEM组件运行服务器端,将内容导出为JSON模型API的一部分。 JSON内容由SPA使用,在浏览器中运行客户端。 在SPA组件和AEM组件之间创建1:1映射。

将AEM组件映射到Angular组件的高级概述

将AEM组件映射到Angular组件的高级概述

Inspect文本组件

AEM项目原型 提供 Text 映射到AEM的组件 文本组件. 以下示例为 内容 组件,在中,它呈现 内容 来自AEM的。

我们来看看组件的工作方式。

Inspect的JSON模型

  1. 在跳转到SPA代码之前,请务必了解AEM提供的JSON模型。 导航至 核心组件库 和查看文本组件的页面。 核心组件库提供了所有AEM核心组件的示例。

  2. 选择 JSON 选项卡以了解以下示例之一:

    文本JSON模型

    您应该会看到三个属性: textrichText、和 :type.

    :type 是一个保留属性,其中列出了 sling:resourceType AEM组件的(或路径)。 的值 :type 是用于将AEM组件映射到SPA组件的功能。

    textrichText 是公开给SPA组件的其他属性。

Inspect文本组件

  1. 打开新终端并导航到 ui.frontend 文件夹内。 运行 npm install 然后 npm start 以启动 webpack开发服务器

    code language-shell
    $ cd ui.frontend
    $ npm run start:mock
    

    ui.frontend 模块当前设置为使用 模拟JSON模型.

  2. 您应该会看到一个新的浏览器窗口打开 http://localhost:4200/content/wknd-spa-angular/us/en/home.html

    带有模拟内容的Webpack开发服务器

  3. 在您选择的IDE中,打开WKND SPA的AEM项目。 展开 ui.frontend 模块并打开文件 text.component.tsui.frontend/src/app/components/text/text.component.ts

    Text.jsAngular组件源代码

  4. 第一个要检查的区域是 class TextComponent 在第35行:

    code language-js
    export class TextComponent {
        @Input() richText: boolean;
        @Input() text: string;
        @Input() itemName: string;
    
        @HostBinding('innerHtml') get content() {
            return this.richText
            ? this.sanitizer.bypassSecurityTrustHtml(this.text)
            : this.text;
        }
        @HostBinding('attr.data-rte-editelement') editAttribute = true;
    
        constructor(private sanitizer: DomSanitizer) {}
    }
    

    @Input() decorator用于声明通过映射的JSON对象设置的字段,之前已查看过该对象。

    @HostBinding('innerHtml') get content() 是一种从的值中公开所编写文本内容的方法 this.text. 在内容为富文本的情况下(由 this.richText 标志)绕过Angular的内置安全性。 angular DomSanitizer 用于“清理”原始HTML并防止跨站点脚本漏洞。 该方法绑定到 innerHtml 属性使用 @HostBinding 装潢师。

  5. 接下来,检查 TextEditConfig 在第24行:

    code language-js
    const TextEditConfig = {
        emptyLabel: 'Text',
        isEmpty: cqModel =>
            !cqModel || !cqModel.text || cqModel.text.trim().length < 1
    };
    

    上述代码负责确定何时在AEM创作环境中呈现占位符。 如果 isEmpty 方法返回 true 然后会呈现占位符。

  6. 最后,查看 MapTo 在第53行以下位置调用:

    code language-js
    MapTo('wknd-spa-angular/components/text')(TextComponent, TextEditConfig );
    

    映射到 由AEM SPA编辑器JS SDK提供(@adobe/cq-angular-editable-components)。 路径 wknd-spa-angular/components/text 表示 sling:resourceType AEM的URL值。 此路径与 :type 已由之前观察到的JSON模型公开。 映射到 解析JSON模型响应并将正确的值传递给 @Input() SPA组件的变量。

    您可以找到AEM Text 组件定义位于 ui.apps/src/main/content/jcr_root/apps/wknd-spa-angular/components/text.

  7. 通过修改 en.model.json 文件位于 ui.frontend/src/mocks/json/en.model.json.

    在第62行,更新第一个 Text 值使用 H1u 标记:

    code language-json
        "text": {
            "text": "<h1><u>Hello World!</u></h1>",
            "richText": true,
            ":type": "wknd-spa-angular/components/text"
        }
    

    返回到浏览器以查看 webpack开发服务器

    已更新文本模型

    尝试切换 richText 属性介于 true / false 以查看正在运行的渲染逻辑。

  8. Inspect text.component.htmlui.frontend/src/app/components/text/text.component.html.

    此文件为空,因为组件的整个内容由 innerHTML 属性。

  9. Inspect app.module.tsui.frontend/src/app/app.module.ts.

    code language-js
    @NgModule({
    imports: [
        BrowserModule,
        SpaAngularEditableComponentsModule,
        AppRoutingModule
    ],
    providers: [ModelManagerService, { provide: APP_BASE_HREF, useValue: '/' }],
    declarations: [AppComponent, TextComponent, PageComponent, HeaderComponent],
    entryComponents: [TextComponent, PageComponent],
    bootstrap: [AppComponent]
    })
    export class AppModule {}
    

    文本组件 未显式包含,而是动态地通过 AEMRessensitiveGridComponent 由AEM SPA编辑器JS SDK提供。 因此,必须列在 app.module.tsentryComponents 数组。

创建图像组件

接下来,创建 Image 映射到AEM的Angular组件 图像组件. 此 Image 组件是 内容 组件。

Inspect和JSON

在跳转到SPA代码之前,请检查AEM提供的JSON模型。

  1. 导航至 核心组件库中的图像示例.

    图像核心组件JSON

    属性 srcalt、和 title 用于填充SPA Image 组件。

    note note
    NOTE
    公开其他图像属性(lazyEnabledwidths)允许开发人员创建自适应和延迟加载组件。 本教程中构建的组件非常简单,可以 使用这些高级属性。
  2. 返回到IDE并打开 en.model.jsonui.frontend/src/mocks/json/en.model.json. 由于这是我们项目的新组件,因此我们需要“模拟”图像JSON。

    在~line 70 ,为添加一个JSON条目 image 模型(不要忘记尾部逗号) , 在第二个之后 text_386303036)并更新 :itemsOrder 数组。

    code language-json
    ...
    ":items": {
                ...
                "text_386303036": {
                    "text": "<p>A new text component.</p>\r\n",
                    "richText": true,
                    ":type": "wknd-spa-angular/components/text"
                    },
                "image": {
                    "alt": "Rock Climber in New Zealand",
                    "title": "Rock Climber in New Zealand",
                    "src": "/mocks/images/adobestock-140634652.jpeg",
                    ":type": "wknd-spa-angular/components/image"
                }
            },
            ":itemsOrder": [
                "text",
                "text_386303036",
                "image"
            ],
    

    该项目包括一个示例图像,位于 /mock-content/adobestock-140634652.jpeg 用于 webpack开发服务器.

    您可以查看完整的 en.model.json(在此处).

  3. 添加组件要显示的照片库。

    创建新文件夹,名为 图像ui.frontend/src/mocks. 下载 adobestock-140634652.jpeg 并将其放入新创建的 图像 文件夹。 如果需要,您可以随意使用您自己的图像。

实施图像组件

  1. 停止 webpack开发服务器 (如果已启动)。

  2. 通过运行AngularCLI创建新的图像组件 ng generate component 命令来自内部 ui.frontend 文件夹:

    code language-shell
    $ ng generate component components/image
    
  3. 在IDE中,打开 image.component.tsui.frontend/src/app/components/image/image.component.ts 并按以下方式更新:

    code language-js
    import {Component, Input, OnInit} from '@angular/core';
    import {MapTo} from '@adobe/cq-angular-editable-components';
    
    const ImageEditConfig = {
    emptyLabel: 'Image',
    isEmpty: cqModel =>
        !cqModel || !cqModel.src || cqModel.src.trim().length < 1
    };
    
    @Component({
    selector: 'app-image',
    templateUrl: './image.component.html',
    styleUrls: ['./image.component.scss']
    })
    export class ImageComponent implements OnInit {
    
    @Input() src: string;
    @Input() alt: string;
    @Input() title: string;
    
    constructor() { }
    
    get hasImage() {
        return this.src && this.src.trim().length > 0;
    }
    
    ngOnInit() { }
    }
    
    MapTo('wknd-spa-angular/components/image')(ImageComponent, ImageEditConfig);
    

    ImageEditConfig 是用于确定是否在AEM中呈现创作占位符的配置,基于 src 属性会被填充。

    @Input()srcalt、和 title 是从JSON API映射的属性。

    hasImage() 是一种用于确定是否应渲染图像的方法。

    MapTo 将SPA组件映射到位于以下位置的AEM组件: ui.apps/src/main/content/jcr_root/apps/wknd-spa-angular/components/image.

  4. 打开 image.component.html 并按照以下方式更新它:

    code language-html
    <ng-container *ngIf="hasImage">
        <img class="image" [src]="src" [alt]="alt" [title]="title"/>
    </ng-container>
    

    这将呈现 <img> 元素if hasImage 返回 true.

  5. 打开 image.component.scss 并按照以下方式更新它:

    code language-scss
    :host-context {
        display: block;
    }
    
    .image {
        margin: 1rem 0;
        width: 100%;
        border: 0;
    }
    
    note note
    NOTE
    :host-context 规则为 关键 以使AEM SPA编辑器占位符正常工作。 所有打算在SPA页面编辑器中创作的AEM组件至少都需要此规则。
  6. 打开 app.module.ts 并添加 ImageComponententryComponents 数组:

    code language-js
    entryComponents: [TextComponent, PageComponent, ImageComponent],
    

    点赞 TextComponentImageComponent 动态加载,并且必须包含在 entryComponents 数组。

  7. 启动 webpack开发服务器 以查看 ImageComponent 渲染。

    code language-shell
    $ npm run start:mock
    

    添加到模拟的图像

    图像已添加到SPA

    note note
    NOTE
    奖励质询:实施新方法来显示值 title 作为图像下面的说明。

在AEM中更新策略

ImageComponent 组件仅在 webpack开发服务器. 接下来,将更新的SPA部署到AEM并更新模板策略。

  1. 停止 webpack开发服务器 和从 之后,使用您的Maven技能将更改部署到AEM:

    code language-shell
    $ cd aem-guides-wknd-spa
    $ mvn clean install -PautoInstallSinglePackage
    
  2. 从AEM开始屏幕导航到 工具 > 模板 > WKND SPAANGULAR.

    选择并编辑 SPA页面

    编辑SPA页面模板

  3. 选择 布局容器 单击它 策略 图标以编辑策略:

    布局容器策略

  4. 允许的组件 > WKND SPAAngular — 内容 >查看 图像 组件:

    已选择图像组件

    默认组件 > 添加映射 并选择 图像 — WKND SPAAngular — 内容 组件:

    设置默认组件

    输入 mime类型image/*.

    单击 完成 以保存策略更新。

  5. 布局容器 单击 策略 图标 文本 组件:

    文本组件策略图标

    创建新策略,名为 WKND SPA文本. 下 插件 > 格式化 >选中所有框以启用其他格式选项:

    启用RTE格式

    插件 > 段落样式 >选中 启用段落样式

    启用段落样式

    单击 完成 以保存策略更新。

  6. 导航至 主页 http://localhost:4502/editor.html/content/wknd-spa-angular/us/en/home.html.

    您还应该能够编辑 Text 组件并在中添加其他段落样式 全屏 模式。

    全屏富文本编辑

  7. 您还应该能够从 资产查找器

    拖放图像

  8. 通过以下方式添加您自己的图像 AEM Assets 或安装完成的标准代码库 WKND引用站点. 此 WKND引用站点 包括可在WKND SPA上重复使用的许多图像。 可使用以下方式安装软件包 AEM包管理器.

    包管理器安装wknd.all

Inspect布局容器

支持 布局容器 由AEM SPA编辑器SDK自动提供。 此 布局容器 ​如名称所示,是 容器 组件。 容器组件是接受JSON结构的组件,表示 其他 组件并动态实例化它们。

让我们进一步检查布局容器。

  1. 在IDE中打开 responsive-grid.component.tsui.frontend/src/app/components/responsive-grid

    code language-js
    import { AEMResponsiveGridComponent,MapTo } from '@adobe/cq-angular-editable-components';
    
    MapTo('wcm/foundation/components/responsivegrid')(AEMResponsiveGridComponent);
    

    AEMResponsiveGridComponent 作为AEM SPA Editor SDK的一部分实施,并通过包含在项目中 import-components.

  2. 在浏览器中,导航到 http://localhost:4502/content/wknd-spa-angular/us/en.model.json

    JSON模型API — 响应式网格

    布局容器 组件具有 sling:resourceTypewcm/foundation/components/responsivegrid 并由SPA编辑器使用 :type 属性,就像 TextImage 组件。

    使用重新调整组件大小的相同功能 布局模式 可用于SPA编辑器。

  3. 返回到 http://localhost:4502/editor.html/content/wknd-spa-angular/us/en/home.html. 添加其他 图像 组件,然后尝试使用 布局 选项:

    使用布局模式重新调整图像大小

  4. 重新打开JSON模型 http://localhost:4502/content/wknd-spa-angular/us/en.model.json 并观察 columnClassNames 作为JSON的一部分:

    列类名

    类名称 aem-GridColumn--default--4 指示组件应基于12列网格为4列宽。 更多有关 可在此处找到响应式网格.

  5. 返回到IDE并在 ui.apps 模块在上定义了客户端库 ui.apps/src/main/content/jcr_root/apps/wknd-spa-angular/clientlibs/clientlib-grid. 打开文件 less/grid.less.

    此文件确定断点(defaulttablet、和 phone),用于 布局容器. 此文件将根据项目规范进行自定义。 当前,断点设置为 1200px650px.

  6. 您应该能够使用的响应式功能和更新的富文本策略 Text 用于创作视图的组件,如下所示:

    章节示例最终创作

恭喜! congratulations

恭喜,您已了解如何将SPA组件映射到AEM组件,并实施了新的 Image 组件。 您还有机会探索的响应式功能 布局容器.

您始终可以在上查看完成的代码 GitHub 或通过切换到分支在本地签出代码 Angular/map-components-solution.

后续步骤 next-steps

导航和路由 — 了解如何使用SPA编辑器SDK将映射到AEM页面,从而支持SPA中的多个视图。 动态导航使用Angular路由器实现,并添加到现有的报头组件中。

额外练习 — 将配置保留到源代码管理 bonus

在许多情况下,尤其是在AEM项目开始时,将配置(如模板和相关内容策略)保留到源代码控制中非常有用。 这可确保所有开发人员都针对同一组内容和配置工作,并可确保环境之间具有额外的一致性。 一旦项目达到一定的成熟度,管理模板的操作就可以交给一组特殊的超级用户。

接下来的几个步骤将使用Visual Studio Code IDE和 VSCode AEM同步 但可以使用任何工具和您配置的任何IDE来执行 提取导入 AEM本地实例中的内容。

  1. 在Visual Studio Code IDE中,确保您具有 VSCode AEM同步 通过Marketplace扩展安装:

    VSCode AEM同步

  2. 展开 ui.content 模块并导航到 /conf/wknd-spa-angular/settings/wcm/templates.

  3. 右键单击templates 文件夹并选择 从AEM服务器导入

    Vscode导入模板

  4. 重复这些步骤以导入内容,但选择 策略 文件夹位于 /conf/wknd-spa-angular/settings/wcm/policies.

  5. Inspect filter.xml 文件位于 ui.content/src/main/content/META-INF/vault/filter.xml.

    code language-xml
    <!--ui.content filter.xml-->
    <?xml version="1.0" encoding="UTF-8"?>
     <workspaceFilter version="1.0">
         <filter root="/conf/wknd-spa-angular" mode="merge"/>
         <filter root="/content/wknd-spa-angular" mode="merge"/>
         <filter root="/content/dam/wknd-spa-angular" mode="merge"/>
         <filter root="/content/experience-fragments/wknd-spa-angular" mode="merge"/>
     </workspaceFilter>
    

    filter.xml 文件负责标识随包一起安装的节点的路径。 请注意 mode="merge" 对于每个表示现有内容将不会被修改的过滤器,将只添加新内容。 由于内容作者可能正在更新这些路径,因此代码部署必须更新 覆盖内容。 请参阅 FileVault文档 以了解有关使用筛选条件元素的更多详细信息。

    比较 ui.content/src/main/content/META-INF/vault/filter.xmlui.apps/src/main/content/META-INF/vault/filter.xml 了解每个模块管理的不同节点。

recommendation-more-help
e25b6834-e87f-4ff3-ba56-4cd16cdfdec4