建立自訂天氣元件

瞭解如何建立與AEM SPA編輯器搭配使用的自訂天氣元件。瞭解如何開發作者對話方塊和Sling模型，以擴充JSON模型來填入自訂元件。此開放氣象API 和 React Open Weather元件已使用。

目標

瞭解Sling模型在操控AEM提供的JSON模型API方面的作用。
瞭解如何建立新的AEM元件對話方塊。
瞭解如何建立自訂與AEM編輯器架構相容的SPA元件。

您將建置的內容

建立簡單的天氣元件。此元件可由內容作者新增至SPA。使用AEM對話方塊，作者可以設定天氣顯示的位置。此元件的實作說明建立與AEM SPA Editor架構相容的淨新AEM元件所需的步驟。

設定開放天氣元件

必備條件

檢閱設定「」所需的工具和指示本機開發環境. 本章是導覽與路由不過，您唯一需要遵循的章節是部署到本機SPA執行個體且已啟用AEM的AEM專案。

開啟天氣API金鑰

來自的API金鑰開放天氣，連同教學課程一起提供。免費註冊有限數量的API呼叫。

定義AEM元件

AEM元件定義為節點和屬性。在專案中，這些節點和屬性在 ui.apps 模組。接下來，在中建立AEM元件 ui.apps 模組。

注意

上的快速重新整理 AEM元件的基本知識可能會有所幫助.

在您選擇的IDE中，開啟 ui.apps 資料夾。
導覽至 ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/components 並建立名為的新資料夾 open-weather.

建立名為的新檔案 .content.xml 在 open-weather 資料夾。填入 open-weather/.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="Open Weather"
    componentGroup="WKND SPA React - Content"/>

建立自訂元件定義

jcr:primaryType="cq:Component" — 識別此節點是AEM元件。

jcr:title 是顯示給內容作者的值，而且 componentGroup 決定編寫UI中的元件分組。

在 custom-component 資料夾，建立另一個名為的資料夾 _cq_dialog.

在 _cq_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="Open Weather"
    sling:resourceType="cq/gui/components/authoring/dialog">
    <content
        jcr:primaryType="nt:unstructured"
        sling:resourceType="granite/ui/components/coral/foundation/container">
        <items jcr:primaryType="nt:unstructured">
            <tabs
                jcr:primaryType="nt:unstructured"
                sling:resourceType="granite/ui/components/coral/foundation/tabs"
                maximized="{Boolean}true">
                <items jcr:primaryType="nt:unstructured">
                    <properties
                        jcr:primaryType="nt:unstructured"
                        jcr:title="Properties"
                        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">
                                            <label
                                                jcr:primaryType="nt:unstructured"
                                                sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
                                                fieldDescription="The label to display for the component"
                                                fieldLabel="Label"
                                                name="./label"/>
                                            <lat
                                                jcr:primaryType="nt:unstructured"
                                                sling:resourceType="granite/ui/components/coral/foundation/form/numberfield"
                                                fieldDescription="The latitude of the location."
                                                fieldLabel="Latitude"
                                                step="any"
                                                name="./lat" />
                                            <lon
                                                jcr:primaryType="nt:unstructured"
                                                sling:resourceType="granite/ui/components/coral/foundation/form/numberfield"
                                                fieldDescription="The longitude of the location."
                                                fieldLabel="Longitude"
                                                step="any"
                                                name="./lon"/>
                                        </items>
                                    </column>
                                </items>
                            </columns>
                        </items>
                    </properties>
                </items>
            </tabs>
        </items>
    </content>
</jcr:root>

自訂元件定義

上述XML檔案會為以下專案產生一個非常簡單的對話方塊： Weather Component. 檔案的關鍵部分是內部 <label>， <lat> 和 <lon> 節點。此對話方塊包含兩個 numberfields和a textfield 這可讓使用者設定要顯示的天氣。

接著會建立Sling模型，以公開 label，lat 和 long 屬性透過JSON模型。

注意

您可以檢視更多專案透過檢視核心元件定義建立對話方塊的範例. 您也可以檢視其他表單欄位，例如 select， textarea， pathfield，可在下方取得 /libs/granite/ui/components/coral/foundation/form 在 CRXDE-Lite.

使用傳統AEM元件、一個 HTL 通常需要指令碼。由於SPA會轉譯元件，因此不需要HTL指令碼。

建立Sling模型

Sling模型是註解導向的Java「POJO」（純舊的Java物件），有助於將資料從JCR對應到Java變數。 Sling模型通常會用來封裝AEM元件的複雜伺服器端商業邏輯。

在SPA編輯器的內容中，Sling模型會使用透過JSON模型透過功能公開元件的內容。 Sling模型匯出工具.

在您選擇的IDE中，開啟 core 模組在 aem-guides-wknd-spa.react/core.
建立名為的檔案，位置為 OpenWeatherModel.java 於 core/src/main/java/com/adobe/aem/guides/wkndspa/react/core/models.

填入 OpenWeatherModel.java ，其功能如下：

package com.adobe.aem.guides.wkndspa.react.core.models;

import com.adobe.cq.export.json.ComponentExporter;

// Sling Models intended to be used with SPA Editor must extend ComponentExporter interface
public interface OpenWeatherModel extends ComponentExporter {
    public String getLabel();
    public double getLat();
    public double getLon();
}

這是元件的Java介面。為了讓Sling模型與SPA Editor架構相容，它必須擴展 ComponentExporter 類別。

建立名為的資料夾 impl 下 core/src/main/java/com/adobe/aem/guides/wkndspa/react/core/models.

建立名為的檔案 OpenWeatherModelImpl.java 下 impl 並填入下列專案：

package com.adobe.aem.guides.wkndspa.react.core.models.impl;

import org.apache.sling.models.annotations.*;
import org.apache.sling.models.annotations.injectorspecific.ValueMapValue;
import com.adobe.cq.export.json.ComponentExporter;
import com.adobe.cq.export.json.ExporterConstants;
import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import com.adobe.aem.guides.wkndspa.react.core.models.OpenWeatherModel;

// Sling Model annotation
@Model(
    adaptables = SlingHttpServletRequest.class,
    adapters = { OpenWeatherModel.class, ComponentExporter.class },
    resourceType = OpenWeatherModelImpl.RESOURCE_TYPE,
    defaultInjectionStrategy = DefaultInjectionStrategy.OPTIONAL
)
@Exporter( //Exporter annotation that serializes the modoel as JSON
    name = ExporterConstants.SLING_MODEL_EXPORTER_NAME,
    extensions = ExporterConstants.SLING_MODEL_EXTENSION
)
public class OpenWeatherModelImpl implements OpenWeatherModel {

    @ValueMapValue
    private String label; //maps variable to jcr property named "label" persisted by Dialog

    @ValueMapValue
    private double lat; //maps variable to jcr property named "lat"

    @ValueMapValue
    private double lon; //maps variable to jcr property named "lon"

    // points to AEM component definition in ui.apps
    static final String RESOURCE_TYPE = "wknd-spa-react/components/open-weather";

    // public getter method to expose value of private variable `label`
    // adds additional logic to default the label to "(Default)" if not set.
    @Override
    public String getLabel() {
        return StringUtils.isNotBlank(label) ? label : "(Default)";
    }

    // public getter method to expose value of private variable `lat`
    @Override
    public double getLat() {
        return lat;
    }

    // public getter method to expose value of private variable `lon`
    @Override
    public double getLon() {
        return lon;
    }

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

靜態變數 RESOURCE_TYPE 必須指向中的路徑 ui.apps 元件的。此 getExportedType() 用於透過以下方式將JSON屬性對應至SPA元件 MapTo. @ValueMapValue 是讀取對話方塊儲存之jcr屬性的註解。

更新SPA

接下來，更新React程式碼以包含 React Open Weather元件並將其對應至在先前步驟中建立的AEM元件。

將React Open Weather元件安裝為 npm 相依性：

$ cd aem-guides-wknd-spa.react/ui.frontend
$ npm i react-open-weather

建立名為的新資料夾 OpenWeather 於 ui.frontend/src/components/OpenWeather.

新增名為的檔案 OpenWeather.js 並填入下列內容：

import React from 'react';
import {MapTo} from '@adobe/aem-react-editable-components';
import ReactWeather, { useOpenWeather } from 'react-open-weather';

// Open weather API Key
// For simplicity it is hard coded in the file, ideally this is extracted in to an environment variable
const API_KEY = 'YOUR_API_KEY';

// Logic to render placeholder or component
const OpenWeatherEditConfig = {

    emptyLabel: 'Weather',
    isEmpty: function(props) {
        return !props || !props.lat || !props.lon || !props.label;
    }
};

// Wrapper function that includes react-open-weather component
function ReactWeatherWrapper(props) {
    const { data, isLoading, errorMessage } = useOpenWeather({
        key: API_KEY,
        lat: props.lat, // passed in from AEM JSON
        lon: props.lon, // passed in from AEM JSON
        lang: 'en',
        unit: 'imperial', // values are (metric, standard, imperial)
    });

    return (
        <div className="cmp-open-weather">
            <ReactWeather
                isLoading={isLoading}
                errorMessage={errorMessage}
                data={data}
                lang="en"
                locationLabel={props.label} // passed in from AEM JSON
                unitsLabels={{ temperature: 'F', windSpeed: 'mph' }}
                showForecast={false}
              />
        </div>
    );
}

export default function OpenWeather(props) {

        // render nothing if component not configured
        if (OpenWeatherEditConfig.isEmpty(props)) {
            return null;
        }

        // render ReactWeather component if component configured
        // pass props to ReactWeatherWrapper. These props include the mapped properties from AEM JSON
        return ReactWeatherWrapper(props);

}

// Map OpenWeather to AEM component
MapTo('wknd-spa-react/components/open-weather')(OpenWeather, OpenWeatherEditConfig);

更新 import-components.js 於 ui.frontend/src/components/import-components.js 以包含 OpenWeather 元件：

  // import-component.js
  import './Container/Container';
  import './ExperienceFragment/ExperienceFragment';
+ import './OpenWeather/OpenWeather';

使用您的Maven技能，從專案目錄的根將所有更新部署到本機AEM環境：
```
$ cd aem-guides-wknd-spa.react
$ mvn clean install -PautoInstallSinglePackage
```

更新範本原則

接下來，導覽至AEM以驗證更新，並允許 OpenWeather 要新增至SPA的元件。

透過瀏覽至以下位置，驗證新Sling模型的註冊： http://localhost:4502/system/console/status-slingmodels.

com.adobe.aem.guides.wkndspa.react.core.models.impl.OpenWeatherModelImpl - wknd-spa-react/components/open-weather

com.adobe.aem.guides.wkndspa.react.core.models.impl.OpenWeatherModelImpl exports 'wknd-spa-react/components/open-weather' with selector 'model' and extension '[Ljava.lang.String;@2fd80fc5' with exporter 'jackson'

您應該會看到上面兩行，指出 OpenWeatherModelImpl 已與 wknd-spa-react/components/open-weather 元件並透過Sling模型匯出工具註冊。

導覽至SPA頁面範本，網址為 http://localhost:4502/editor.html/conf/wknd-spa-react/settings/wcm/templates/spa-page-template/structure.html.
更新配置容器的原則以新增 Open Weather 作為允許的元件：

儲存對原則的變更，並觀察 Open Weather 作為允許的元件：

編寫開啟的天氣元件

接下來，編寫 Open Weather 元件使用AEM SPA編輯器。

導覽至 http://localhost:4502/editor.html/content/wknd-spa-react/us/en/home.html.
在 Edit 模式，新增 Open Weather 至 Layout Container：
開啟元件的對話方塊並輸入標籤，緯度、和經度. 例如 聖地亞哥， 32.7157、和 -117.1611. 使用Open Weather API將西半球和南半球的數字表示為負數

這是根據章節中先前的XML檔案建立的對話方塊。
儲存變更。觀察天氣 聖地亞哥 現在會顯示：
導覽至「」以檢視JSON模型 http://localhost:4502/content/wknd-spa-react/us/en.model.json. 搜尋 wknd-spa-react/components/open-weather:
```
"open_weather": {
    "label": "San Diego",
    "lat": 32.7157,
    "lon": -117.1611,
    ":type": "wknd-spa-react/components/open-weather"
}
```
Sling模型會輸出JSON值。這些JSON值會作為prop傳遞至React元件。

恭喜！

恭喜，您已瞭解如何建立要與AEM編輯器搭配使用的自訂SPA元件。您也學習了對話方塊、JCR屬性和Sling模型如何互動以輸出JSON模型。

後續步驟

擴充核心元件 — 瞭解如何擴充現有的AEM核心元件，以搭配AEM SPA Editor使用。瞭解如何將屬性和內容新增至現有元件，是擴充AEM SPA Editor實作功能的強大技術。

建立自訂天氣元件

目標

您將建置的內容

必備條件

開啟天氣API金鑰

定義AEM元件

建立Sling模型

更新SPA

更新範本原則

編寫開啟的天氣元件

恭喜！

後續步驟

Business.Adobe.com 資源

本頁內容

檢視下一個:

學習

檔案

社群

支援

資源

Adobe帳戶

Adobe