文件AEMAEM 教學課程AEM Headless 教學課程

擴充核心元件 extend-component

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • undefined
  • undefined

瞭解如何擴充與AEM SPA編輯器搭配使用的現有核心元件。 瞭解如何擴充現有元件是一項強大的技術，可自訂和擴充AEM SPA Editor實作的功能。

目標

  1. 使用其他屬性和內容擴充現有的核心元件。
  2. 瞭解使用sling:resourceSuperType的元件繼承基本知識。
  3. 瞭解如何為Sling模型善用委派模式，以重複使用現有邏輯和功能。

您將建置的內容

本章說明將額外屬性新增至標準Image元件以滿足新Banner元件需求所需的額外程式碼。 Banner元件包含所有與標準Image元件相同的屬性，但包含使用者填入​ 橫幅文字 ​的額外屬性。

最終編寫的橫幅元件

先決條件

檢閱設定本機開發環境所需的工具和指示。 在本教學課程的這個階段，我們假設使用者已對AEM SPA Editor功能有了充分的瞭解。

Sling資源超級型別的繼承 sling-resource-super-type

若要擴充現有元件，請在元件的定義上設定名為sling:resourceSuperType的屬性。 sling:resourceSuperType是可設定在指向其他元件之AEM元件定義上的屬性。 這會明確設定元件以繼承識別為sling:resourceSuperType之元件的所有功能。

如果我們想要在wknd-spa-react/components/image擴充Image元件，則需要更新ui.apps模組中的程式碼。

  1. 在ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/components/banner的banner的ui.apps模組下建立新資料夾。

  2. 在banner下建立元件定義(.content.xml)，如下所示：

    code language-xml 
    <?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0"
    jcr:primaryType="cq:Component"
    jcr:title="Banner"
    sling:resourceSuperType="wknd-spa-react/components/image"
    componentGroup="WKND SPA React - Content"/>

    此設定wknd-spa-react/components/banner以繼承wknd-spa-react/components/image的所有功能。

cq：editConfig cq-edit-config

_cq_editConfig.xml檔案指定AEM編寫UI中的拖放行為。 擴充影像元件時，資源型別必須符合元件本身。

  1. 在ui.apps模組中，在banner下建立另一個名為_cq_editConfig.xml的檔案。

  2. 使用下列XML填入_cq_editConfig.xml：

    code language-xml 
    <?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
    jcr:primaryType="cq:EditConfig">
    <cq:dropTargets jcr:primaryType="nt:unstructured">
        <image
            jcr:primaryType="cq:DropTargetConfig"
            accept="[image/gif,image/jpeg,image/png,image/webp,image/tiff,image/svg\+xml]"
            groups="[media]"
            propertyName="./fileReference">
            <parameters
                jcr:primaryType="nt:unstructured"
                sling:resourceType="wknd-spa-react/components/banner"
                imageCrop=""
                imageMap=""
                imageRotate=""/>
        </image>
    </cq:dropTargets>
    <cq:inplaceEditing
        jcr:primaryType="cq:InplaceEditingConfig"
        active="{Boolean}true"
        editorType="image">
        <inplaceEditingConfig jcr:primaryType="nt:unstructured">
            <plugins jcr:primaryType="nt:unstructured">
                <crop
                    jcr:primaryType="nt:unstructured"
                    supportedMimeTypes="[image/jpeg,image/png,image/webp,image/tiff]"
                    features="*">
                    <aspectRatios jcr:primaryType="nt:unstructured">
                        <wideLandscape
                            jcr:primaryType="nt:unstructured"
                            name="Wide Landscape"
                            ratio="0.6180"/>
                        <landscape
                            jcr:primaryType="nt:unstructured"
                            name="Landscape"
                            ratio="0.8284"/>
                        <square
                            jcr:primaryType="nt:unstructured"
                            name="Square"
                            ratio="1"/>
                        <portrait
                            jcr:primaryType="nt:unstructured"
                            name="Portrait"
                            ratio="1.6180"/>
                    </aspectRatios>
                </crop>
                <flip
                    jcr:primaryType="nt:unstructured"
                    supportedMimeTypes="[image/jpeg,image/png,image/webp,image/tiff]"
                    features="-"/>
                <map
                    jcr:primaryType="nt:unstructured"
                    supportedMimeTypes="[image/jpeg,image/png,image/webp,image/tiff,image/svg+xml]"
                    features="*"/>
                <rotate
                    jcr:primaryType="nt:unstructured"
                    supportedMimeTypes="[image/jpeg,image/png,image/webp,image/tiff]"
                    features="*"/>
                <zoom
                    jcr:primaryType="nt:unstructured"
                    supportedMimeTypes="[image/jpeg,image/png,image/webp,image/tiff]"
                    features="*"/>
            </plugins>
            <ui jcr:primaryType="nt:unstructured">
                <inline
                    jcr:primaryType="nt:unstructured"
                    toolbar="[crop#launch,rotate#right,history#undo,history#redo,fullscreen#fullscreen,control#close,control#finish]">
                    <replacementToolbars
                        jcr:primaryType="nt:unstructured"
                        crop="[crop#identifier,crop#unlaunch,crop#confirm]"/>
                </inline>
                <fullscreen jcr:primaryType="nt:unstructured">
                    <toolbar
                        jcr:primaryType="nt:unstructured"
                        left="[crop#launchwithratio,rotate#right,flip#horizontal,flip#vertical,zoom#reset100,zoom#popupslider]"
                        right="[history#undo,history#redo,fullscreen#fullscreenexit]"/>
                    <replacementToolbars jcr:primaryType="nt:unstructured">
                        <crop
                            jcr:primaryType="nt:unstructured"
                            left="[crop#identifier]"
                            right="[crop#unlaunch,crop#confirm]"/>
                        <map
                            jcr:primaryType="nt:unstructured"
                            left="[map#rectangle,map#circle,map#polygon]"
                            right="[map#unlaunch,map#confirm]"/>
                    </replacementToolbars>
                </fullscreen>
            </ui>
        </inplaceEditingConfig>
    </cq:inplaceEditing>
</jcr:root>

  3. 檔案的唯一方面是將resourceType設定為wknd-spa-react/components/banner的<parameters>節點。

    code language-xml 
    <parameters
    jcr:primaryType="nt:unstructured"
    sling:resourceType="wknd-spa-react/components/banner"
    imageCrop=""
    imageMap=""
    imageRotate=""/>

    大部分的元件不需要_cq_editConfig。 影像元件和後代則為例外。

延伸對話方塊 extend-dialog

我們的Banner元件需要對話方塊中的額外文字欄位才能擷取bannerText。 由於我們使用Sling繼承，因此可以使用Sling資源合併器的功能來覆寫或擴充對話方塊的部分。 在此範例中，對話方塊中已新增索引標籤，以從作者擷取其他資料以填入卡片元件。

  1. 在ui.apps模組的banner資料夾下方，建立名為_cq_dialog的資料夾。

  2. 在_cq_dialog下建立對話方塊定義檔.content.xml。 請填入下列內容：

    code language-xml 
    <?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="http://sling.apache.org/jcr/sling/1.0" xmlns:granite="http://www.adobe.com/jcr/granite/1.0" xmlns:cq="http://www.day.com/jcr/cq/1.0" xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:nt="http://www.jcp.org/jcr/nt/1.0"
    jcr:primaryType="nt:unstructured"
    jcr:title="Banner"
    sling:resourceType="cq/gui/components/authoring/dialog">
    <content jcr:primaryType="nt:unstructured">
        <items jcr:primaryType="nt:unstructured">
            <tabs jcr:primaryType="nt:unstructured">
                <items jcr:primaryType="nt:unstructured">
                    <text
                        jcr:primaryType="nt:unstructured"
                        jcr:title="Text"
                        sling:orderBefore="asset"
                        sling:resourceType="granite/ui/components/coral/foundation/container"
                        margin="{Boolean}true">
                        <items jcr:primaryType="nt:unstructured">
                            <columns
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"
                                margin="{Boolean}true">
                                <items jcr:primaryType="nt:unstructured">
                                    <column
                                        jcr:primaryType="nt:unstructured"
                                        sling:resourceType="granite/ui/components/coral/foundation/container">
                                        <items jcr:primaryType="nt:unstructured">
                                            <textGroup
                                                granite:hide="${cqDesign.titleHidden}"
                                                jcr:primaryType="nt:unstructured"
                                                sling:resourceType="granite/ui/components/coral/foundation/well">
                                                <items jcr:primaryType="nt:unstructured">
                                                    <bannerText
                                                        jcr:primaryType="nt:unstructured"
                                                        sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
                                                        fieldDescription="Text to display on top of the banner."
                                                        fieldLabel="Banner Text"
                                                        name="./bannerText"/>
                                                </items>
                                            </textGroup>
                                        </items>
                                    </column>
                                </items>
                            </columns>
                        </items>
                    </text>
                </items>
            </tabs>
        </items>
    </content>
</jcr:root>

    上述XML定義將建立名為​ Text ​的新索引標籤，並在​ 現有​ 資產 ​索引標籤之前 ​對其進行排序。 它將包含單一欄位​ 橫幅文字。

  3. 對話方塊看起來像這樣：

    橫幅最終對話方塊

    請注意，我們不需要為​ 資產 ​或​ 中繼資料 ​定義索引標籤。 這些是透過sling:resourceSuperType屬性繼承的。

    在可以預覽對話方塊之前，我們需要實作SPA元件和MapTo函式。

實作SPA元件 implement-spa-component

若要搭配SPA編輯器使用橫幅元件，必須建立將對應到wknd-spa-react/components/banner的新SPA元件。 這已在ui.frontend模組中完成。

  1. 在ui.frontend模組中，於ui.frontend/src/components/Banner為Banner建立新資料夾。

  2. 在Banner資料夾下建立名為Banner.js的新檔案。 請填入下列內容：

    code language-js 
    import React, {Component} from 'react';
import {MapTo} from '@adobe/aem-react-editable-components';

export const BannerEditConfig = {
    emptyLabel: 'Banner',

    isEmpty: function(props) {
        return !props || !props.src || props.src.trim().length < 1;
    }
};

export default class Banner extends Component {

    get content() {
        return <img
                className="Image-src"
                src={this.props.src}
                alt={this.props.alt}
                title={this.props.title ? this.props.title : this.props.alt} />;
    }

    // display our custom bannerText property!
    get bannerText() {
        if(this.props.bannerText) {
            return <h4>{this.props.bannerText}</h4>;
        }

        return null;
    }

    render() {
        if (BannerEditConfig.isEmpty(this.props)) {
            return null;
        }

        return (
            <div className="Banner">
                {this.bannerText}
                <div className="BannerImage">{this.content}</div>
            </div>
        );
    }
}

MapTo('wknd-spa-react/components/banner')(Banner, BannerEditConfig);

    此SPA元件對應至先前建立的AEM元件wknd-spa-react/components/banner。

  3. 在ui.frontend/src/components/import-components.js更新import-components.js以包含新的Banner SPA元件：

    code language-diff 
      import './ExperienceFragment/ExperienceFragment';
  import './OpenWeather/OpenWeather';
+ import './Banner/Banner';

  4. 此時，可以將專案部署到AEM並且可以測試對話方塊。 使用您的Maven技能部署專案：

    code language-shell 
    $ cd aem-guides-wknd-spa.react
$ mvn clean install -PautoInstallSinglePackage

  5. 更新SPA範本的原則以將Banner元件新增為​ 允許的元件。

  6. 導覽至SPA頁面，並將Banner元件新增至其中一個SPA頁面：

    新增橫幅元件

    note note
    NOTE
    此對話方塊可讓您儲存​ 橫幅文字 ​的值，但此值不會反映在SPA元件中。 若要啟用，我們需要為元件延伸Sling模型。

新增Java介面 java-interface

若要最終將元件對話方塊中的值公開給React元件，我們需要更新為Banner元件填入JSON的Sling模型。 這是在core模組中完成的，此模組包含我們SPA專案的所有Java程式碼。

首先，我們將為Banner建立擴充Image Java介面的新Java介面。

  1. 在core模組中，於core/src/main/java/com/adobe/aem/guides/wkndspa/react/core/models建立名為BannerModel.java的新檔案。

  2. 以下列專案填入BannerModel.java：

    code language-java 
    package com.adobe.aem.guides.wkndspa.react.core.models;

import com.adobe.cq.wcm.core.components.models.Image;
import org.osgi.annotation.versioning.ProviderType;

@ProviderType
public interface BannerModel extends Image {

    public String getBannerText();

}

    這會從核心元件Image介面繼承所有方法，並新增一個方法getBannerText()。

實施Sling模型 sling-model

接下來，實作BannerModel介面的Sling模型。

  1. 在core模組中，於core/src/main/java/com/adobe/aem/guides/wkndspa/react/core/models/impl建立名為BannerModelImpl.java的新檔案。

  2. 以下列專案填入BannerModelImpl.java：

    code language-java 
    package com.adobe.aem.guides.wkndspa.react.core.models.impl;

import com.adobe.aem.guides.wkndspa.react.core.models.BannerModel;
import com.adobe.cq.export.json.ComponentExporter;
import com.adobe.cq.export.json.ExporterConstants;
import com.adobe.cq.wcm.core.components.models.Image;
import org.apache.sling.models.annotations.*;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.models.annotations.Model;
import org.apache.sling.models.annotations.injectorspecific.Self;
import org.apache.sling.models.annotations.injectorspecific.ValueMapValue;
import org.apache.sling.models.annotations.via.ResourceSuperType;

@Model(
    adaptables = SlingHttpServletRequest.class,
    adapters = { BannerModel.class,ComponentExporter.class},
    resourceType = BannerModelImpl.RESOURCE_TYPE,
    defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL
)
@Exporter(name = ExporterConstants.SLING_MODEL_EXPORTER_NAME, extensions = ExporterConstants.SLING_MODEL_EXTENSION)
public class BannerModelImpl implements BannerModel {

    // points to the the component resource path in ui.apps
    static final String RESOURCE_TYPE = "wknd-spa-react/components/banner";

    @Self
    private SlingHttpServletRequest request;

    // With sling inheritance (sling:resourceSuperType) we can adapt the current resource to the Image class
    // this allows us to re-use all of the functionality of the Image class, without having to implement it ourself
    // see https://github.com/adobe/aem-core-wcm-components/wiki/Delegation-Pattern-for-Sling-Models
    @Self
    @Via(type = ResourceSuperType.class)
    private Image image;

    // map the property saved by the dialog to a variable named `bannerText`
    @ValueMapValue
    private String bannerText;

    // public getter to expose the value of `bannerText` via the Sling Model and JSON output
    @Override
    public String getBannerText() {
        return bannerText;
    }

    // Re-use the Image class for all other methods:

    @Override
    public String getSrc() {
        return null != image ? image.getSrc() : null;
    }

    @Override
    public String getAlt() {
        return null != image ? image.getAlt() : null;
    }

    @Override
    public String getTitle() {
        return null != image ? image.getTitle() : null;
    }

    // method required by `ComponentExporter` interface
    // exposes a JSON property named `:type` with a value of `wknd-spa-react/components/banner`
    // required to map the JSON export to the SPA component props via the `MapTo`
    @Override
    public String getExportedType() {
        return BannerModelImpl.RESOURCE_TYPE;
    }
}

    請注意，您使用了@Model和@Exporter註解，以確保Sling模型能夠透過Sling模型匯出工具序列化為JSON。

    BannerModelImpl.java對Sling模型使用委派模式以避免重寫影像核心元件中的所有邏輯。

  3. 複查下列各行：

    code language-java 
    @Self
@Via(type = ResourceSuperType.class)
private Image image;

    上述註解會根據Banner元件的sling:resourceSuperType繼承將名為image的影像物件具現化。

    code language-java 
    @Override
public String getSrc() {
    return null != image ? image.getSrc() : null;
}

    然後就可以直接使用image物件來實作Image介面定義的方法，而不需要自行撰寫邏輯。 此技巧用於getSrc()、getAlt()和getTitle()。

  4. 開啟終端機視窗，並使用core目錄中的Maven autoInstallBundle設定檔僅部署core模組的更新。

    code language-shell 
    $ cd core/
$ mvn clean install -PautoInstallBundle

整合所有內容 put-together

  1. 返回AEM並開啟具有Banner元件的SPA頁面。

  2. 更新Banner元件以包含​ 橫幅文字：

    橫幅文字

  3. 將影像填入元件中：

    新增影像至橫幅對話方塊

    儲存對話方塊更新。

  4. 您現在應該會看到​ 橫幅文字 ​的轉譯值：

顯示的橫幅文字

  1. 檢視JSON模型回應： http://localhost:4502/content/wknd-spa-react/us/en.model.json並搜尋wknd-spa-react/components/card：

    code language-json 
    "banner": {
    "bannerText": "My Banner Text",
    "src": "/content/wknd-spa-react/us/en/home/_jcr_content/root/responsivegrid/banner.coreimg.jpeg/1622167884688/sport-climbing.jpeg",
    "alt": "alt banner rock climber",
    ":type": "wknd-spa-react/components/banner"
 },

    請注意，在BannerModelImpl.java中實作Sling模型後，JSON模型已更新為其他索引鍵/值組。

恭喜！ congratulations

恭喜，您已瞭解如何使用擴充AEM元件，以及Sling模型和對話方塊如何搭配JSON模型使用。

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