Parametrisera segmenteringsmodeller från HTML

Adobe Experience Manager (AEM) erbjuder ett robust ramverk för att skapa dynamiska och anpassningsbara webbapplikationer. En av de kraftfulla funktionerna är möjligheten att parametrisera Sling-modeller, vilket ökar deras flexibilitet och återanvändbarhet. Den här självstudiekursen vägleder dig genom att skapa en parametriserad delningsmodell och använda den i HTML (HTML Template Language) för att återge dynamiskt innehåll.

HTL-skript

I det här exemplet skickar HTML-skriptet två parametrar till ParameterizedModel-segmentsmodellen. Modellen ändrar parametrarna i metoden getValue() och returnerar resultatet för visning.

I det här exemplet skickas två String-parametrar, men du kan skicka vilken typ av värde eller objekt som helst till Sling Model, så länge som fälttypen Sling Model, som kommenteras med @RequestAttribute, matchar den typ av objekt eller värde som skickas från HTML.

<sly data-sly-use.myModel="${'com.example.core.models.ParameterizedModel' @ myParameterOne='Hello', myParameterTwo='World'}"
     data-sly-test.isReady="${myModel.isReady()}">

    <p>
        ${myModel.value}
    </p>

</sly>

<sly data-sly-use.placeholderTemplate="core/wcm/components/commons/v1/templates.html"
     data-sly-call="${placeholderTemplate.placeholder @ isEmpty=!isReady}">
</sly>
  • Parameterisering: Programsatsen data-sly-use skapar en instans av ParameterizedModel med myParameterOne och myParameterTwo.
  • Villkorlig återgivning: data-sly-test kontrollerar om modellen är klar innan innehållet visas.
  • Platshållaranrop: placeholderTemplate hanterar fall där modellen inte är klar.

Sling Model-implementering

Så här implementerar du Sling Model:

package com.example.core.models.impl;

import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.SlingHttpServletRequest;
import org.osgi.service.component.annotations.Model;
import org.osgi.service.component.annotations.RequestAttribute;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@Model(
    adaptables = { SlingHttpServletRequest.class },
    adapters = { ParameterizedModel.class }
)
public class ParameterizedModelImpl implements ParameterizedModel {
    private static final Logger log = LoggerFactory.getLogger(ParameterizedModelImpl.class);

    // Use the @RequestAttribute annotation to inject the parameter set in the HTL.
    // Note that the Sling Model field can be any type, but must match the type of object or value passed from HTL.
    @RequestAttribute
    private String myParameterOne;

    // If the HTL parameter name is different from the Sling Model field name, use the name attribute to specify the HTL parameter name
    @RequestAttribute(name = "myParameterTwo")
    private String mySecondParameter;

    // Do some work with the parameter values
    @Override
    public String getValue() {
        return myParameterOne + " " + mySecondParameter + ", from the parameterized Sling Model!";
    }

    @Override
    public boolean isReady() {
        return StringUtils.isNotBlank(myParameterOne) && StringUtils.isNotBlank(mySecondParameter);
    }
}
  • Modellanteckning: Anteckningen @Model anger den här klassen som en segmenteringsmodell, kan anpassas från SlingHttpServletRequest och implementerar gränssnittet ParameterizedModel.
  • Attribut för begäran: Anteckningen @RequestAttribute infogar HTML-parametrar i modellen.
  • Metoder: getValue() sammanfogar parametrarna och isReady() kontrollerar att parametrarna inte är tomma.

Gränssnittet ParameterizedModel definieras så här:

package com.example.core.models;

import org.osgi.annotation.versioning.ConsumerType;

@ConsumerType
public interface ParameterizedModel {
    /**
     * Get an example string value from the model. This value is the concatenation of the two parameters.
     *
     * @return the value of the model
     */
    String getValue();

    /**
     * Check if the model is ready to be used.
     *
     * @return {@code true} if the model is ready, {@code false} otherwise
     */
    boolean isReady();
}

Exempelutdata

Med parametrarna "Hello" och "World" genererar HTL-skriptet följande utdata:

<p>
    Hello World, from the parameterized Sling Model!
</p>

Detta visar hur parametriserade modeller i AEM kan påverkas baserat på indataparametrar som tillhandahålls via HTML.

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69