Använda Sling-adaptrar

Senast uppdaterad: 4 maj 2023

Skapat för:

  • Developer
CAUTION
AEM 6.4 har nått slutet på den utökade supporten och denna dokumentation är inte längre uppdaterad. Mer information finns i teknisk supportperiod. Hitta de versioner som stöds här.

Sling erbjuder Adaptermönster att enkelt översätta objekt som implementerar Adaptiv gränssnitt. Det här gränssnittet innehåller en allmän customiTo() metod som översätter objektet till den klasstyp som skickas som argument.

Om du till exempel vill översätta ett Resource-objekt till motsvarande Node-objekt kan du bara göra följande:

Node node = resource.adaptTo(Node.class);

Användningsexempel

Det finns följande användningsområden:

  • Få implementeringsspecifika objekt.

    En JCR-baserad implementering av den generiska Resource -gränssnittet ger åtkomst till underliggande JCR Node.

  • Skapa genvägar för objekt som kräver att interna kontextobjekt skickas.

    Till exempel den JCR-baserade ResourceResolver innehåller en referens till begäran JCR Sessionsom i sin tur behövs för många objekt som ska fungera baserat på den begärandesessionen, som PageManager eller UserManager.

  • Genväg till tjänster.

    Ett sällsynt fall - sling.getService() är också enkelt.

Null-returvärde

adaptTo() kan returnera null.

Det finns olika orsaker till detta, bland annat:

  • implementeringen saknar stöd för måltypen
  • en adapterfabrik som hanterar det här ärendet är inte aktivt (t.ex. på grund av saknad tjänstreferens)
  • internt villkor misslyckades
  • tjänsten är inte tillgänglig

Det är viktigt att du hanterar skiftläget null på ett smidigt sätt. Vid jsp-återgivning kan det vara acceptabelt att jsp misslyckas om det resulterar i en tom del av innehållet.

Cachelagring

För att förbättra prestanda kan implementeringar cachelagra objektet som returneras från en obj.adaptTo() ring. Om obj är samma, returnerade objekt är samma.

Denna cachelagring utförs för alla AdapterFactory baserade fall.

Det finns dock ingen allmän regel - objektet kan vara antingen en ny eller en befintlig instans. Det innebär att du inte kan förlita dig på något av beteendena. Därför är det viktigt, särskilt inom AdapterFactoryatt objekt kan återanvändas i det här scenariot.

Så här fungerar det

Det finns olika sätt att Adaptable.adaptTo() kan implementeras:

  • själva objektet, implementera själva metoden och mappa till vissa objekt.

  • Av en AdapterFactory, som kan mappa godtyckliga objekt.

    Objekten måste fortfarande implementera Adaptable gränssnitt och måste utöka SlingAdaptable (som klarar adaptTo till en central adapterhanterare).

    Det gör att du kan lägga in kopplingar i adaptTo mekanism för befintliga klasser, som Resource.

  • En kombination av båda.

I det första fallet kan javadocs visa vad adaptTo-targets är möjliga. Detta är dock ofta inte möjligt för vissa underklasser, t.ex. JCR-baserade resurser. I det senare fallet ska AdapterFactory är vanligtvis en del av de privata klasserna i ett paket och därför inte exponeras i ett klient-API, och inte heller listas i javadocs. Teoretiskt sett skulle det vara möjligt att få tillgång till alla AdapterFactory implementeringar från OSGi runtime-modulen för tjänster och se hur deras"adaptable"-konfigurationer (källor och mål) ser ut, men inte för att mappa dem till varandra. I slutändan beror detta på den interna logiken, som måste dokumenteras. Denna referens.

Referens

Sling

Resurs anpassar sig till:

NodOm detta är en JCR-nodbaserad resurs eller en JCR-egenskap som refererar till en nod.
EgenskapOm detta är en JCR-egenskapsbaserad resurs.
ObjektOm detta är en JCR-baserad resurs (nod eller egenskap).
KartaReturnerar en karta över egenskaperna, om detta är en JCR-nodbaserad resurs (eller annan resurs som stöder värdekartor).
ValueMapReturnerar en användbar karta över egenskaperna, om detta är en JCR-nodbaserad resurs (eller annan resurs som stöder värdekartor). Kan också uppnås (enklare) genom att använda
ResourceUtil.getValueMap(Resource) (hanterar gemener, etc.).
ArvValueMapUtökning av ValueMap som gör det möjligt att ta hänsyn till resurshierarkin när du söker efter egenskaper.
PersistableValueMapOm detta är en JCR-nodbaserad resurs och användaren har behörighet att ändra egenskaper på den noden.
Obs! flera beständiga kartor delar inte sina värden.
InputStreamReturnerar det binära innehållet i en "fil"nt:resource
AuthorizableResourceProvider``org.apache.sling.jackrabbit.usermanager``/system/userManager
cq:Page``cq:PseudoPage
cq:Component
cq:Page
cq:Template
cq:Page
cq:Tag
cq:Preferences
cq:ContentSyncConfig
cq:ContentSyncConfig

ResursResolver anpassar sig till:

SessionJCR-sessionen för begäran, om det här är en JCR-baserad resurslösare (standard).
PageManager
ComponentManager
Designer
AssetManagerBaserat på JCR-sessionen, om detta är en JCR-baserad resurslösare.
TagManagerBaserat på JCR-sessionen, om detta är en JCR-baserad resurslösare.
UserManagerBaserat på JCR-sessionen, om detta är en JCR-baserad resurslösare och om användaren har behörighet att komma åt UserManager.
AuktoriserbarDen aktuella användaren.
AnvändareDen aktuella användaren.
PrivilegeManager
InställningarInställningar för den aktuella användaren (baserat på JCR-session om detta är en JCR-baserad resurslösare).
PreferencesService
PinManager
QueryBuilder
ExternalizerFör att göra absoluta URL:er externaliserade, även med objektet request.

SlingHttpServletRequest anpassar sig till:

Inga mål ännu, men implementerar Adaptable och kan användas som källa i en anpassad AdapterFactory.

SlingHttpServletResponse anpassar sig till:

ContentHandler
(XML)		Om det här är ett svarsalternativ.

WCM

Sida anpassar sig till:

ResursSidans resurs.
EtiketteradResursEtiketterad resurs (== this).
NodSidans nod.
...Allt som sidans resurs kan anpassas till.

Komponent anpassar sig till:

ResursKomponentens resurs.
EtiketteradResursEtiketterad resurs (== this).
NodKomponentens nod.
…Allt som komponentens resurs kan anpassas till.

Mall anpassar sig till:

ResursMallens resurs.
EtiketteradResursEtiketterad resurs (== this).
NodNod för den här mallen.
...Allt som mallens resurs kan anpassas till.

Dokumentskydd

Auktoriserbar, Användare och Grupp anpassa till:

NodReturnerar hemnoden för användaren/gruppen.
ReplicationStatusReturnerar replikeringsstatusen för användarens/gruppens hemnod.

DAM

Tillgång anpassar sig till:

ResursResurs för tillgången.
NodNod för resursen.
…Allt som resursen kan anpassas till.

Taggar

Tagg anpassar sig till:

ResursResurs för taggen.
NodTaggens nod.
…Allt som taggens resurs kan anpassas till.

Övriga

Dessutom ger Sling/JCR/OCM [AdapterFactory](https://sling.apache.org/site/adapters.html#Adapters-AdapterFactory) för anpassad OCM (Mappning av objektinnehåll).

Föregående sida
Nästa sida

Experience Manager