Componente Web

Ultimo aggiornamento: 2024-01-26
  • Argomenti:
  • Content Fragments
    Visualizza ulteriori informazioni su questo argomento
  • GraphQL API
    Visualizza ulteriori informazioni su questo argomento
  • Creato per:
  • Beginner
    Developer

AEM headless as a Cloud Service

Le applicazioni di esempio sono un ottimo modo per esplorare le funzionalità headless di Adobe Experience Manager (AEM). Questa applicazione per componenti web illustra come eseguire query sui contenuti che utilizzano le API GraphQL dell’AEM utilizzando query persistenti ed eseguire il rendering di una parte dell’interfaccia utente, utilizzando esclusivamente codice JavaScript.

Componente web con AEM headless

Visualizza codice sorgente su GitHub

Prerequisiti

I seguenti strumenti devono essere installati localmente:

Requisiti AEM

Il componente Web funziona con le seguenti opzioni di distribuzione AEM.

  • AEM as a Cloud Service
  • Configurazione locale con l’SDK di AEM Cloud Service
    • Richiede [JDK 11](https://experience.adobe.com/#/downloads/content/software-distribution/en/general.html?1_group.propertyvalues.property=.%2Fjcr%3Acontent%2Fmetadata%2Fdc%3AsoftwareType&1_group.propertyvalues.operation=equals&1_group.propertyvalues.0_values=tipo di software%3Atooling&fulltext=Oracle%7E+JDK%7E+11%7E&orderby=%40jcr%3Acontent%2Fjcr%3AlastModified&orderby.sort=desc&layout=list&p.offset=0&p.limit=14) (se ci si connette a AEM 6.5 locale o a AEM SDK)

L’app di esempio si basa su basic-tutorial-solution.content.zip da installare e la funzionalità configurazioni di implementazione sono al loro posto.

IMPORTANTE

Il componente Web è progettato per connettersi a un Pubblicazione AEM Tuttavia, può originare il contenuto da AEM Author se l’autenticazione viene fornita nel file del componente Web person.js file.

Come usare

  1. Clona il adobe/aem-guides-wknd-graphql archivio:

    $ git clone git@github.com:adobe/aem-guides-wknd-graphql.git
    
  2. Accedi a web-component sottodirectory.

    $ cd aem-guides-wknd-graphql/web-component
    
  3. Modifica il .../src/person.js file per includere i dettagli di connessione AEM:

    In aemHeadlessService oggetto, aggiorna aemHost per puntare al servizio di pubblicazione AEM.

    # AEM Server namespace
    aemHost=https://publish-p123-e456.adobeaemcloud.com
    
    # AEM GraphQL API and Persisted Query Details
    graphqlAPIEndpoint=graphql/execute.json
    projectName=my-project
    persistedQueryName=person-by-name
    queryParamName=name
    

    Se ci si connette a un servizio di creazione AEM, nel aemCredentials , fornire le credenziali utente AEM locali.

    # For Basic auth, use AEM ['user','pass'] pair (for example, when connecting to local AEM Author instance)
    username=admin
    password=admin
    
  4. Apri un terminale ed esegui i comandi da aem-guides-wknd-graphql/web-component:

    $ npm install
    $ npm start
    
  5. Una nuova finestra del browser apre la pagina HTML statica che incorpora il componente Web in http://localhost:8080.

  6. Il Informazioni persona Il componente Web viene visualizzato nella pagina Web.

Il codice

Di seguito è riportato un riepilogo della modalità di creazione del componente Web, della modalità di connessione a headless AEM per il recupero di contenuti tramite query persistenti GraphQL e della modalità di presentazione dei dati. Il codice completo è disponibile su GitHub.

Tag HTML del componente Web

Un componente web riutilizzabile (o elemento personalizzato) <person-info> viene aggiunto al ../src/assets/aem-headless.html pagina HTML. Supporta host e query-param-value attributi per determinare il comportamento del componente. Il host sostituzioni di valore dell'attributo aemHost valore da aemHeadlessService oggetto in person.js, e query-param-value viene utilizzato per selezionare la persona da riprodurre.

    <person-info
        host="https://publish-p123-e456.adobeaemcloud.com"
        query-param-value="John Doe">
    </person-info>

Implementazione del componente web

Il person.js definisce la funzionalità del componente Web e di seguito sono riportate le principali caratteristiche salienti.

Implementazione dell’elemento PersonInfo

Il <person-info> l'oggetto class dell'elemento personalizzato definisce la funzionalità utilizzando connectedCallback() metodi del ciclo di vita, associazione di una radice dell'ombra, recupero di query persistenti di GraphQL e manipolazione DOM per creare la struttura DOM dell'ombra interna dell'elemento personalizzato.

// Create a Class for our Custom Element (person-info)
class PersonInfo extends HTMLElement {

    constructor() {
        ...
        // Create a shadow root
        const shadowRoot = this.attachShadow({ mode: "open" });
        ...
    }

    ...

    // lifecycle callback :: When custom element is appended to document
    connectedCallback() {
        ...
        // Fetch GraphQL persisted query
        this.fetchPersonByNamePersistedQuery(headlessAPIURL, queryParamValue).then(
            ({ data, err }) => {
                if (err) {
                    console.log("Error while fetching data");
                } else if (data?.personList?.items.length === 1) {
                    // DOM manipulation
                    this.renderPersonInfoViaTemplate(data.personList.items[0], host);
                } else {
                    console.log(`Cannot find person with name: ${queryParamValue}`);
                }
            }
        );
    }

    ...

    //Fetch API makes HTTP GET to AEM GraphQL persisted query
    async fetchPersonByNamePersistedQuery(headlessAPIURL, queryParamValue) {
        ...
        const response = await fetch(
            `${headlessAPIURL}/${aemHeadlessService.persistedQueryName}${encodedParam}`,
            fetchOptions
        );
        ...
    }

    // DOM manipulation to create the custom element's internal shadow DOM structure
    renderPersonInfoViaTemplate(person, host){
        ...
        const personTemplateElement = document.getElementById('person-template');
        const templateContent = personTemplateElement.content;
        const personImgElement = templateContent.querySelector('.person_image');
        personImgElement.setAttribute('src',
            host + (person.profilePicture._dynamicUrl || person.profilePicture._path));
        personImgElement.setAttribute('alt', person.fullName);
        ...
        this.shadowRoot.appendChild(templateContent.cloneNode(true));
    }
}

Registra il <person-info> elemento

    // Define the person-info element
    customElements.define("person-info", PersonInfo);

Condivisione delle risorse tra le origini (CORS)

Questo componente web si basa su una configurazione CORS basata su AEM in esecuzione nell’ambiente AEM di destinazione e presuppone che la pagina host venga eseguita su http://localhost:8080 in modalità di sviluppo e di seguito è riportato un esempio di configurazione CORS OSGi per il servizio AEM Author locale.

Rivedi configurazioni di implementazione per i rispettivi servizi AEM.

In questa pagina