適用於AEM開發人員的通用編輯器總覽 developer-overview

如果您是AEM開發人員,且對Universal Editor的運作方式及如何在您的專案中使用它感興趣,本檔案將引導您檢測WKND專案以使用Universal Editor,為您提供端對端的簡介。

用途 purpose

本檔案將以開發人員的身分,介紹通用編輯器的運作方式,以及如何檢測您的應用程式如何搭配此編輯器運作。

其做法是透過大多數AEM開發人員熟悉的標準範例、核心元件和WKND網站,並裝備一些可使用通用編輯器編輯的範例元件。

TIP
本檔案採取額外步驟說明通用編輯器的運作方式,旨在加深開發人員對編輯器的瞭解。 因此,它不會採取最直接的方式檢測應用程式,而是採用最能說明通用編輯器及其運作方式的方式。
如果您想要儘快啟動並執行,請參閱 AEM中的通用編輯器快速入門 檔案。

先決條件 prerequisites

若要遵循本概述,您需要下列可用專案。

除了對Web開發的一般熟悉以外,本檔案假設您對AEM開發具有基本的熟悉。 如果您沒有開發AEM的經驗,請考慮檢閱 wknd教學課程,然後再繼續。

啟動AEM並登入通用編輯器 sign-in

如果您尚未安裝,則必須安裝本機AEM開發執行個體,並啟用HTTPS,作為 先決條件中有詳細說明。 此概觀假設您的執行個體執行於 https://localhost:8443.

  1. 在AEM編輯器中開啟WKND英文主版頁面。

    code language-text
    https://localhost:8443/editor.html/content/wknd/language-masters/en.html
    
  2. 頁面資訊 編輯器的功能表,選取 以發佈的形式檢視. 這會在停用AEM編輯器的新標籤中開啟相同頁面。

    code language-text
    https://localhost:8443/content/wknd/language-masters/en.html?wcmmode=disabled
    
  3. 複製此連結。

  4. 現在請登入通用編輯器。

    code language-text
    https://experience.adobe.com/#/aem/editor
    
  5. 將您先前複製的WKND內容連結貼到 網站URL 欄位並按一下 開啟.

    在通用編輯器中開啟WKND頁面

Universal Editor嘗試載入內容 sameorigin

Universal Editor會載入要在框架中編輯的內容。 X-Frame選項的AEM預設設定可防止此情況,在瀏覽器中可清楚看到此錯誤,並在嘗試載入您的WKND本機副本時,在主控台輸出中詳細說明。

SAMEORIGIN選項造成的瀏覽器錯誤

X-Frame選項 sameorigin 防止在框架中呈現AEM頁面。 您必須移除此標頭,才能讓頁面載入通用編輯器中。

  1. 開啟Configuration Manager。

    code language-text
    https://localhost:8443/system/console/configMgr
    
  2. 編輯OSGi設定 org.apache.sling.engine.impl.SlingMainServlet

    SAMEORIGIN的OSGi屬性

  3. 刪除屬性 X-Frame-Options=SAMEORIGIN 屬性的 其他回應標頭.

  4. 儲存變更。

現在,如果您重新載入通用編輯器,您會看到AEM頁面已載入。

TIP

處理相同網站Cookie samesite-cookies

當通用編輯器載入您的頁面時,它會載入到AEM登入頁面,以確保您通過驗證可進行變更。

不過,您無法成功登入。 顯示瀏覽器主控台,您會看到瀏覽器已封鎖框架上的輸入

輸入已封鎖

登入權杖Cookie會作為協力廠商網域傳送給AEM。 因此,AEM中必須允許相同網站的Cookie。

  1. 開啟Configuration Manager。

    code language-text
    https://localhost:8443/system/console/configMgr
    
  2. 編輯OSGi設定 com.day.crx.security.token.impl.impl.TokenAuthenticationHandler

    相同網站Cookie的OSGi屬性

  3. 變更屬性 登入權杖cookie的SameSite屬性None.

  4. 儲存變更。

現在,如果您重新載入通用編輯器,您可以成功登入AEM並載入您的目標頁面。

TIP

Universal Editor連線到遠端框架 ue-connect-remote-frame

頁面載入通用編輯器並登入AEM後,通用編輯器會嘗試連線到遠端框架。 這是透過必須載入遠端框架的JavaScript程式庫完成的。 如果JavaScript程式庫不存在,頁面最終會在主控台中建立逾時錯誤。

逾時錯誤

您必須將必要的JavaScript程式庫新增到WKND應用程式的頁面元件中。

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. /apps/wknd/components/page,編輯檔案 customheaderlibs.html.

    編輯customheaderlibs.html檔案

  3. 將JavaScript程式庫新增至檔案結尾。

    code language-html
    <script src="https://universal-editor-service.experiencecloud.live/corslib/LATEST"></script>
    
  4. 按一下 全部儲存 然後重新載入通用編輯器。

頁面現在會使用適當的JavaScript程式庫載入,以允許Universal Editor連線至您的頁面,而逾時錯誤不再出現在主控台中。

TIP
  • 程式庫可載入頁首或頁尾。
  • universal-editor-embedded.js 資料庫 可在NPM取得 而且您可以視需要自行託管,或將其直接放入您的應用程式中。

定義連線以保留變更 connection

WKND頁面現在會在通用編輯器中成功載入,且JavaScript程式庫會載入,以將編輯器連線至您的應用程式。

不過,您可能會注意到您無法與通用編輯器中的頁面互動。 通用編輯器無法實際編輯您的頁面。 為了讓Universal Editor能夠編輯您的內容,您需要定義連線,使其知道在哪裡寫入內容。 對於本機開發,您需要將寫回至您本機AEM開發執行個體,網址為 https://localhost:8443.

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. /apps/wknd/components/page,編輯檔案 customheaderlibs.html.

    編輯customheaderlibs.html檔案

  3. 將連線至本機AEM執行個體的必要中繼資料新增至檔案結尾。

    code language-html
    <meta name="urn:adobe:aue:system:aem" content="aem:https://localhost:8443">
    
  4. 將連線至本機Universal Editor服務的必要中繼資料新增至檔案結尾。

    code language-html
    <meta name="urn:adobe:aue:config:service" content="https://localhost:8000">
    
  5. 按一下 全部儲存 然後重新載入通用編輯器。

現在,Universal Editor不僅可以從您本機的AEM開發執行個體成功載入您的內容,而且會知道要將您使用本機的Universal Editor服務所做的任何變更儲存在何處。 這是測試應用程式以使用通用編輯器可編輯的第一步。

TIP

檢測元件 instrumenting-components

不過,您可能會注意到您仍然可以對Universal Editor執行一些工作。 如果您嘗試按一下通用編輯器中WKND頁面頂端的Teaser,您實際上無法選取它(或頁面上的其他內容)。

您的元件也必須檢測為可使用通用編輯器進行編輯。 若要這麼做,您必須編輯Teaser元件。 因此,您必須覆蓋核心元件,因為核心元件位於 /libs,此專案不可變動。

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. 選取節點 /libs/core/wcm/components 並按一下 覆蓋節點 (在工具列上)。

  3. 替換為 /apps/ 已選取作為 覆蓋位置,按一下 確定.

    覆蓋Teaser

  4. 選取 teaser 節點在 /libs/core/wcm/components 並按一下 複製 (在工具列中)。

  5. 選取重疊的節點,在 /apps/core/wcm/components 並按一下 貼上 (在工具列中)。

  6. 按兩下檔案 /apps/core/wcm/components/teaser/v2/teaser/teaser.html 以編輯它。

    編輯teaser.html檔案

  7. 在第一個 div 在第26行左右,新增元件的檢測詳細資料。

    code language-text
    data-aue-resource="urn:aem:${resource.path}"
    data-aue-type="component"
    data-aue-label="Teaser"
    
  8. 按一下 全部儲存 並重新載入通用編輯器。

  9. 在通用編輯器中,按一下頁面頂端的Teaser元件,檢視您現在可以選取它。

  10. 如果您按一下 內容樹狀結構 圖示在Universal Editor的屬性邊欄中,您會看到編輯器已辨識出頁面上所有的Teaser,您已加以檢測。 您選取的Teaser是反白顯示的。

    選取檢測的Teaser元件

TIP
檢視檔案 在Adobe Experience Manager as a Cloud Service中使用Sling Resource Merger 以取得重疊節點的詳細資訊。

Teaser的儀器子元件 subcomponents

您現在可以選取Teaser,但仍不可編輯。 這是因為Teaser是不同元件(例如影像和標題元件)的組合。 您必須檢測這些子元件才能進行編輯。

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. 選取節點 /apps/core/wcm/components/teaser/v2/teaser/ 並連按兩下 title.html 檔案。

    編輯title.html檔案

  3. 在結尾處插入下列屬性 h2 標籤(在第17行附近)。

    code language-text
    data-aue-prop="jcr:title"
    data-aue-type="text"
    data-aue-label="Title"
    
  4. 按一下 全部儲存 並重新載入通用編輯器。

  5. 按一下頁面頂端相同Teaser元件的標題,檢視您現在可以選取它。 內容樹狀結構也會將標題顯示為所選Teaser元件的一部分。

    在Teaser中選取標題

您現在可以編輯Teaser元件的標題!

這是什麼意思? what-does-it-mean

現在您可以編輯Teaser的標題,讓我們花點時間檢閱您已完成的作業及操作方式。

您已透過檢測來向通用編輯器識別Teaser元件。

  • data-aue-resource 會識別AEM中正在編輯的資源。
  • data-aue-type 定義應將專案視為頁面元件(而非容器)。
  • data-aue-label 在選定Teaser的UI中顯示使用者易記標籤。

您也已在Teaser元件中檢測標題元件。

  • data-aue-prop 是寫入的JCR屬性。
  • data-aue-type 是應如何編輯屬性的方式。 在這種情況下,請使用文字編輯器,因為它是標題(相對於RTF編輯器)。

定義驗證標頭 auth-header

現在您可以編輯Teaser內嵌的標題,且變更會保留在瀏覽器中。

已編輯的Teaser標題

但是,如果您重新載入瀏覽器,則會重新載入前一個標題。 這是因為,雖然通用編輯器知道如何連線到您的AEM執行個體,但它無法驗證您的AEM執行個體以回寫對JCR的變更。

如果您顯示瀏覽器開發人員工具的網路標籤並搜尋 update,您會發現嘗試編輯標題時發生401錯誤。

嘗試編輯標題時發生錯誤

使用通用編輯器編輯您的生產AEM內容時,通用編輯器使用您用來登入編輯器的IMS權杖來驗證AEM,以方便回寫至JCR。

當您在本機開發時,無法使用AEM身分提供者,因為IMS權杖只會傳遞給Adobe擁有的網域。 您需要透過明確設定驗證標題來手動提供驗證方法。

  1. 在通用編輯器介面中,按一下 驗證標頭 圖示加以儲存。

  2. 複製必要的驗證標題以驗證您的本機AEM執行個體,然後按一下 儲存.

    設定驗證標頭

  3. 重新載入通用編輯器,現在編輯Teaser的標題。

瀏覽器主控台中不再報告任何錯誤,且變更會保留回您的本機AEM開發執行個體。

如果您在瀏覽器開發人員工具中調查流量,並尋找 update 事件中,您可以檢視更新的詳細資訊。

已成功編輯Teaser標題

{
  "connections": [
    {
      "name": "aem",
      "protocol": "aem",
      "uri": "https://localhost:8443"
    }
  ],
  "target": {
    "resource": "urn:aem:/content/wknd/language-masters/en/jcr:content/root/container/carousel/item_1571954853062",
    "type": "text",
    "prop": "jcr:title"
  },
  "value": "Tiny Toon Adventures"
}
  • connections 是與本機AEM執行個體的連線
  • target 是在JCR中更新的確切節點和屬性
  • value 是您所做的更新。

您可以在JCR中看到持續存在的變更。

JCR中的更新

TIP
有許多線上工具可產生必要的驗證標頭,以用於您的測試和開發用途。
基本驗證標頭範例 Basic YWRtaW46YWRtaW4= 用於使用者/密碼組合 admin:admin 在本機AEM開發中很常見。

為屬性邊欄檢測應用程式 properties-rail

現在,您有一個應用程式,經檢測可以使用通用編輯器進行編輯!

編輯目前僅限於Teaser標題的內嵌編輯。 但是,在某些情況下,就地編輯並不足夠。 在鍵盤輸入所在的位置可以編輯Teaser標題等文字。 不過,更複雜的專案必須能夠顯示並允許編輯結構化資料,而不需將其呈現在瀏覽器中。 這是屬性邊欄的用途。

若要更新應用程式以使用屬性邊欄進行編輯,請返回應用程式頁面元件的標題檔案。 這是您已建立與本機AEM開發執行個體和本機Universal Editor服務之連線的位置。 您必須在此處定義可在應用程式中編輯的元件及其資料模型。

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. /apps/wknd/components/page,編輯檔案 customheaderlibs.html.

    編輯customheaderlibs.html檔案

  3. 在檔案的結尾處新增定義元件所需的指令碼。

    code language-html
    <script type="application/vnd.adobe.aue.component+json">
    {
      "groups": [
        {
          "title": "General Components",
          "id": "general",
          "components": [
            {
              "title": "Teaser",
              "id": "teaser",
              "plugins": {
                "aem": {
                  "page": {
                    "resourceType": "wknd/components/teaser"
                  }
                }
              }
            },
            {
              "title": "Title",
              "id": "title",
              "plugins": {
                "aem": {
                  "page": {
                    "resourceType": "wknd/components/title"
                  }
                }
              }
            }
          ]
        }
      ]
    }
    </script>
    
  4. 在其下方,在檔案的結尾處新增定義模型所需的指令碼。

    code language-html
    <script type="application/vnd.adobe.aue.model+json">
    [
      {
        "id": "teaser",
        "fields": [
          {
            "component": "text-input",
            "name": "jcr:title",
            "label": "Title",
            "valueType": "string"
          },
          {
            "component": "text-area",
            "name": "jcr:description",
            "label": "Description",
            "valueType": "string"
          }
        ]
      },
      {
        "id": "title",
        "fields": [
          {
            "component": "select",
            "name": "type",
            "value": "h1",
            "label": "Type",
            "valueType": "string",
            "options": [
              { "name": "h1", "value": "h1" },
              { "name": "h2", "value": "h2" },
              { "name": "h3", "value": "h3" },
              { "name": "h4", "value": "h4" },
              { "name": "h5", "value": "h5" },
              { "name": "h6", "value": "h6" }
            ]
          }
        ]
      }
    ]
    </script>
    
  5. 按一下 全部儲存 (在工具列中)。

這是什麼意思? what-does-it-mean-2

若要使用屬性邊欄進行編輯,必須將元件指派給 groups,因此每個定義都會以包含元件的群組清單開始。

  • title 是群組的名稱。
  • id 是群組的唯一識別碼,在此案例中是組成頁面內容的一般元件,而不是頁面配置的進階元件。

然後,每個群組都有一個陣列 components.

  • title 是元件的名稱。
  • id 是元件的唯一識別碼,在此案例中是Teaser。

然後,每個元件都有外掛程式定義,可定義如何將元件對應至AEM。

  • aem 是處理編輯的外掛程式。 這可以視為處理元件的服務。
  • page 會定義元件型別,在此案例中是標準頁面元件。
  • resourceType 是實際AEM元件的對應。

然後,每個元件都必須對應至 model 以定義個別可編輯欄位。

  • id 是模式的唯一識別碼,必須符合元件的ID。
  • fields 是個別欄位的陣列。
  • component 是輸入型別,例如文字或文字區域。
  • name 是欄位對應的JCR中的欄位名稱。
  • label 是出現在編輯器UI中的欄位說明。
  • valueType 是資料型別。

為屬性邊欄檢測元件 properties-rail-component

您還需要在元件層級定義元件應使用的模型。

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. 按兩下檔案 /apps/core/wcm/components/teaser/v2/teaser/teaser.html 以編輯它。

    編輯teaser.html檔案

  3. 在第一個 div 大約在第32行,在您先前新增的屬性之後,新增Teaser元件將使用的模型的instrumentation詳細資訊。

    code language-text
    data-aue-model="teaser"
    
  4. 按一下 全部儲存 並重新載入通用編輯器。

現在您已準備好測試針對元件所檢測的屬性邊欄。

  1. 在通用編輯器中,按一下Teaser的標題以再次編輯。

  2. 按一下屬性邊欄以顯示屬性標籤,並檢視您剛才檢測的欄位。

    檢測的屬性邊欄

您現在可以像之前一樣內嵌編輯Teaser標題,或在屬性邊欄中編輯。 在這兩種情況下,變更會保留回本機AEM開發執行個體。

新增其他欄位至屬性邊欄 add-fields

使用已實作之元件的資料模型基本結構,可以依照相同模型新增其他欄位。

例如,您可以新增欄位來調整元件的樣式。

  1. 開啟 CRXDE Lite。

    code language-text
    https://localhost:8443/crx/de
    
  2. /apps/wknd/components/page,編輯檔案 customheaderlibs.html.

    編輯customheaderlibs.html檔案

  3. 在模型定義指令碼中,新增其他專案至 fields 樣式欄位的陣列。 插入新欄位之前,請記得在最後一個欄位後面加上逗號。

    code language-json
    {
       "component": "select",
       "name": "cq:styleIds",
       "label": "Style",
       "valueType": "string",
         "multi": true,
       "options": [
         {"name": "hero", "value":"1555543212672"},
         {"name": "card", "value":"1605057868937"}
       ]
    }
    
  4. 按一下 全部儲存 並重新載入通用編輯器。

  5. 按一下Teaser的標題可再次編輯。

  6. 按一下「屬性」邊欄,檢視是否有新欄位可調整元件的樣式。

    具樣式欄位的儀器屬性邊欄

可透過此方式在Universal Editor中公開元件JCR中的任何欄位。

摘要 summary

恭喜!現在您可以檢測自己的AEM應用程式,以便使用通用編輯器。

當您開始檢測自己的應用程式時,請牢記您在本範例中執行的基本步驟。

您可以依照這些相同步驟來檢測您自己的應用程式,以便與通用編輯器搭配使用。 JCR中的任何屬性都可以向通用編輯器公開。

其他資源 additional-resources

請參閱下列檔案,瞭解通用編輯器功能的詳細資訊和詳細資訊。

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab