HTL Java Use-API

Senast uppdaterad: 30 juli 2025

Skapat för:

  • Utvecklare

Med HTL Java Use-API:t kan en HTML-fil få åtkomst till hjälpmetoder i en anpassad Java-klass.

Användningsfall

Använd-API:t för HTL Java gör att en HTML-fil kan komma åt hjälpmetoder i en anpassad Java-klass via data-sly-use. Med den här metoden kan all komplex affärslogik kapslas in i Java-koden, medan HTML-koden endast hanterar direkt markeringsproduktion.

Ett Java Use-API-objekt kan vara en enkel POJO som initieras av en viss implementering via POJO:s standardkonstruktor.

Use-API-POJO:erna kan också visa en offentlig metod, som kallas init, med följande signatur:

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

Mappningen bindings kan innehålla objekt som ger kontext till det HTML-skript som för närvarande körs och som Use-API-objektet kan använda för bearbetningen.

Ett exempel

I det här exemplet visas användningen av Use-API.

OBSERVERA
Det här exemplet är förenklat bara för att illustrera hur det används. I en produktionsmiljö rekommenderar Adobe att du använder segmenteringsmodeller.

Börja med en HTL-komponent, som kallas info, och som inte har någon use-klass. Den består av en enda fil, /apps/my-example/components/info.html

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

Lägg till innehåll för den här komponenten som ska återges på /content/my-example/:

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

När det här innehållet öppnas körs HTML-filen. I HTML-koden används kontextobjektet properties för att komma åt den aktuella resursens title och description och visa dem. Utdatafilen /content/my-example.html är följande:

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

Lägga till en användningsklass

Komponenten info som den ser ut behöver ingen use-klass för att utföra sin enkla funktion. Det finns fall där du behöver göra saker som inte kan göras i HTML och där du behöver en användningsklass. Tänk på följande:

OBSERVERA
En use-klass ska bara användas när något inte kan göras i enbart HTML.

Anta till exempel att du vill att komponenten info ska visa egenskaperna title och description för resursen, men alla med gemener. Eftersom HTML inte har någon metod för att sänka radering av strängar kan du lägga till en Java-användarklass och ändra /apps/my-example/component/info/info.html enligt följande:

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

Dessutom skapas /apps/my-example/component/info/Info.java.

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;
    }
}

Mer information finns i Java-dokumenten för com.adobe.cq.sightly.WCMUsePojo.

Nu ska vi titta på de olika delarna av koden.

Java-klass, lokal kontra bunt

Java-klassen kan installeras på två sätt:

  • Lokal - I en lokal installation placeras Java-källfilen bredvid HTML-filen i samma databasmapp. Källan kompileras automatiskt vid behov. Inget separat kompilerings- eller paketeringssteg krävs.
  • Paket - I en paketinstallation måste Java-klassen kompileras och distribueras i ett OSGi-paket med AEM standardmetod för paketdistribution (se avsnittet Paketerad Java-klass).

Om du vill veta vilken metod du ska använda när bör du tänka på följande två saker:

  • En lokal Java use-class rekommenderas när use-klassen är specifik för den aktuella komponenten.
  • En Java-användarklass som ingår i paketet rekommenderas när Java-koden implementerar en tjänst som är tillgänglig från flera HTML-komponenter.

I det här exemplet används en lokal installation.

Java-paketet är en databassökväg

När du använder en lokal installation måste paketnamnet för use-klassen matcha databasmappens plats. Understreck i paketnamnet ersätter eventuella bindestreck i sökvägen.

I det här fallet finns Info.java på /apps/my-example/components/info så paketet är apps.my_example.components.info:

package apps.my_example.components.info;

import com.adobe.cq.sightly.WCMUsePojo;

public class Info extends WCMUsePojo {

   ...

}
OBSERVERA
Du bör använda bindestreck i namn på databasobjekt när du utvecklar AEM. Däremot är bindestreck ogiltiga i Java-paketnamn. Därför måste alla bindestreck i databassökvägen konverteras till understreck i paketnamnet.