Java Use-API HTL

Dernière mise à jour : 14 août 2024

Créé pour :

  • Développeur

Le Java Use-API HTL permet à un fichier HTL d’accéder aux méthodes d’assistance de classe Java personnalisées.

Cas d’utilisation

Le Java Use-API HTL permet à un fichier HTL d’accéder aux méthodes d’assistance dans une classe Java personnalisée via data-sly-use. Cette méthode permet à l’ensemble de la logique commerciale complexe d’être encapsulée dans le code Java tandis que le code HTL traite uniquement la production directe des balises.

Un objet java Use-API peut être un POJO simple, instancié par une implémentation particulière à travers le constructeur par défaut du POJO.

Les POJO Use-API peuvent également exposer une méthode publique, appelée init, avec la signature suivante :

    /**
     * Initializes the Use bean.
     *
     * @param bindings All bindings available to the HTL scripts.
     **/
    public void init(javax.script.Bindings bindings);

La carte bindings peut contenir des objets qui fournissent du contexte au script HTL actuellement exécuté que l’objet Use-API peut utiliser pour son traitement.

Un exemple simple

Cet exemple illustre l’utilisation du Use-API.

NOTE
Cet exemple est simplifié afin d’illustrer son utilisation. Dans un environnement de production, Adobe vous recommande d’utiliser les modèles Sling.

Commencez avec un composant HTL appelé info,, qui n’a pas de classe d’utilisation. Il consiste en un seul fichier, /apps/my-example/components/info.html.

<div>
    <h1>${properties.title}</h1>
    <p>${properties.description}</p>
</div>

Ajoutez du contenu pour que ce composant effectue le rendu à /content/my-example/ :

{
    "sling:resourceType": "my-example/component/info",
    "title": "My Example",
    "description": "This Is Some Example Content."
}

Lorsque l’on accède à ce contenu, le fichier HTL est exécuté. Dans le code HTL, l’objet contextuel properties est utilisé pour accéder au title et à la description de la ressource active et les afficher. Le fichier de sortie /content/my-example.html ressemble à ce qui suit :

<div>
    <h1>My Example</h1>
    <p>This Is Some Example Content.</p>
</div>

Ajouter une classe d’utilisation

Le composant info en tant que tel n’a pas besoin d’une classe d’utilisation pour remplir sa simple fonction. Cependant, il existe des cas où vous devez effectuer des tâches qui ne peuvent pas être réalisées en HTL. Vous avez donc besoin d’une classe d’utilisation. Gardez toutefois à l’esprit les points suivants :

NOTE
Une classe d’utilisation ne devrait être utilisée que lorsque quelque chose ne peut pas être fait dans le HTL seul.

Par exemple, supposons que vous souhaitiez que le composant info affiche les propriétés title et description de la ressource, mais toutes en minuscules. Comme HTL ne dispose pas d’une méthode pour mettre en minuscules les chaînes, vous pouvez ajouter une classe d’utilisation en ajoutant une classe d’utilisation Java et modifier /apps/my-example/component/info/info.html comme suit :

<div data-sly-use.info="Info">
    <h1>${info.lowerCaseTitle}</h1>
    <p>${info.lowerCaseDescription}</p>
</div>

De plus, /apps/my-example/component/info/Info.java est créé.

package apps.my_example.components.info;

import com.adobe.cq.sightly.WCMUsePojo;

public class Info extends WCMUsePojo {
    private String lowerCaseTitle;
    private String lowerCaseDescription;

    @Override
    public void activate() throws Exception {
        lowerCaseTitle = getProperties().get("title", "").toLowerCase();
        lowerCaseDescription = getProperties().get("description", "").toLowerCase();
    }

    public String getLowerCaseTitle() {
        return lowerCaseTitle;
    }

    public String getLowerCaseDescription() {
        return lowerCaseDescription;
    }
}

Pour en savoir plus, consultez la documentation Java pour com.adobe.cq.sightly.WCMUsePojo.

Maintenant, examinons les différentes parties du code.