使用AEM组件自定义Adobe客户端数据层

了解如何使用自定义AEM组件中的内容自定义Adobe客户端数据层。 了解如何使用由提供的API AEM要扩展的核心组件 和自定义数据层。

要构建的内容

署名数据层

在本教程中,让我们探索通过更新WKND来扩展Adobe客户端数据层的各种选项 署名组件. 的 署名 组件是 自定义组件 本教程中学习的和课程可以应用到其他自定义组件。

目标

  1. 通过扩展Sling模型和组件HTL将组件数据注入数据层
  2. 使用核心组件数据层实用程序减少工作量
  3. 使用核心组件数据属性挂接到现有数据层事件

前提条件

A 本地开发环境 是完成本教程所必需的。 使用在macOS上运行的AEMas a Cloud ServiceSDK捕获屏幕截图和视频。 除非另有说明,否则命令和代码与本地操作系统无关。

是AEMas a Cloud Service的新用户? 查看 以下使用AEMas a Cloud Service SDK设置本地开发环境的指南.

AEM 6.5的新增功能? 查看 设置本地开发环境的以下指南.

下载和部署WKND参考网站

本教程将扩展WKND引用站点中的署名组件。 克隆WKND代码库并将其安装到本地环境。

  1. 启动本地快速启动 作者 运行于的AEM实例 http://localhost:4502.

  2. 使用Git打开终端窗口并克隆WKND代码库:

    $ git clone git@github.com:adobe/aem-guides-wknd.git
    
  3. 将WKND代码库部署到AEM的本地实例:

    $ cd aem-guides-wknd
    $ mvn clean install -PautoInstallSinglePackage
    
    注意

    对于AEM 6.5和最新的Service Pack,请添加 classic Maven命令的配置文件:

    mvn clean install -PautoInstallSinglePackage -Pclassic

  4. 打开新的浏览器窗口并登录AEM。 打开 杂志 页面类似: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.

    页面上的署名组件

    您应会看到已作为体验片段的一部分添加到页面的署名组件示例。 您可以在 http://localhost:4502/editor.html/content/experience-fragments/wknd/language-masters/en/contributors/stacey-roswells/byline.html

  5. 打开开发人员工具,然后在 控制台:

    window.adobeDataLayer.getState();
    

    要查看AEM网站上数据层的当前状态,请检查响应。 您应会看到有关页面和各个组件的信息。

    Adobe数据层响应

    请注意,Byline组件未列在数据层中。

更新署名Sling模型

要在数据层中插入有关组件的数据,我们先更新组件的Sling模型。 接下来,更新Byline的Java™界面和Sling Model实施,以使用新方法 getData(). 此方法包含要注入到数据层中的属性。

  1. 打开 aem-guides-wknd 项目。 导航到 core 模块。

  2. 打开文件 Byline.java at core/src/main/java/com/adobe/aem/guides/wknd/core/models/Byline.java.

    署名Java界面

  3. 将以下方法添加到界面:

    public interface Byline {
        ...
        /***
         * Return data about the Byline Component to populate the data layer
         * @return String
         */
        String getData();
    }
    
  4. 打开文件 BylineImpl.java at core/src/main/java/com/adobe/aem/guides/wknd/core/models/impl/BylineImpl.java. 它是 Byline 接口,作为Sling模型实施。

  5. 将以下import语句添加到文件的开头:

    import java.util.HashMap;
    import java.util.Map;
    import org.apache.sling.api.resource.Resource;
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.adobe.cq.wcm.core.components.util.ComponentUtils;
    

    fasterxml.jackson API用于序列化要以JSON形式公开的数据。 的 ComponentUtils 的AEM核心组件来检查数据层是否已启用。

  6. 添加未实现的方法 getData() to BylineImple.java:

    public class BylineImpl implements Byline {
        ...
        @Override
        public String getData() {
            Resource bylineResource = this.request.getResource();
            // Use ComponentUtils to verify if the DataLayer is enabled
            if (ComponentUtils.isDataLayerEnabled(bylineResource)) {
    
                //Create a map of properties we want to expose
                Map<String, Object> bylineProperties = new HashMap<String,Object>();
                bylineProperties.put("@type", bylineResource.getResourceType());
                bylineProperties.put("name", this.getName());
                bylineProperties.put("occupation", this.getOccupations());
                bylineProperties.put("fileReference", image.getFileReference());
    
                //Use AEM Core Component utils to get a unique identifier for the Byline component (in case multiple are on the page)
                String bylineComponentID = ComponentUtils.getId(bylineResource, this.currentPage, this.componentContext);
    
                // Return the bylineProperties as a JSON String with a key of the bylineResource's ID
                try {
                    return String.format("{\"%s\":%s}",
                        bylineComponentID,
                        // Use the ObjectMapper to serialize the bylineProperties to a JSON string
                        new ObjectMapper().writeValueAsString(bylineProperties));
                } catch (JsonProcessingException e) {
    
                    LOGGER.error("Unable to generate dataLayer JSON string", e);
                }
    
            }
            // return null if the Data Layer is not enabled
            return null;
        }
    }
    

    在上述方法中,新 HashMap 用于捕获要以JSON形式显示的属性。 请注意,现有方法如 getName()getOccupations() 中,将使用。 的 @type 表示组件的唯一资源类型,它允许客户端根据组件类型轻松识别事件和/或触发器。

    ObjectMapper 用于序列化属性并返回JSON字符串。 然后,此JSON字符串可以插入到数据层中。

  7. 打开终端窗口。 仅构建和部署 core 模块:

    $ cd aem-guides-wknd/core
    $ mvn clean install -PautoInstallBundle
    

更新署名HTL

接下来,更新 Byline HTL. HTL(HTML模板语言)是用于呈现组件HTML的模板。

特殊数据属性 data-cmp-data-layer 每个AEM组件都用于显示其数据层。 由AEM核心组件提供的JavaScript会查找此数据属性。 此数据属性的值将使用由署名Sling模型返回的JSON字符串填充 getData() 方法,并注入到Adobe客户端数据层中。

  1. 打开 aem-guides-wknd 项目到IDE中。 导航到 ui.apps 模块。

  2. 打开文件 byline.html at ui.apps/src/main/content/jcr_root/apps/wknd/components/byline/byline.html.

    署名HTML

  3. 更新 byline.html 包含 data-cmp-data-layer 属性:

      <div data-sly-use.byline="com.adobe.aem.guides.wknd.core.models.Byline"
        data-sly-use.placeholderTemplate="core/wcm/components/commons/v1/templates.html"
        data-sly-test.hasContent="${!byline.empty}"
    +   data-cmp-data-layer="${byline.data}"
        class="cmp-byline">
        ...
    

    的值 data-cmp-data-layer 已设置为 "${byline.data}" where byline 是否更新了Sling模型。 .data 是在的HTL中调用Java™ Getter方法的标准符号 getData() 在上一次练习中执行。

  4. 打开终端窗口。 仅构建和部署 ui.apps 模块:

    $ cd aem-guides-wknd/ui.apps
    $ mvn clean install -PautoInstallPackage
    
  5. 返回到浏览器并使用署名组件重新打开页面: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.

  6. 打开开发人员工具并检查署名组件的页面HTML源:

    署名数据层

    您应该看到 data-cmp-data-layer 已使用Sling模型中的JSON字符串进行填充。

  7. 打开浏览器的开发人员工具,并在 控制台:

    window.adobeDataLayer.getState();
    
  8. 在下的响应下导航 component 查找 byline 组件已添加到数据层:

    数据层的署名部分

    您应会看到如下条目:

    byline-136073cfcb:
        @type: "wknd/components/byline"
        fileReference: "/content/dam/wknd/en/contributors/stacey-roswells.jpg"
        name: "Stacey Roswells"
        occupation: (3) ["Artist", "Photographer", "Traveler"]
        parentId: "page-30d989b3f8"
    

    请注意,公开的属性与 HashMap 中。

添加点击事件

Adobe客户端数据层是事件驱动的,触发操作的最常见事件之一是 cmp:click 事件。 通过AEM核心组件,可以在数据元素的帮助下轻松注册组件: data-cmp-clickable.

可单击元素通常为CTA按钮或导航链接。 很遗憾,署名组件没有任何这些组件,但我们仍将对其进行注册,因为这可能对其他自定义组件很常见。

  1. 打开 ui.apps 模块

  2. 打开文件 byline.html at ui.apps/src/main/content/jcr_root/apps/wknd/components/byline/byline.html.

  3. 更新 byline.html 包含 data-cmp-clickable 属性 name 元素:

      <h2 class="cmp-byline__name"
    +    data-cmp-clickable="${byline.data ? true : false}">
         ${byline.name}
      </h2>
    
  4. 打开新终端。 仅构建和部署 ui.apps 模块:

    $ cd aem-guides-wknd/ui.apps
    $ mvn clean install -PautoInstallPackage
    
  5. 返回到浏览器并重新打开添加了署名组件的页面: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.

    为了测试我们的事件,我们将使用开发人员控制台手动添加一些JavaScript。 请参阅 将Adobe客户端数据层与AEM核心组件结合使用 以观看有关如何执行此操作的视频。

  6. 打开浏览器的开发人员工具,并在 控制台:

    function bylineClickHandler(event) {
        var dataObject = window.adobeDataLayer.getState(event.eventInfo.path);
        if (dataObject != null && dataObject['@type'] === 'wknd/components/byline') {
            console.log("Byline Clicked!");
            console.log("Byline name: " + dataObject['name']);
        }
    }
    

    此简单方法应处理对署名组件名称的单击。

  7. 控制台:

    window.adobeDataLayer.push(function (dl) {
         dl.addEventListener("cmp:click", bylineClickHandler);
    });
    

    上述方法将事件侦听器推送到数据层以侦听 cmp:click 事件和调用 bylineClickHandler.

    注意

    这很重要 not 要在整个练习中刷新浏览器,否则控制台JavaScript将丢失。

  8. 在浏览器中,使用 控制台 打开,在署名组件中单击作者的姓名:

    已单击署名组件

    您应会看到控制台消息 Byline Clicked! 和署名。

    cmp:click 事件是最容易挂接的事件。 对于更复杂的组件和要跟踪其他行为,可以添加自定义JavaScript以添加和注册新事件。 轮播组件就是一个很好的示例,它会触发 cmp:show 切换幻灯片时发生的事件。 请参阅 更多详细信息的源代码.

使用DataLayerBuilder实用程序

Sling模型 更新 在章节的前面,我们选择使用 HashMap 和手动设置每个属性。 此方法适用于小型一次性组件,但对于扩展AEM核心组件的组件,这可能会产生大量额外代码。

实用程序类, DataLayerBuilder,以执行大部分重力提升。 这允许实施仅扩展所需的属性。 让我们更新Sling模型以使用 DataLayerBuilder.

  1. 返回到IDE并导航到 core 模块。

  2. 打开文件 Byline.java at core/src/main/java/com/adobe/aem/guides/wknd/core/models/Byline.java.

  3. 修改 getData() 返回类型的方法 ComponentData

    import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
    ...
    public interface Byline {
        ...
        /***
         * Return data about the Byline Component to populate the data layer
         * @return ComponentData
         */
        ComponentData getData();
    }
    

    ComponentData 是AEM核心组件提供的对象。 它会生成JSON字符串(与上一个示例中的情况类似),但也会执行大量额外工作。

  4. 打开文件 BylineImpl.java at core/src/main/java/com/adobe/aem/guides/wknd/core/models/impl/BylineImpl.java.

  5. 添加以下import语句:

    import com.adobe.cq.wcm.core.components.models.datalayer.ComponentData;
    import com.adobe.cq.wcm.core.components.models.datalayer.builder.DataLayerBuilder;
    
  6. 替换 getData() 方法:

    @Override
    public ComponentData getData() {
        Resource bylineResource = this.request.getResource();
        // Use ComponentUtils to verify if the DataLayer is enabled
        if (ComponentUtils.isDataLayerEnabled(bylineResource)) {
    
            return DataLayerBuilder.extending(getImage().getData()).asImageComponent()
                .withTitle(this::getName)
                .build();
    
        }
        // return null if the Data Layer is not enabled
        return null;
    }
    

    署名组件会重新使用图像核心组件的部分,以显示代表作者的图像。 在上述代码片段中, 数据层生成器 用于扩展 Image 组件。 这会使用有关所用图像的所有数据预填充JSON对象。 它还会执行一些例程功能,例如设置 @type 和组件的唯一标识符。 请注意,方法很小!

    唯一的属性扩展了 withTitlegetName().

  7. 打开终端窗口。 仅构建和部署 core 模块:

    $ cd aem-guides-wknd/core
    $ mvn clean install -PautoInstallBundle
    
  8. 返回到IDE并打开 byline.html 文件下 ui.apps

  9. 更新HTL以使用 byline.data.json 填充 data-cmp-data-layer 属性:

      <div data-sly-use.byline="com.adobe.aem.guides.wknd.core.models.Byline"
        data-sly-use.placeholderTemplate="core/wcm/components/commons/v1/templates.html"
        data-sly-test.hasContent="${!byline.empty}"
    -   data-cmp-data-layer="${byline.data}"
    +   data-cmp-data-layer="${byline.data.json}"
    

    请记住,我们现在正在返回类型的对象 ComponentData. 此对象包括getter方法 getJson() 并用于填充 data-cmp-data-layer 属性。

  10. 打开终端窗口。 仅构建和部署 ui.apps 模块:

    $ cd aem-guides-wknd/ui.apps
    $ mvn clean install -PautoInstallPackage
    
  11. 返回到浏览器并重新打开添加了署名组件的页面: http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html.

  12. 打开浏览器的开发人员工具,并在 控制台:

    window.adobeDataLayer.getState();
    
  13. 在下的响应下导航 component 查找 byline 组件:

    署名数据层已更新

    您应会看到如下条目:

    byline-136073cfcb:
        @type: "wknd/components/byline"
        dc:title: "Stacey Roswells"
        image:
            @type: "image/jpeg"
            repo:id: "142658f8-4029-4299-9cd6-51afd52345c0"
            repo:modifyDate: "2019-10-25T23:49:51Z"
            repo:path: "/content/dam/wknd/en/contributors/stacey-roswells.jpg"
            xdm:tags: []
        parentId: "page-30d989b3f8"
        repo:modifyDate: "2019-10-18T20:17:24Z"
    

    请注意,现在有 image 对象 byline 组件条目。 这包含有关DAM中资产的更多信息。 另请注意 @type 和唯一id(在本例中为 byline-136073cfcb),并且 repo:modifyDate 指示组件的修改时间。

其他示例

  1. 通过检查 ImageList 组件:

    • ImageList.java — 中的Java界面 core 模块。
    • ImageListImpl.java — 在 core 模块。
    • image-list.html - HTL模板(位于 ui.apps 模块。
    注意

    要包含自定义属性(如 occupation 使用 数据层生成器. 但是,如果扩展包含图像或页面的核心组件,则该实用程序会节省大量时间。

    注意

    如果为整个实施中重复使用的对象构建一个高级数据层,则建议将数据层元素提取到其自己特定于数据层的Java™对象中。 例如,商务核心组件为 ProductDataCategoryData 因为这些组件可用于商务实施中的许多组件。 审阅 aem-cif-core-components存储库中的代码 以了解更多详细信息。

恭喜!

您刚刚探索了使用AEM组件扩展和自定义Adobe客户端数据层的几种方法!

其他资源

在此页面上