DocumentaciónAEM 6.4Guía de desarrollo

Uso de la fusión de recursos de Sling en AEM using-the-sling-resource-merger-in-aem

Last update: Fri May 05 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Developer
CAUTION
AEM 6.4 ha llegado al final de la compatibilidad ampliada y esta documentación ya no se actualiza. Para obtener más información, consulte nuestra períodos de asistencia técnica. Buscar las versiones compatibles here.

Función purpose

La fusión de recursos de Sling proporciona servicios para acceder y combinar recursos. Proporciona mecanismos de diferenciación (diferenciación) para ambos:

  • Superposiciones de los recursos que utilizan la variable rutas de búsqueda configuradas.

  • Anulaciones de los cuadros de diálogo de los componentes para la IU táctil (cq:dialog), utilizando la jerarquía de tipo de recurso (mediante la propiedad ) sling:resourceSuperType).

Con la fusión de recursos de Sling, los recursos o propiedades de superposición/anulación se combinan con los recursos/propiedades originales:

  • El contenido de la definición personalizada tiene una prioridad mayor que el del original (es decir, que superposiciones o anulaciones ).

  • En su caso, propiedades definida en la personalización, indique cómo se va a utilizar el contenido combinado del original.

CAUTION
La fusión de recursos de Sling y los métodos relacionados solo pueden usarse con Granite. Esto también significa que solo es apropiado para la IU táctil estándar; en particular, las anulaciones definidas de esta forma solo son aplicables al cuadro de diálogo táctil de un componente.
Las superposiciones/anulaciones de otras áreas (incluidos otros aspectos de un componente táctil o de la IU clásica) implican copiar el nodo y la estructura adecuados del original al lugar en el que se definirá la personalización.

Objetivos para AEM goals-for-aem

Los objetivos para usar la fusión de recursos de Sling en AEM son:

  • asegúrese de que los cambios de personalización no se realicen en /libs.

  • reducir la estructura que se replica desde /libs.

    Al utilizar la fusión de recursos de Sling, no se recomienda copiar toda la estructura de /libs ya que esto resultaría en que se mantenga demasiada información en la personalización (normalmente /apps). La duplicación de información aumenta innecesariamente la posibilidad de problemas cuando el sistema se actualiza de alguna manera.

NOTE
Las anulaciones no dependen de las rutas de búsqueda, sino que utilizan la propiedad sling:resourceSuperType para establecer la conexión.
Sin embargo, las anulaciones se definen a menudo en /apps, como práctica recomendada en AEM es definir las personalizaciones en /apps; esto se debe a que no debe cambiar nada en /libs.
CAUTION
You must no cambie nada en la variable /libs ruta.
Esto se debe a que el contenido de /libs se sobrescribe la próxima vez que actualice la instancia (y puede sobrescribirse al aplicar una corrección o un paquete de funciones).
El método recomendado para la configuración y otros cambios es:

  1. Volver a crear el elemento requerido (es decir, tal como existe en /libs) en /apps

  2. Realice cambios dentro de /apps

Propiedades properties

La combinación de recursos proporciona las siguientes propiedades:

  • sling:hideProperties ( String o String[])

    Especifica la propiedad, o lista de propiedades, que se va a ocultar.

    El comodín * oculta todo.

  • sling:hideResource ( Boolean)

    Indica si los recursos deben estar completamente ocultos, incluidos los elementos secundarios.

  • sling:hideChildren ( String o String[])

    Contiene el nodo secundario, o lista de nodos secundarios, que se deben ocultar. Las propiedades del nodo se mantendrán.

    El comodín * oculta todo.

  • sling:orderBefore ( String)

    Contiene el nombre del nodo del mismo nivel en el que se debe colocar el nodo actual delante de .

Estas propiedades afectan al modo en que los recursos/propiedades correspondientes/originales (de /libs) se utilizan en la superposición/anulación (a menudo en /apps).

Creación de la estructura creating-the-structure

Para crear una superposición o una anulación, debe volver a crear el nodo original, con la estructura equivalente, en el destino (normalmente /apps). Por ejemplo:

  • Superposición

    • La definición de la entrada de navegación para la consola Sitios, tal como se muestra en el carril, se define en:

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

    • Para superponer esto, cree el siguiente nodo:

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

      A continuación, actualice la propiedad jcr:title según sea necesario.

  • Omitir

    • La definición del cuadro de diálogo táctil para la consola Texts se define en:

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

    • Para anular esto, cree el siguiente nodo, por ejemplo:

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

Para crear cualquiera de estos elementos solo es necesario volver a crear la estructura del esqueleto. Para simplificar la recreación de la estructura, todos los nodos intermediarios pueden ser del tipo nt:unstructured (no tienen que reflejar el tipo de nodo original; por ejemplo, en /libs).

Por lo tanto, en el ejemplo de superposición anterior, se necesitan los siguientes nodos:

/apps
  /cq
    /core
      /content
        /nav
          /sites
NOTE
Cuando se utiliza la fusión de recursos de Sling (es decir, cuando se trata de la IU estándar con capacidad táctil) no se recomienda copiar toda la estructura de /libs como resultaría en que se mantuviera demasiada información en /apps. Esto puede causar problemas cuando el sistema se actualiza de cualquier manera.

Casos de uso use-cases

Estos, junto con la funcionalidad estándar, permiten:

  • Agregar una propiedad

    La propiedad no existe en la variable /libs la definición, pero es necesaria en la variable /apps superposición/anulación.

    1. Cree el nodo correspondiente dentro de /apps
    2. Cree la nueva propiedad en este nodo "

  • Redefinir una propiedad (no propiedades creadas automáticamente)

    La propiedad se define en /libs, pero se requiere un nuevo valor en la variable /apps superposición/anulación.

    1. Cree el nodo correspondiente dentro de /apps

    2. Cree la propiedad coincidente en este nodo (en / apps)

      • La propiedad tendrá una prioridad basada en la configuración de Sling Resource Resolver.

      • Se admite el cambio del tipo de propiedad.

        Si utiliza un tipo de propiedad diferente al utilizado en /libs, se utilizará el tipo de propiedad que defina.

    note note
    NOTE
    Se admite el cambio del tipo de propiedad.

  • Redefinir una propiedad creada automáticamente

    De forma predeterminada, las propiedades creadas automáticamente (por ejemplo, jcr:primaryType) no están sujetos a una superposición o anulación para garantizar que el tipo de nodo que se encuentra actualmente en /libs se respeta. Para imponer una superposición/anulación, debe volver a crear el nodo en /apps, oculte explícitamente la propiedad y vuelva a definirla:

    1. Cree el nodo correspondiente en /apps con el jcr:primaryType

    2. Crear la propiedad sling:hideProperties en ese nodo, con el valor establecido en el de la propiedad creada automáticamente; por ejemplo, jcr:primaryType

      Esta propiedad, definida en /apps, ahora tendrá prioridad sobre el definido en /libs

  • Redefinir un nodo y sus elementos secundarios

    El nodo y sus elementos secundarios se definen en /libs, pero se requiere una nueva configuración en la /apps superposición/anulación.

    1. Combinar las acciones de:

      1. Ocultar elementos secundarios de un nodo (conservar las propiedades del nodo)
      2. Redefinir la propiedad o propiedades

  • Ocultar una propiedad

    La propiedad se define en /libs, pero no obligatorio en el /apps superposición/anulación.

    1. Cree el nodo correspondiente dentro de /apps

    2. Crear una propiedad sling:hideProperties de tipo String o String[]. Utilice esto para especificar las propiedades que se van a ocultar o ignorar. También se pueden utilizar caracteres comodín. Por ejemplo:

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

  • Ocultar un nodo y sus elementos secundarios

    El nodo y sus elementos secundarios se definen en /libs, pero no obligatorio en el /apps superposición/anulación.

    1. Cree el nodo correspondiente en /apps

    2. Crear una propiedad sling:hideResource

      • type: Boolean
      • value: true

  • Ocultar elementos secundarios de un nodo (manteniendo las propiedades del nodo)

    El nodo, sus propiedades y sus elementos secundarios se definen en /libs. El nodo y sus propiedades son necesarios en la variable /apps superposición/anulación, pero algunos o todos los nodos secundarios no son necesarios en la variable /apps superposición/anulación.

    1. Cree el nodo correspondiente en /apps

    2. Crear la propiedad sling:hideChildren:

      • type: String[]
      • valor: una lista de los nodos secundarios (tal como se definen en /libs) para ocultar o ignorar

      El comodín * se puede utilizar para ocultar o ignorar todos los nodos secundarios.

  • Reordenar nodos

    El nodo y sus hermanos se definen en /libs. Se requiere una nueva posición para que el nodo se vuelva a crear en la /apps superposición/anulación, donde la nueva posición se define en referencia al nodo del mismo nivel apropiado en /libs.

    • Utilice la variable sling:orderBefore propiedad:

      1. Cree el nodo correspondiente en /apps

      2. Crear la propiedad sling:orderBefore:

        Esto especifica el nodo (como en /libs) que el nodo actual debe colocarse antes de:

        • type: String
        • value: <before-SiblingName>

Invocación de la fusión de recursos de Sling desde el código invoking-the-sling-resource-merger-from-your-code

La fusión de recursos de Sling incluye dos proveedores de recursos personalizados: uno para superposiciones y otro para anulaciones. Cada una de ellas se puede invocar dentro del código utilizando un punto de montaje:

NOTE
Al acceder al recurso, se recomienda utilizar el punto de montaje adecuado.
Esto garantiza que se invoque la fusión de recursos de Sling y que se devuelva el recurso completamente combinado (lo que reduce la estructura que debe duplicarse desde /libs).

  • Superposición:

    • propósito: combinar recursos en función de su ruta de búsqueda

    • punto de montaje: /mnt/overlay

    • uso: mount point + relative path

    • ejemplo:

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

  • Omitir:

    • propósito: combinar recursos en función de su supertipo

    • punto de montaje: /mnt/overide

    • uso: mount point + absolute path

    • ejemplo:

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

Ejemplo de uso example-of-usage

Se tratan algunos ejemplos:

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e