Web元件

上次更新: 2024-01-26
  • 建立對象:
  • Beginner
    Developer

AEM Headlessas a Cloud Service

範例應用程式是探索Adobe Experience Manager (AEM)無周邊功能的絕佳方式。 此Web元件應用程式示範了如何使用AEM GraphQL API透過持續查詢來查詢內容,以及如何轉譯UI的一部分(使用純JavaScript程式碼完成)。

具有AEM Headless的網頁元件

檢視 GitHub上的原始碼

先決條件

下列工具應在本機安裝:

AEM需求

Web元件可與下列AEM部署選項搭配使用。

此範例應用程式依賴 basic-tutorial-solution.content.zip 將安裝及所需的 部署設定 已準備就緒。

重要

Web元件的設計是要連線到 AEM發佈 不過,如果在網頁元件的中提供驗證,則它可以從AEM Author取得內容 person.js 檔案。

使用方式

  1. 原地複製 adobe/aem-guides-wknd-graphql 存放庫:

    $ git clone git@github.com:adobe/aem-guides-wknd-graphql.git
    
  2. 瀏覽至 web-component 子目錄。

    $ cd aem-guides-wknd-graphql/web-component
    
  3. 編輯 .../src/person.js 要包含AEM連線詳細資料的檔案:

    aemHeadlessService 物件,更新 aemHost 以指向您的AEM Publish服務。

    # 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
    

    如果連線到AEM Author服務,請在 aemCredentials 物件,提供本機AEM使用者認證。

    # For Basic auth, use AEM ['user','pass'] pair (for example, when connecting to local AEM Author instance)
    username=admin
    password=admin
    
  4. 開啟終端機並執行命令,從 aem-guides-wknd-graphql/web-component

    $ npm install
    $ npm start
    
  5. 新的瀏覽器視窗會開啟靜態HTML頁面,其中包含Web元件,位於 http://localhost:8080.

  6. 個人資訊 網頁元件會顯示在網頁上。

程式碼

以下摘要說明如何建立Web元件、元件如何連線至AEM Headless以使用GraphQL持續查詢擷取內容,以及資料如何呈現。 完整的程式碼可在上找到 GitHub.

網頁元件HTML標籤

可重複使用的Web元件(亦稱為自訂元素) <person-info> 新增至 ../src/assets/aem-headless.html HTML頁面。 它支援 hostquery-param-value 屬性來驅動元件的行為。 此 host 屬性的值覆寫 aemHost 值來自 aemHeadlessService 中的物件 person.js、和 query-param-value 用於選取要呈現的人員。

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

Web元件實施

person.js 會定義Web元件功能,以下是其中的主要重點專案。

PersonInfo元素實作

<person-info> 自訂元素的類別物件會使用 connectedCallback() 生命週期方法、附加陰影根目錄、擷取GraphQL持續查詢和DOM操作,以建立自訂元素的內部陰影DOM結構。

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

註冊 <person-info> 元素

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

跨原始資源共用(CORS)

此Web元件需仰賴在目標AEM環境中執行的AEM型CORS設定,並假設主機頁面執行於 http://localhost:8080 在開發模式及以下為本機AEM Author服務的CORS OSGi設定範例。

請檢閱 部署設定 適用於個別AEM服務。

本頁內容