Creare un componente meteo personalizzato

Scopri come creare un componente meteo personalizzato da utilizzare con l’editor di SPA di AEM. Scopri come sviluppare le finestre di dialogo degli autori e i modelli Sling per estendere il modello JSON a un componente personalizzato. La API open Weather e Componente React Open Weather sono utilizzati.

Obiettivo

Comprendi il ruolo dei modelli Sling nella manipolazione dell’API del modello JSON fornita da AEM.
Scopri come creare nuove finestre di dialogo dei componenti AEM.
Scopri come creare un personalizzato Componente AEM compatibile con il framework dell’editor SPA.

Cosa verrà creato

Viene creato un semplice componente meteo. Questo componente può essere aggiunto al SPA dagli autori dei contenuti. Mediante una finestra di dialogo AEM, gli autori possono impostare la posizione del meteo da visualizzare. L’implementazione di questo componente illustra i passaggi necessari per creare un nuovo componente AEM netto compatibile con il framework dell’editor di SPA AEM.

Configurare il componente Tempo aperto

Prerequisiti

Rivedere gli strumenti e le istruzioni necessari per la configurazione di un ambiente di sviluppo locale. Il presente capitolo costituisce la continuazione del Navigazione e instradamento capitolo , tuttavia per seguire tutto ciò di cui hai bisogno è un progetto AEM abilitato per SPA distribuito in un’istanza AEM locale.

Chiave API per il clima aperto

Una chiave API da Tempo aperto è necessario seguire l’esercitazione. Iscriviti gratis per una quantità limitata di chiamate API.

Definire il componente AEM

Un componente AEM è definito come un nodo e proprietà. Nel progetto, questi nodi e proprietà sono rappresentati come file XML nel ui.apps modulo . Quindi, crea il componente AEM nel ui.apps modulo .

NOTA

Un aggiornamento rapido sul nozioni di base sui componenti AEM possono essere utili.

Nell’IDE che preferisci, apri le ui.apps cartella.
Passa a ui.apps/src/main/content/jcr_root/apps/wknd-spa-react/components e crea una nuova cartella denominata open-weather.
Crea un nuovo file denominato .content.xml sotto il open-weather cartella. Popolare open-weather/.content.xml con le seguenti caratteristiche:
```
<?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" - identifica che questo nodo è un componente AEM.

jcr:title è il valore visualizzato agli autori di contenuti e al componentGroup determina il raggruppamento di componenti nell’interfaccia utente di authoring.
Sotto custom-component cartella, creare un'altra cartella denominata _cq_dialog.

Sotto _cq_dialog creare un nuovo file denominato .content.xml e popolalo con i seguenti elementi:

<?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>

Definizione del componente personalizzato

Il file XML di cui sopra genera una finestra di dialogo molto semplice per Weather Component. La parte critica del file è l'interno <label>, <lat> e <lon> nodi. Questa finestra di dialogo contiene due numberfields e a textfield che consente all’utente di configurare il meteo da visualizzare.

Viene creato un modello Sling accanto a per esporre il valore del label,lat e long tramite il modello JSON.

NOTA

Puoi visualizzare molto di più esempi di finestre di dialogo visualizzando le definizioni dei componenti core. È inoltre possibile visualizzare campi modulo aggiuntivi, come select, textarea, pathfield, disponibile sotto /libs/granite/ui/components/coral/foundation/form in CRXDE-Lite.

Con un componente AEM tradizionale, un HTL in genere è richiesto uno script. Poiché il SPA eseguirà il rendering del componente, non è necessario alcuno script HTL.

Creare il modello Sling

I modelli Sling sono Java "POJO" (Plain Old Java Objects) basati su annotazioni che facilitano la mappatura dei dati da JCR alle variabili Java. Modelli Sling in genere funziona per incapsulare logiche aziendali complesse lato server per i componenti AEM.

Nel contesto dell’editor di SPA, i modelli Sling espongono il contenuto di un componente attraverso il modello JSON attraverso una funzione utilizzando Esportatore di modelli Sling.

Nell’IDE che preferisci, apri le core modulo a aem-guides-wknd-spa.react/core.
Crea un file denominato in OpenWeatherModel.java a core/src/main/java/com/adobe/aem/guides/wkndspa/react/core/models.

Popolare OpenWeatherModel.java con le seguenti caratteristiche:

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

Questa è l’interfaccia Java per il nostro componente. Affinché il nostro modello Sling sia compatibile con il framework dell'editor SPA, deve estendere il ComponentExporter classe.

Crea una cartella denominata impl sotto core/src/main/java/com/adobe/aem/guides/wkndspa/react/core/models.

Crea un file denominato OpenWeatherModelImpl.java sotto impl e si popolano i seguenti elementi:

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

La variabile statica RESOURCE_TYPE deve puntare al percorso in ui.apps del componente. La getExportedType() viene utilizzato per mappare le proprietà JSON al componente SPA tramite MapTo. @ValueMapValue è un’annotazione che legge la proprietà jcr salvata dalla finestra di dialogo.

Aggiornare il SPA

Quindi, aggiorna il codice React per includere il Componente React Open Weather e associalo al componente AEM creato nei passaggi precedenti.

Installa il componente React Open Weather come npm dipendenza:

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

Crea una nuova cartella denominata OpenWeather a ui.frontend/src/components/OpenWeather.

Aggiungi un file denominato OpenWeather.js e popolalo con i seguenti elementi:

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

Aggiorna import-components.js a ui.frontend/src/components/import-components.js per includere OpenWeather componente:

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

Distribuisci tutti gli aggiornamenti a un ambiente AEM locale dalla directory principale della directory di progetto, utilizzando le tue competenze Maven:
```
$ cd aem-guides-wknd-spa.react
$ mvn clean install -PautoInstallSinglePackage
```

Aggiornare i criteri dei modelli

Quindi, accedi a AEM per verificare gli aggiornamenti e consentire il OpenWeather da aggiungere al SPA.

Verifica la registrazione del nuovo modello Sling passando a 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'

Dovresti vedere le due righe precedenti che indicano il OpenWeatherModelImpl è associato al wknd-spa-react/components/open-weather e che è registrato tramite l’esportatore di modelli Sling.

Passa al modello di pagina SPA in http://localhost:4502/editor.html/conf/wknd-spa-react/settings/wcm/templates/spa-page-template/structure.html.
Aggiornare i criteri del Contenitore di layout per aggiungere il nuovo Open Weather come componente consentito:

Salva le modifiche al criterio e osserva il Open Weather come componente consentito:

Creare il componente Tempo aperto

Quindi, crea le Open Weather mediante l’editor SPA AEM.

Passa a http://localhost:4502/editor.html/content/wknd-spa-react/us/en/home.html.
In Edit aggiungi la Open Weather al Layout Container:
Apri la finestra di dialogo del componente e immetti un Etichetta, Latitudine e Longitudine. Esempio San Diego, 32,7157 e -117,1611. I numeri dell’emisfero occidentale e dell’emisfero australe sono rappresentati come numeri negativi con l’API del clima aperto

Questa è la finestra di dialogo creata in base al file XML precedente nel capitolo.
Salva le modifiche. Osserva che il tempo per San Diego viene ora visualizzato:
Visualizzare il modello JSON passando a http://localhost:4502/content/wknd-spa-react/us/en.model.json. Cerca wknd-spa-react/components/open-weather:
```
"open_weather": {
    "label": "San Diego",
    "lat": 32.7157,
    "lon": -117.1611,
    ":type": "wknd-spa-react/components/open-weather"
}
```
I valori JSON vengono generati dal modello Sling. Questi valori JSON vengono passati nel componente React come proprietà.

Congratulazioni!

Congratulazioni, hai imparato a creare un componente AEM personalizzato da utilizzare con l’editor di SPA. Hai anche imparato come le finestre di dialogo, le proprietà JCR e i modelli Sling interagiscono per generare il modello JSON.

Passaggi successivi

Estendere un componente core - Scopri come estendere un componente di base AEM esistente da utilizzare con l’editor di SPA AEM. Scopri come aggiungere proprietà e contenuto a un componente esistente è una tecnica potente per espandere le funzionalità di un’implementazione di AEM Editor SPA.

Creare un componente meteo personalizzato

Obiettivo

Cosa verrà creato

Prerequisiti

Chiave API per il clima aperto

Definire il componente AEM

Creare il modello Sling

Aggiornare il SPA

Aggiornare i criteri dei modelli

Creare il componente Tempo aperto

Congratulazioni!

Passaggi successivi

Risorse Business.Adobe.com

In questa pagina

Visualizza successivo:

Scopri

Documentazione

Community

Assistenza

Risorse

Account Adobe

Adobe