文件AEM 6.5使用手冊

在AEM中使用Sling Resource Merger using-the-sling-resource-merger-in-aem

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • undefined

用途 purpose

Sling Resource Merger提供存取及合併資源的服務。 它為兩者提供不同（差異）機制：

  • 使用已設定的搜尋路徑的​ 資源重疊。

  • 使用資源型別階層（透過屬性sling:resourceSuperType）覆寫觸控式UI (cq:dialog)的元件對話方塊的​ 覆寫。

透過Sling Resource Merger，覆蓋/覆寫資源和/或屬性會與原始資源/屬性合併：

  • 自訂定義內容的優先順序高於原始定義（亦即​ 覆蓋 ​或​ 覆寫）。

  • 必要時，自訂中定義的屬性會指示如何使用從原始內容合併的內容。

CAUTION
Sling Resource Merger和相關方法只能搭配Granite使用。 這也表示這僅適用於標準的觸控式UI，特別是以這種方式定義的覆寫僅適用於元件的觸控式對話方塊。
其他區域（包括觸控式元件或傳統UI的其他方面）的覆蓋/覆寫涉及將適當的節點和結構從原始複製到將定義自訂的位置。

AEM的目標 goals-for-aem

在AEM中使用Sling Resource Merger的目標為：

  • 請確定未在/libs中進行自訂變更。

  • 減少從/libs復寫的結構。

    使用Sling資源合併時，不建議從/libs複製整個結構，因為這將導致自訂中保留過多資訊（通常為/apps）。 當系統以任何方式升級時，不必要地複製資訊會增加發生問題的機會。

NOTE
覆寫不依存於搜尋路徑，它們會使用屬性sling:resourceSuperType來建立連線。
不過，覆寫通常定義在/apps下，因為AEM的最佳實務是在/apps下定義自訂；這是因為您不得變更/libs下的任何專案。
CAUTION
您​ 必須 ​不要變更/libs路徑中的任何專案。
這是因為下次升級執行個體時，/libs的內容會被覆寫（當您套用Hotfix或Feature Pack時，這些內容很可能會被覆寫）。
設定和其他變更的建議方法是：

  1. 在/apps下重新建立必要專案（亦即，它存在於/libs中）

  2. 在/apps中進行任何變更

屬性 properties

資源合併器提供下列屬性：

  • sling:hideProperties （ String或String[]）

    指定要隱藏的屬性或屬性清單。

    萬用字元*會隱藏所有。

  • sling:hideResource ( Boolean)

    指示是否應完全隱藏資源，包括其子項。

  • sling:hideChildren （ String或String[]）

    包含要隱藏的子節點或子節點清單。 將會維護節點的屬性。

    萬用字元*會隱藏所有。

  • sling:orderBefore ( String)

    包含同層級節點的名稱，目前節點應位於該節點的前面。

這些屬性會影響覆蓋/覆寫（通常在/apps中）使用對應/原始資源/屬性（來自/libs）的方式。

建立結構 creating-the-structure

若要建立覆蓋或覆寫，您需要在目的地（通常為/apps）下以同等結構重新建立原始節點。 例如：

  • 覆蓋

    • Sites主控台之導覽專案的定義（如邊欄中所示）定義於：

      /libs/cq/core/content/nav/sites/jcr:title

    • 若要覆蓋此節點，請建立下列節點：

      /apps/cq/core/content/nav/sites

      然後視需要更新屬性jcr:title。

  • 覆寫

    • 文字控制檯之觸控式對話方塊的定義定義如下：

      /libs/foundation/components/text/cq:dialog

    • 若要覆寫此節點，請建立以下節點 — 例如：

      /apps/the-project/components/text/cq:dialog

若要建立其中一個，您只需要重新建立骨架結構。 若要簡化結構的重新建立，所有中介節點都可以是nt:unstructured型別（它們不必反映原始節點型別；例如，在/libs中）。

所以在上述覆蓋圖範例中，需要下列節點：

/apps
  /cq
    /core
      /content
        /nav
          /sites
NOTE
在使用Sling Resource Merger （亦即處理標準觸控式UI時）時，不建議從/libs複製整個結構，因為這樣會導致/apps中保留太多資訊。 當系統以任何方式升級時，這可能會導致問題。

使用案例 use-cases

這些功能與標準功能搭配使用，可讓您：

  • 新增屬性

    屬性不存在於/libs定義中，但在/apps覆蓋/覆寫中是必要的。

    1. 在/apps中建立對應的節點
    2. 在此節點上建立新屬性»

  • 重新定義屬性（不是自動建立的屬性）

    屬性已在/libs中定義，但在/apps覆蓋/覆寫中需要新值。

    1. 在/apps中建立對應的節點

    2. 在此節點上建立相符的屬性（在/ apps下）

      • 根據Sling資源解析器設定，屬性的優先順序將為。

      • 支援變更屬性型別。

        如果您使用的屬性型別與/libs中使用的屬性型別不同，則會使用您定義的屬性型別。

    note note
    NOTE
    支援變更屬性型別。

  • 重新定義自動建立的屬性

    依預設，自動建立的屬性（例如jcr:primaryType）不受覆蓋/覆寫約束，以確保目前在/libs之下的節點型別受到遵守。 若要強制覆蓋/覆寫，您必須在/apps中重新建立節點，明確隱藏屬性並重新定義它：

    1. 使用所需的jcr:primaryType在/apps下建立對應的節點

    2. 在該節點上建立屬性sling:hideProperties，其值設為自動建立屬性的值；例如jcr:primaryType

      這個在/apps下定義的屬性，現在會優先於/libs下定義的屬性

  • 重新定義節點及其子系

    節點及其子系已在/libs中定義，但在/apps覆蓋/覆寫中需要新設定。

    1. 結合下列動作：

      1. 隱藏節點的子系（保留節點的屬性）
      2. 重新定義屬性/屬性

  • 隱藏屬性

    屬性已在/libs中定義，但在/apps覆蓋/覆寫中並非必要。

    1. 在/apps中建立對應的節點

    2. 建立型別String或String[]的屬性sling:hideProperties。 使用此項可指定要隱藏/忽略的屬性。 也可以使用萬用字元。 例如：

      • *
      • ["*"]
      • jcr:title
      • ["jcr:title", "jcr:description"]

  • 隱藏節點及其子系

    節點及其子系已在/libs中定義，但在/apps覆蓋/覆寫中並非必要。

    1. 在/apps下建立對應的節點

    2. 建立屬性sling:hideResource

      • 型別： Boolean
      • 值： true

  • 隱藏節點的子系（同時保留節點的屬性）

    在/libs中定義節點、其屬性及其子系。 /apps覆蓋/覆寫中需要節點及其屬性，但/apps覆蓋/覆寫中不需要部分或全部子節點。

    1. 在/apps下建立對應的節點

    2. 建立屬性sling:hideChildren：

      • 型別： String[]
      • 值：要隱藏/忽略的子節點清單（如/libs中所定義）

      萬用字元&amp；ast；可用來隱藏/忽略所有子節點。

  • 重新排序節點

    節點及其同層級已在/libs中定義。 需要新位置，以便在/apps覆蓋/覆寫中重新建立節點，其中新位置是參照/libs中適當的同層級節點所定義。

    • 使用sling:orderBefore屬性：

      1. 在/apps下建立對應的節點

      2. 建立屬性sling:orderBefore：

        這會指定目前節點應置於之前的節點（如/libs）：

        • 型別： String
        • 值： <before-SiblingName>

從您的程式碼叫用Sling Resource Merger invoking-the-sling-resource-merger-from-your-code

Sling Resource Merger包含兩個自訂資源提供者，一個用於覆蓋，另一個用於覆寫。 您可以使用掛接點，在程式碼中叫用這些選項：

NOTE
存取資源時，建議使用適當的掛載點。
這可確保叫用Sling資源合併，並傳回完全合併的資源（減少需要從/libs復寫的結構）。

  • 覆蓋：

    • 用途：根據搜尋路徑合併資源

    • 掛接點： /mnt/overlay

    • 使用狀況： mount point + relative path

    • 範例：

      • getResource('/mnt/overlay' + '<relative-path-to-resource>');

  • 覆寫：

    • 用途：根據資源的超級型別合併資源

    • 掛接點： /mnt/overide

    • 使用狀況： mount point + absolute path

    • 範例：

      • getResource('/mnt/override' + '<absolute-path-to-resource>');

使用範例 example-of-usage

本文包含一些範例：

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2