使用AEM元件自訂Adobe用戶端資料層

了解如何使用自訂AEM元件的內容來自訂Adobe用戶端資料層。 了解如何使用AEM核心元件提供的API來擴充和自訂資料層。

您將建置的

署名資料層

在本教程中,您將通過更新WKND Byline元件來探索擴展Adobe客戶端資料層的各種選項。 這是自訂元件,本教學課程中的經驗教訓可套用至其他自訂元件。

目標

  1. 延伸Sling模型和元件HTL,將元件資料插入資料層
  2. 使用核心元件資料層公用程式來減輕工作量
  3. 使用核心元件資料屬性連結至現有的資料層事件

必備條件

完成本教學課程需要​本機開發環境。 螢幕擷取畫面和影片是使用AEM作為在macOS上執行的Cloud ServiceSDK來擷取。 除非另有說明,否則命令和代碼獨立於本地作業系統。

AEM as a Cloud Service 的新手嗎? 請參閱以下指南以使用 AEM as a Cloud Service SDK 設定本機開發環境

AEM 6.5 的新手嗎? 請參閱以下指南以設定本機開發環境

下載並部署WKND參考站點

本教學課程會擴充WKND參考網站中的署名元件。 將WKND程式碼基底原地複製並安裝至本機環境。

  1. 啟動運行在http://localhost:4502的AEM的本地Quickstart author​實例。

  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();
    

    Inspect回應,可查看AEM網站上資料層的目前狀態。 您應該會看到頁面和個別元件的相關資訊。

    Adobe資料層回應

    請注意,資料層中未列出署名元件。

更新署名Sling模型

若要在資料層中插入元件相關資料,必須先更新元件的Sling模型。 接下來,更新Byline的Java介面和Sling Model實作,以新增新方法getData()。 此方法將包含我們要插入資料層的屬性。

  1. 在所選IDE中,開啟aem-guides-wknd項目。 導覽至core模組。

  2. core/src/main/java/com/adobe/aem/guides/wknd/core/models/Byline.java開啟檔案Byline.java

    署名Java介面

  3. 將新方法新增至介面:

    public interface Byline {
        ...
        /***
         * Return data about the Byline Component to populate the data layer
         * @return String
         */
        String getData();
    }
    
  4. core/src/main/java/com/adobe/aem/guides/wknd/core/models/impl/BylineImpl.java開啟檔案BylineImpl.java

    這是Byline介面的實作,並以Sling模型實作。

  5. 將下列匯入陳述式新增至檔案的開頭:

    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的資料。 AEM核心元件的ComponentUtils將用於檢查資料層是否已啟用。

  6. 將未實現的方法getData()添加到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. 開啟終端窗口。 使用您的Maven技能,只建立並部署core模組:

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

更新署名HTL

接下來,更新Byline HTL。 HTL(HTML範本語言)是用來轉譯元件HTML的範本。

每個AEM元件上的特殊資料屬性data-cmp-data-layer用於公開其資料層。 AEM核心元件提供的JavaScript會尋找此資料屬性,其值會填入由署名Sling模型的getData()方法傳回的JSON字串,並將值插入Adobe用戶端資料層。

  1. 在IDE中,開啟aem-guides-wknd項目。 導覽至ui.apps模組。

  2. ui.apps/src/main/content/jcr_root/apps/wknd/components/byline/byline.html開啟檔案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}",其中byline為先前更新的Sling模型。 .data 是在先前練習中實作的HTL中呼叫Java Getter方 getData() 法的標準標籤法。

  4. 開啟終端窗口。 使用您的Maven技能,只建立並部署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. 開啟開發人員工具,並檢查Byline元件頁面的HTML來源:

    署名資料層

    您應會看到data-cmp-data-layer已填入Sling模型的JSON字串。

  7. 開啟瀏覽器的開發人員工具,並在​Console​中輸入以下命令:

    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"
    

    請注意,公開的屬性與Sling模型中HashMap中新增的屬性相同。

新增點按事件

Adobe用戶端資料層是事件驅動的,觸發動作的最常見事件之一是cmp:click事件。 AEM核心元件可讓您在資料元素的協助下,輕鬆註冊元件:data-cmp-clickable

可點按的元素通常是CTA按鈕或導覽連結。 很可惜,署名元件沒有這些,但我們會以任何方式註冊,因為這可能是其他自訂元件的常見情況。

  1. 在IDE中開啟ui.apps模組

  2. ui.apps/src/main/content/jcr_root/apps/wknd/components/byline/byline.html開啟檔案byline.html

  3. 更新byline.html以在署名的​name​元素上包含data-cmp-clickable屬性:

      <h2 class="cmp-byline__name" 
    +    data-cmp-clickable="${byline.data ? true : false}">
         ${byline.name}
      </h2>
    
  4. 開啟新的終端。 使用您的Maven技能,只建立並部署ui.apps模組:

    $ cd aem-guides-wknd/ui.apps
    $ mvn clean install -PautoInstallPackage
    
  5. 返回瀏覽器,並重新開啟已新增Byline元件的頁面:http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html

    若要測試事件,我們將使用開發人員主控台手動新增一些JavaScript。 如需如何執行此動作的影片,請參閱搭配使用Adobe用戶端資料層與AEM核心元件

  6. 開啟瀏覽器的開發人員工具,並在​Console​中輸入下列方法:

    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

    注意

    在本練習中重新整理瀏覽器很重要,否則主控台JavaScript將會遺失。

  8. 在瀏覽器中,開啟​主控台​後,在署名元件中按一下作者的名稱:

    已點按署名元件

    您應該會看到主控台訊息Byline Clicked!和署名名稱。

    cmp:click事件是最容易連結的事件。 若要了解更複雜的元件並追蹤其他行為,可以新增自訂javascript以新增和註冊新事件。 旋轉切換元件就是絕佳範例,每當切換滑片時,就會觸發cmp:show事件。 如需詳細資訊,請參閱原始碼

使用DataLayerBuilder實用程式

當章節中較早的Sling模型為更新時,我們選擇使用HashMap並手動設定每個屬性,以建立JSON字串。 此方法適用於小型一次性元件,但若是擴充AEM核心元件的元件,則可能會產生大量額外程式碼。

DataLayerBuilder實用程式類存在,用於執行大部分的重力提升。 這可讓實施只擴充其所需的屬性。 讓我們更新Sling模型,以使用DataLayerBuilder

  1. 返回IDE並導航到core模組。

  2. core/src/main/java/com/adobe/aem/guides/wknd/core/models/Byline.java開啟檔案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. core/src/main/java/com/adobe/aem/guides/wknd/core/models/impl/BylineImpl.java開啟檔案BylineImpl.java

  5. 新增下列匯入陳述式:

    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;
    }
    

    署名元件會重複使用影像核心元件的部分,以顯示代表作者的影像。 在上述程式碼片段中,DataLayerBuilder用於擴充Image元件的資料層。 這會以所使用影像的所有相關資料預先填入JSON物件。 它也會執行一些常式功能,例如設定元件的@type和唯一識別碼。 請注意,方法非常小!

    唯一的屬性擴展了withTitle,該被getName()值替換。

  7. 開啟終端窗口。 使用您的Maven技能,只建立並部署core模組:

    $ cd aem-guides-wknd/core
    $ mvn clean install -PautoInstallBundle
    
  8. 返回IDE並開啟ui.apps下的byline.html檔案

  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. 開啟終端窗口。 使用您的Maven技能,只建立並部署ui.apps模組:

    $ cd aem-guides-wknd/ui.apps
    $ mvn clean install -PautoInstallPackage
    
  11. 返回瀏覽器,並重新開啟已新增Byline元件的頁面:http://localhost:4502/content/wknd/us/en/magazine/guide-la-skateparks.html

  12. 開啟瀏覽器的開發人員工具,並在​Console​中輸入以下命令:

    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"
    

    請注意,byline元件項目中現在有image物件。 這裡有更多關於DAM中資產的資訊。 另請注意,已自動填入@type和唯一ID(在此例中為byline-136073cfcb),以及指示修改元件時的repo:modifyDate

其他範例

  1. 在WKND程式碼基底中檢查ImageList元件,即可檢視延伸資料層的另一個範例:

    • ImageList.java — 模組中的Java介 core 面。
    • ImageListImpl.java — 模組中的Sling core 模型。
    • image-list.html — 模組中的HTL ui.apps 範本。
    注意

    使用DataLayerBuilder時,要包含occupation之類的自訂屬性較為困難。 不過,如果擴充包含影像或頁面的核心元件,公用程式可節省大量時間。

    注意

    如果針對在整個實施中重複使用的物件建立進階資料層,建議將資料層元素擷取至其自己的資料層專用的Java物件。 例如,商務核心元件已新增ProductDataCategoryData的介面,因為這些介面可用於商務實施中的許多元件。 如需詳細資訊,請檢閱aem-cif-core-components repo🔗中的程式碼。

恭喜!

您剛剛探索了幾種使用AEM元件擴充和自訂Adobe用戶端資料層的方式!

其他資源

本頁內容