開發AEM元件

AEM元件可用來封存、格式化和轉譯網頁上提供的內容。

  • 編寫頁面時,元件可讓作者編輯和設定內容。

    • 當構建Commerce站點時,元件可以收集和呈現目錄中的資訊。
      如需詳細資訊,請參閱開發電子商務

    • 當建立Communities網站時,元件可提供資訊給訪客並收集訪客的資訊。
      如需詳細資訊,請參閱開發社群

  • 在發佈例項中,元件會呈現您的內容,並依您的網站訪客要求呈現內容。

注意

本頁是檔案AEM元件- The Basics的延續。

注意

/libs/cq/gui/components/authoring/dialog下方的元件僅能用於編輯器(「編寫」中的元件對話方塊)。 如果在其他地方使用(例如在精靈對話方塊中),則可能不會如預期般運作。

程式碼範例

本頁提供開發AEM新元件所需的參考檔案(或參考檔案的連結)。 如需實用範例,請參閱開發AEM元件——程式碼範例

結構

元件的基本結構已在AEM元件- The Basics頁面中介紹。 該檔案同時涵蓋觸控式和傳統UI。 即使您不需要在新元件中使用傳統設定,在繼承現有元件時也可以注意這些設定。

擴展現有元件和對話框

視您要實作的元件而定,可能會擴充或自訂現有的例項,而不是從頭開始定義和開發整個結構

在擴展或定制現有元件或對話框時,可以在進行更改之前複製或複製該對話框所需的整個結構或結構。

擴展現有元件

通過資源類型層次結構和相關的繼承機制,可以實現擴展現有元件。

注意

元件也可以根據搜尋路徑邏輯以覆蓋重新定義。 不過,在此情況下,Sling Resource Merger將不會觸發,而/apps必須定義整個覆蓋。

注意

內容片段元件也可以自訂和擴充,不過必須考慮完整結構以及與資產的關係。

自定義現有元件對話框

也可以使用Sling Resource Merger覆寫​元件對話框​並定義屬性sling:resourceSuperType

這表示您只需要重新定義所需的差異,而不需重新定義整個對話框(使用sling:resourceSuperType)。 現在建議使用此方法來擴充元件對話方塊

如需詳細資訊,請參閱Sling Resource Merger

定義標籤

將使用HTML呈現您的元件。 您的元件需要定義需要的HTML,以取得必要的內容,然後在作者和發佈環境中視需要呈現。

使用HTML範本語言

隨AEM 6.0推出的HTML範本語言(HTL)取代JSP(JavaServer Pages),成為HTML的偏好和建議的伺服器端範本系統。 對於需要建立強穩企業網站的網頁開發人員,HTL有助於提高安全性和開發效率。

注意

雖然HTL和JSP都可用來開發元件,但我們將在本頁上使用HTL來說明開發,因為它是AEM的建議指令碼語言。

開發內容邏輯

此可選邏輯選擇和/或計算要渲染的內容。 它會從具有適當Use-API模式的HTL運算式中呼叫。

將邏輯與外觀分開的機制有助於澄清對給定視圖的調用。 它還允許對同一資源的不同視圖使用不同的邏輯。

使用Java

HTL Java Use-API可讓HTL檔案存取自訂Java類別中的輔助方法。這可讓您使用Java程式碼來實作邏輯,以選取和設定元件內容。

使用JavaScript

HTL JavaScript Use-API可讓HTL檔案存取以JavaScript編寫的協助程式碼。這可讓您使用JavaScript程式碼來實作邏輯,以選取和設定元件內容。

使用用戶端HTML程式庫

現代網站嚴重依賴由複雜JavaScript和CSS程式碼驅動的用戶端處理。 組織並最佳化此程式碼的服務可能是個複雜的問題。

為協助處理此問題,AEM提供​用戶端程式庫資料夾,讓您將用戶端程式碼儲存在儲存庫中,將它組織成類別,並定義將每類程式碼提供給用戶端的時機和方式。 然後用戶端程式庫系統會負責在您的最終網頁中產生正確的連結,以載入正確的程式碼。

如需詳細資訊,請參閱使用用戶端HTML程式庫

配置編輯行為

您可以配置元件的編輯行為,包括元件可用的操作、就地編輯器的特性以及與元件上的事件相關的監聽器等屬性。 此設定是觸控式和傳統UI的常見設定,但有特定的差異。

通過在元件節點(類型cq:Component)下添加類型cq:EditConfigcq:editConfig節點,並添加特定屬性和子節點,配置元件的編輯行為。

設定預覽行為

在切換至「預覽」模式時,即使頁面未重新整理,也會設定「WCM模式 Cookie」。

對於具有對WCM模式敏感的轉譯元件,需要定義這些元件,以明確重新整理它們,然後依賴Cookie的值。

注意

在啟用觸控的UI中,僅EDITPREVIEW值用於WCM模式 Cookie。

建立和配置對話框

對話方塊可讓作者與元件互動。 使用對話框可讓作者和/或管理員編輯內容、配置元件或定義設計參數(使用設計對話框

Coral UI和Granite UI

Coral UI和 Granite UI定義了AEM的現代外觀和感覺。

Granite UI提供在製作環境中建立對話方塊 所需的大量基本元件(Widget)。如有需要,您可以延伸此選項,並建立您自己的Widget

有關使用Coral和Granite資源類型開發元件的詳細資訊,請參閱:使用Coral/Granite資源類型建立Experience Manager元件。

如需完整詳細資訊,請參閱:

注意

由於Granite UI元件的性質(以及與ExtJS Widget的差異),元件與觸控式UI和傳統UI的互動方式有一些差異。

建立新對話框

啟用觸控功能的UI對話方塊:

  • 名稱為cq:dialog

  • 定義為nt:unstructured節點,並設定sling:resourceType屬性。

  • 位於其cq:Component節點下,並位於其元件定義旁。

  • 會根據其內容結構和sling:resourceType屬性,在伺服器端(以Sling元件的形式)轉譯。

  • 使用Granite UI架構。

  • 包含描述對話框中欄位的節點結構。

    • 這些節點為nt:unstructured,具有所需的sling:resourceType屬性。

示例節點結構可能是:

newComponent (cq:Component)
  cq:dialog (nt:unstructured)
    content
      layout
      items
        column
          items
            file
            description

自定義對話框類似於開發元件,因為對話框本身是元件(即元件指令碼呈現的標籤以及客戶端庫提供的行為/樣式)。

如需範例,請參閱:

  • /libs/foundation/components/text/cq:dialog
  • /libs/foundation/components/download/cq:dialog
注意

如果元件沒有為觸控式UI定義對話方塊,則傳統UI對話方塊會當做相容層內的備援。 若要自訂此種對話方塊,您必須自訂傳統UI對話方塊。 請參閱Classic UI](/docs/experience-manager-65/developing/components/classic-ui-components/developing-components-classic.html?lang=zh-Hant)的[AEM元件。

自定義對話框欄位

注意

請參閱:

建立新欄位

觸控式UI的介面工具集會實作為Granite UI元件。

若要建立新介面工具集,以便用於觸控式UI的元件對話方塊中,您必須建立新的Granite UI欄位元件

注意

有關Granite UI的完整詳細資訊,請參閱Granite UI檔案

如果您將對話方塊視為表單元素的簡單容器,則您也可以將對話方塊內容的主要內容視為表單欄位。 建立新表單域需要建立資源類型;這相當於建立新元件。 為協助您完成該任務,Granite UI提供了要繼承的通用欄位元件(使用sling:resourceSuperType):

/libs/granite/ui/components/coral/foundation/form/field

更具體地說,Granite UI提供了一系列適合用於對話框(或更一般地,forms)的欄位元件。

注意

這與傳統UI不同,其中Widget由cq:Widgets節點表示,每個節點都具有特定的xtype,以建立與其對應ExtJS Widget的關係。 從實作的角度來看,這些Widget是由ExtJS架構在用戶端上轉譯的。

建立資源類型後,可以通過在對話框中添加新節點來實例化欄位,該節點的屬性sling:resourceType引用了剛剛引入的資源類型。

建立樣式和行為的客戶端庫

如果您想要定義元件的樣式和行為,可以建立專用的用戶端程式庫,以定義自訂CSS/LESS和JS。

要僅為元件對話框(即不為其他元件載入)載入客戶端庫,您需要將對話框的extraClientlibs​屬性設定為剛建立的客戶端庫的類別名稱。 如果您的用戶端資料庫相當大且/或您的欄位是該對話方塊專屬的,且在其他對話方塊中不需要,則建議您這麼做。

要為所有對話框載入客戶端庫,請將客戶端庫的category屬性設定為cq.authoring.dialog。 這是客戶端庫的類別名稱,在顯示所有對話框時,預設情況下會包含該類別名稱。 如果您的用戶端程式庫較小且/或欄位是通用的,而且可在其他對話方塊中重複使用,您就要這麼做。

如需範例,請參閱:

  • cqgems/customizingfield/components/colorpicker/clientlibs

擴展(繼承自)欄位

視您的需求而定,您可以:

  • 依元件繼承(sling:resourceSuperType)擴充指定的Granite UI欄位
  • 從基礎介面工具集程式庫延伸指定介面工具集(如果是Granite UI,則為Coral UI),請遵循介面工具集程式庫API(JS/CSS繼承)

對對話框欄位的訪問

您也可以使用演算條件(rendercondition)來控制誰可以存取對話方塊中的特定標籤/欄位;例如:

+ mybutton
  - sling:resourceType = granite/ui/components/coral/foundation/button
  + rendercondition
    - sling:resourceType = myapp/components/renderconditions/group
    - groups = ["administrators"]

處理欄位事件

處理對話欄位上事件的方法現在已針對自訂用戶端程式庫](#listeners-in-a-custom-client-library)中的聆聽器完成。 這與在內容結構中具有[監聽器的舊方法有所改變。

自定義客戶端庫中的監聽程式

若要將邏輯插入您的欄位,您應:

  1. 將您的欄位標示為指定的CSS類別(hook)。
  2. 在用戶端程式庫中,定義一個掛接該CSS類別名稱的JS接聽程式(這可確保您的自訂邏輯僅限於您的欄位,而不會影響同類型的其他欄位)。

若要達成此目的,您必須瞭解您要與之互動的基礎Widget程式庫。 請參閱Coral UI檔案以識別您要對哪個事件做出反應。 這與您過去必須對ExtJS執行的程式非常類似:尋找指定介面工具集的檔案頁面,然後檢查其事件API的詳細資訊。

如需範例,請參閱:

  • cqgems/customizingfield/components/clientlibs/customizingfield

內容結構中的監聽器

在具有ExtJS的傳統UI中,通常在內容結構中有指定Widget的監聽器。 在觸控式UI中達到相同的效果與JS接聽程式碼(或任何程式碼)在內容中不再定義不同。

內容結構描述了語義結構;它不應(必須)暗示基礎介面工具集的性質。 如果內容結構中沒有JS程式碼,您就可以變更實作詳細資訊,而不需變更內容結構。 換言之,您可以變更介面工具集資料庫,而不需觸碰內容結構。

檢測對話框的可用性

如果您有自訂JavaScript,而且只有在對話方塊可用且準備就緒時才需要執行,則應監聽dialog-ready事件。

每當對話方塊載入(或重新載入)並準備使用時,就會觸發此事件,這表示每當對話方塊的DOM中有變更(建立/更新)時。

dialog-ready 可用來在JavaScript自訂程式碼中掛接,以對對話方塊內的欄位或類似工作執行自訂。

欄位驗證

必填欄位

要將指定欄位標籤為強制,請在欄位的內容節點上設定以下屬性:

  • 名稱: required
  • 類型: Boolean

如需範例,請參閱:

/libs/foundation/components/page/cq:dialog/content/items/tabs/items/basic/items/column/items/title/items/title

欄位驗證(Granite UI)

在Granite UI和Granite UI元件(相當於widget)中進行欄位驗證的方法是使用foundation-validation API。 如需詳細資 foundation-valdiation 訊,請參閱Granite檔案。

如需範例,請參閱:

  • cqgems/customizingfield/components/clientlibs/customizingfield/js/validations.js

  • /libs/cq/gui/components/authoring/dialog/clientlibs/dialog/js/validations.js

建立和配置設計對話框

當元件具有可在設計模式中編輯的設計詳細資訊時,將提供「設計」對話框。

定義與用於編輯內容](#creating-a-new-dialog)的[對話框非常相似,其區別在於它定義為節點:

  • 節點名稱:cq:design_dialog
  • 類型: nt:unstructured

建立和配置Inplace Editor

置入編輯器可讓使用者直接編輯段落流程中的內容,而不需開啟對話方塊。 例如,標準的「文字」和「標題」元件都有置入編輯器。

不需要/不需要對每個元件類型都有意義的就地編輯器。

如需詳細資訊,請參閱擴充頁面編寫——新增就地編輯器

自定義元件工具欄

元件工具列可讓使用者存取元件的一系列動作,例如編輯、設定、複製和刪除。

如需詳細資訊,請參閱擴充頁面編寫——新增動作至元件工具列

為參照邊欄配置元件(借/借)

如果您的新元件參考其他頁面的內容,則您可以考慮是否要影響​參考​導軌的​借閱內容​和​借閱內容​區段。

現成可用的AEM只會檢查Reference元件。 若要新增元件,您必須設定OSGi Bundle WCM Authoring Content Reference Configuration

在定義中建立新條目,指定元件以及要檢查的屬性。 例如:

/apps/<*your-Project*>/components/reference@parentPath

注意

使用AEM時,有數種方法可管理此類服務的組態設定。 如需詳細資訊和建議的實務,請參閱設定OSGi

啟用元件並將其添加到段落系統

在開發元件後,它需要啟用以便在適當的段落系統中使用,以便用於所需的頁面。

這可以通過以下任一方法完成:

配置段落系統,以便拖動資產可建立元件實例

AEM提供在您的頁面上設定段落系統的可能性,當使用者將(適當)資產拖曳至該頁面的例項上時,就會自動建立新元件的例項(而不必總是拖曳空白元件至頁面)。

此行為,以及必要的資產對元件關係可以設定:

  1. 在頁面設計的段落定義下。 例如:

    • /etc/designs/<myApp>/page/par

    建立新節點:

    • 名稱: cq:authoring
    • 類型: nt:unstructured
  2. 在此下,建立一個新節點以保存所有資產到元件映射:

    • 名稱: assetToComponentMapping
    • 類型: nt:unstructured
  3. 對於每個資產到元件映射,建立一個節點:

    • 名稱:文字;建議名稱注明資產及相關元件類型;例如,影像
    • 類型: nt:unstructured

    每個都包含下列屬性:

    • assetGroup:

      • 類型: String
      • 值:資產所屬之集團;例如,media
    • assetMimetype:

      • 類型: String
      • 值:相關資產的啞劇型;例如image/*
    • droptarget:

      • 類型: String
      • 值:落靶;例如,image
    • resourceType:

      • 類型: String
      • 值:相關元件資源;例如,foundation/components/image
    • type:

      • 類型: String
      • 值:類型,例如Images

如需範例,請參閱:

  • /etc/designs/geometrixx/jcr:content/page/par/cq:authoring
  • /etc/designs/geometrixx-outdoors/jcr:content/page/par/cq:authoring
  • /etc/designs/geometrixx-media/jcr:content/article/article-content-par/cq:authoring

GITHUB代碼

您可以在GitHub上找到此頁面的程式碼

注意

現在,當使用核心元件和可編輯範本時,可輕鬆在UI中設定元件例項的自動建立。 有關定義哪些元件自動與給定介質類型關聯的詳細資訊,請參閱建立頁面模板

使用AEM Brackets Extension

AEM Brackets Extension提供了編輯AEM元件和用戶端程式庫的順暢工作流程。 它以Brackets程式碼編輯器為基礎。

擴充功能:

  • 簡化同步(不需Maven或File Vault),以協助提高開發人員的效率,並協助具備有限AEM知識的前端開發人員參與專案。
  • 提供部分HTL支援,此範本語言旨在簡化元件開發並提高安全性。
注意

Brackets是建立元件的建議機制。 它取代了專為傳統UI所設計的CRXDE Lite —— 建立元件功能。

從傳統元件遷移

將專為搭配傳統UI使用而設計的元件移轉至可與觸控式UI搭配使用的元件時(單獨或共同使用),應考慮下列問題:

  • HTL

    • 使用HTL並非強制性,但如果您的元件需要更新,則是考慮從JSP移轉至HTL](/docs/experience-manager-65/developing/components/components-basics.html?lang=zh-Hant#htl-vs-jsp)的最佳時機。[
  • 元件

  • 對話方塊

    • 您將需要建立新對話方塊,以便在觸控式UI中使用。 不過,為了相容性,當未為觸控式UI定義對話方塊時,觸控式UI可以使用傳統UI對話方塊的定義。
    • 對話轉換工具可協助您擴充現有元件。
    • 將ExtJS對應至Granite UI元 件可方便地概述ExtJS xtypes和節點類型及其等效的Granite UI資源類型。
    • 自訂欄位,如需詳細資訊,請參閱自訂對話方塊欄位上的AEM Gems工作階段。
    • 從vtypes移轉至Granite UI驗證
    • 使用JS監聽器,如需詳細資訊,請參閱處理欄位事件自訂對話欄位上的AEM Gems工作階段。

移轉cq:監聽程式碼

如果您要移轉專為傳統UI設計的專案,則cq:listener程式碼(和元件相關的clientlibs)可能會使用特定於傳統UI的函式(例如CQ.wcm.*)。 在移轉時,您必須使用觸控式UI中的等同物件/函式來更新此類程式碼。

如果您的專案已完全移轉至觸控式使用者介面,您需要取代此類程式碼,以使用與觸控式使用者介面相關的物件和功能。

不過,如果您的專案在移轉期間(通常情形)必須同時符合傳統UI和觸控式UI,則您必須實作切換,以區隔參照適當物件的個別程式碼。

此切換機制可實現為:

if (Granite.author) {
    // touch UI
} else {
    // classic UI
}

記錄您的元件

身為開發人員,您希望輕鬆存取元件檔案,以便快速瞭解:

  • 說明
  • 預定用途
  • 內容結構與屬性
  • 公開的API和擴充點
  • 等等。

因此,很容易就能在元件本身使用任何現有的檔案標籤。

您只需將README.md檔案置於元件結構中。 然後,此標籤將顯示在元件控制台中。

chlimage_1-7

支援的標籤與內容片段的標籤相同。

本頁內容