在AEM中使用Sling资源合并器

用途

Sling资源合并器提供访问和合并资源的服务。 它为以下两者提供了差异(差异)机制:

  • 🔗 使用配置的搜索路径 覆盖资源

  • ​使用资源类型层次结构(通过属性)的触屏UI(cq:dialog)组件对话框的概述 sling:resourceSuperType

通过Sling资源合并器,叠加/覆盖资源和/或属性将与原始资源/属性合并:

  • 自定义定义的内容比原始定义的内容具有更高的优先级(即,它​叠加​或​覆盖)。

  • 如有必要,在自定义中定义属性 ,以指示如何使用合并自原始内容的内容。

注意

Sling资源合并器及相关方法只能与Granite一起使用。 这也意味着该UI仅适用于标准触屏UI;特别是,以这种方式定义的覆盖仅适用于组件的触屏对话框。

其他区域(包括触屏组件或经典UI的其他方面)的叠加/覆盖涉及将相应的节点和结构从原始节点复制到定义自定义的位置。

AEM的目标

在AEM中使用Sling资源合并器的目标是:

  • 确保未在/libs中进行自定义更改。

  • 减少从/libs复制的结构。

    使用Sling资源合并器时,不建议从/libs复制整个结构,因为这样会导致自定义中保留的信息过多(通常为/apps)。 复制信息会不必要地增加系统以任何方式升级时出现问题的可能性。

注意

覆盖不取决于搜索路径,它们使用属性sling:resourceSuperType建立连接。

但是,覆盖通常在/apps下定义,因为AEM的最佳实践是在/apps下定义自定义;这是因为您不能更改/libs下的任何内容。

注意

必须​不更改/libs路径中的任何内容。

这是因为下次升级实例时,/libs的内容会被覆盖(当您应用修补程序或功能包时,很可能会被覆盖)。

配置和其他更改的推荐方法是:

  1. /apps下重新创建所需项(即/libs中存在的项)

  2. /apps中进行任何更改

属性

资源合并器提供以下属性:

  • sling:hideProperties ( StringString[])

    指定要隐藏的属性或属性列表。

    通配符*隐藏所有。

  • sling:hideResource ( Boolean)

    指示是否应完全隐藏资源,包括其子资源。

  • sling:hideChildren ( StringString[])

    包含要隐藏的子节点或子节点列表。 将维护节点的属性。

    通配符*隐藏所有。

  • sling:orderBefore ( String)

    包含当前节点应位于前面的同级节点的名称。

这些属性会影响叠加/覆盖(通常在/apps中)使用相应/原始资源/属性(来自/libs)的方式。

创建结构

要创建叠加或覆盖,您需要在目标(通常为/apps)下重新创建具有等效结构的原始节点。 例如:

  • 叠加

    • 站点控制台的导航条目的定义(如边栏中所示)在以下位置定义:

      /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
注意

使用Sling资源合并器(即,处理标准触屏UI时)时,不建议从/libs复制整个结构,因为这会导致在/apps中保留的信息过多。 这可能会在系统以任何方式升级时导致问题。

用例

这些功能与标准功能结合使用,使您能够:

  • 添加资产

    该属性在/libs定义中不存在,但在/apps叠加/覆盖中是必需的。

    1. /apps中创建相应的节点
    2. 在此节点“ ”上创建新属性
  • 重定义属性(非自动创建的属性)

    该属性在/libs中定义,但在/apps叠加/覆盖中需要新值。

    1. /apps中创建相应的节点

    2. 在此节点上创建匹配属性(在/ apps下)

      • 根据Sling资源解析程序配置,属性将具有优先级。

      • 支持更改属性类型。

        如果您使用的属性类型与/libs中使用的属性类型不同,则将使用您定义的属性类型。

    注意

    支持更改属性类型。

  • 重定义自动创建的属性

    默认情况下,自动创建的属性(如jcr:primaryType)不受覆盖/覆盖的影响,以确保遵守/libs下当前的节点类型。 要实施叠加/覆盖,必须在/apps中重新创建节点,显式隐藏该属性并重新定义该属性:

    1. /apps下创建相应的节点,并使用所需的jcr:primaryType

    2. 在该节点上创建属性sling:hideProperties,并将值设置为自动创建属性的值;例如,jcr:primaryType

      此属性在/apps下定义,现在优先于在/libs下定义的属性

  • 重新定义节点及其子节点

    节点及其子项在/libs中定义,但在/apps叠加/覆盖中需要新配置。

    1. 组合以下操作:

      1. 隐藏节点的子项(保留节点的属性)
      2. 重定义属性/属性
  • 隐藏资产

    该属性在/libs中定义,但在/apps叠加/覆盖中不是必需的。

    1. /apps中创建相应的节点

    2. 创建类型为StringString[]的属性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中定义)

      通配符*可用于隐藏/忽略所有子节点。

  • 重新排序节点

    节点及其同级节点在/libs中定义。 需要新位置,以便在/apps叠加/覆盖中重新创建节点,其中新位置在引用/libs中相应同级节点时定义。

    • 使用sling:orderBefore属性:

      1. /apps下创建相应的节点

      2. 创建属性sling:orderBefore:

        这会指定当前节点应位于以下位置之前的节点(如/libs中所示):

        • 类型: String
        • 选定: <before-SiblingName>

从代码中调用Sling资源合并器

Sling资源合并器包括两个自定义资源提供程序 — 一个用于叠加,另一个用于覆盖。 可以使用装载点在代码中调用以下每个值:

注意

访问资源时,建议使用适当的装载点。

这可确保调用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>');

用法示例

下面介绍了一些示例:

在此页面上