擴充核心元件

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

目標

  1. 使用其他屬性和內容擴充現有的核心元件。
  2. 使用sling:resourceSuperType了解元件繼承的基本內容。
  3. 了解如何針對Sling模型運用委派模式來重複使用現有的邏輯和功能。

您將建置的

本章說明在標準Image元件中添加額外屬性以滿足新Banner元件要求所需的附加代碼。 Banner元件包含與標準Image元件相同的所有屬性,但包含一個附加屬性,供用戶填入​橫幅文字

最終製作的橫幅元件

必備條件

查看設定本地開發環境所需的工具和說明。 在此階段,我們假設教學課程中的使用者已對AEM SPA Editor功能有完整的了解。

具有Sling資源超類型的繼承

要在元件的定義上擴展現有元件集名為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/bannerui.apps模組下建立banner的新資料夾。

  2. banner下方建立元件定義(.content.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_editConfig.xml檔案會指定AEM製作UI中的拖放行為。 擴充影像元件時,資源類型必須符合元件本身。

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

  2. 使用以下XML填入_cq_editConfig.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>節點。

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

    大多數元件不需要_cq_editConfig。 影像元件和子體是例外。

擴展對話框

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

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

  2. _cq_dialog下方建立Dialog定義檔案.content.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​的新頁簽,並在​之前將其排序為​現有​Asset​頁簽。 它將包含單個欄位​橫幅文字

  3. 對話方塊如下所示:

    橫幅最終對話方塊

    請注意,我們不必為​Asset​或​Metadata​定義索引標籤。 這些會透過sling:resourceSuperType屬性繼承。

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

實作SPA元件

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

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

  2. Banner資料夾下建立名為Banner.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元件:

      import './ExperienceFragment/ExperienceFragment';
      import './OpenWeather/OpenWeather';
    + import './Banner/Banner';
    
  4. 此時,專案可部署至AEM,且可測試對話方塊。 使用您的Maven技能部署專案:

    $ cd aem-guides-wknd-spa.react
    $ mvn clean install -PautoInstallSinglePackage
    
  5. 更新SPA範本的原則,將Banner元件新增為​允許的元件

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

    新增橫幅元件

    注意

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

添加Java介面

若要最終將元件對話方塊中的值公開給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:

    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模型

接下來,為BannerModel介面實作Sling模型。

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

  2. 將以下內容填入BannerModelImpl.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. 請觀察下列行:

    @Self
    @Via(type = ResourceSuperType.class)
    private Image image;
    

    上述批注將根據Banner元件的sling:resourceSuperType繼承來實例化名為image的影像對象。

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

    然後,只需使用image對象來實現由Image介面定義的方法,而無需自行編寫邏輯。 此技術用於getSrc()getAlt()getTitle()

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

    $ cd core/
    $ mvn clean install -PautoInstallBundle
    

把它們放在一起

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

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

    橫幅文字

  3. 將影像填入元件:

    將影像新增至橫幅對話方塊

    保存對話框更新。

  4. 您現在應該會看到​橫幅文字​的呈現值:

    顯示的橫幅文字

  5. 請在下列網址檢視JSON模型回應:http://localhost:4502/content/wknd-spa-react/us/en.model.json並搜尋wknd-spa-react/components/card:

    "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模型已更新,並附加索引鍵/值組。

恭喜!

恭喜您,您已學會如何使用擴充AEM元件,以及Sling模型和對話方塊如何與JSON模型搭配運作。

本頁內容