Anpassning på serversidan server-side-customization

Java™-API:er java-apis

SocialComponent-gränssnitt socialcomponent-interface

SocialComponents är POJO som representerar en resurs för en AEM Communities-funktion. Helst representerar varje SocialComponent en specifik resourceType med exponerade GETters som tillhandahåller data till klienten så att resursen representeras korrekt. All affärslogik och vylogik är inkapslad i SocialComponent, inklusive webbplatsbesökarens sessionsinformation, om det behövs.

Gränssnittet definierar en grundläggande uppsättning GETters som krävs för att representera en resurs. Viktigt är att gränssnittet innehåller metoderna Map<String, Object> getAsMap() och String toJSONString() som krävs för att återge Handlebars-mallar och visa GET JSON-slutpunkter för resurser.

Alla SocialComponent-klasser måste implementera gränssnittet com.adobe.cq.social.scf.SocialComponent

SocialCollectionComponent-gränssnitt socialcollectioncomponent-interface

Gränssnittet SocialCollectionComponent utökar gränssnittet SocialComponent för att bättre representera resurser som är samlingar av andra resurser.

Alla klasser i SocialCollectionComponent måste implementera gränssnittet com.adobe.cq.social.scf.SocialCollectionComponent

SocialComponentFactory-gränssnitt socialcomponentfactory-interface

En SocialComponentFactory (fabrik) registrerar en SocialComponent med ramverket. Fabriken tillhandahåller ett sätt att meddela ramverket vilka SocialComponents som är tillgängliga för en given resourceType och deras prioritetsordning när flera SocialComponents identifieras.

En SocialComponentFactory ansvarar för att skapa en instans av den valda SocialComponent, vilket gör det möjligt att mata in alla beroenden som behövs av SocialComponent från fabriken med hjälp av DI-metoder.

En SocialComponentFactory är en OSGi-tjänst och har tillgång till andra OSGi-tjänster som kan skickas till SocialComponent via en konstruktor.

Alla SocialComponentFactory-klasser måste implementera gränssnittet com.adobe.cq.social.scf.SocialComponentFactory

En implementering av metoden SocialComponentFactory.getPriority() ska returnera det högsta värdet för fabriken som ska användas för den angivna resourceType som returneras av getResourceType().

SocialComponentFactoryManager-gränssnitt socialcomponentfactorymanager-interface

SocialComponentFactoryManager (hanterare) hanterar alla SocialComponents som är registrerade i ramverket och ansvarar för att välja den SocialComponentFactory som ska användas för en given resurs (resourceType). Om inga fabriker har registrerats för en viss resourceType returnerar hanteraren en fabrik med den närmast överordnade typen för den angivna resursen.

En SocialComponentFactoryManager är en OSGi-tjänst och har tillgång till andra OSGi-tjänster som kan skickas till SocialComponent via en konstruktor.

En referens till OSGi-tjänsten hämtas genom att com.adobe.cq.social.scf.SocialComponentFactoryManager anropas

HTTP API - POST-begäranden http-api-post-requests

Klassen PostOperation postoperation-class

Slutpunkterna för HTTP API-POSTEN är PostOperation-klasser som definieras genom implementering av SlingPostOperation-gränssnittet (paket org.apache.sling.servlets.post).

Slutpunktsimplementeringen PostOperation ställer in sling.post.operation på ett värde som åtgärden svarar på. Alla POST-begäranden med en:operation-parameter inställd på det värdet delegeras till den här implementeringsklassen.

PostOperation anropar SocialOperation som utför de åtgärder som krävs för åtgärden.

PostOperation tar emot resultatet från SocialOperation och returnerar det rätta svaret till klienten.

Klassen SocialOperation socialoperation-class

Varje SocialOperation-slutpunkt utökar klassen AbstractSocialOperation och åsidosätter metoden performOperation(). Den här metoden utför alla åtgärder som krävs för att slutföra åtgärden och returnerar en SocialOperationResult eller utlöser en OperationException. I så fall returneras en HTTP-felstatus med ett meddelande, om ett sådant finns, i stället för den vanliga JSON-svarskoden eller HTTP-statuskoden för lyckade åtgärder.

Om du utökar AbstractSocialOperation kan du återanvända SocialComponents för att skicka JSON-svar.

Klassen SocialOperationResult socialoperationresult-class

Klassen SocialOperationResult returneras som resultatet av SocialOperation och består av ett SocialComponent-, HTTP-statuskod- och HTTP-statusmeddelande.

SocialComponent representerar resursen som påverkades av åtgärden.

För en Skapa-åtgärd representerar SocialComponent som ingår i SocialOperationResult den skapade resursen och för en Update-åtgärd representerar den resursen som ändrades av åtgärden. Ingen SocialComponent returneras för en borttagningsåtgärd.

De HTTP-statuskoder som används är:

Klassen OperationException operationexception-class

Ett OperationExcepton genereras när en åtgärd utförs om begäran inte är giltig eller om något annat fel inträffar. Exempel: interna fel, felaktiga parametervärden eller felaktiga behörigheter. En OperationException består av en HTTP-statuskod och ett felmeddelande, som returneras till klienten som svar på PostOperatoin.

Klassen OperationService operationservice-class

Ramverket för sociala komponenter rekommenderar att den affärslogik som ansvarar för att utföra åtgärden inte implementeras i klassen SocialOperation, utan istället delegeras till en OSGi-tjänst. Om du använder en OSGi-tjänst för affärslogik kan en SocialComponent, som hanteras av en SocialOperation-slutpunkt, integreras med annan kod och ha en annan affärslogik.

Alla OperationService-klasser utökar AbstractOperationService, vilket tillåter ytterligare tillägg som kan ansluta till den åtgärd som utförs. Varje åtgärd i tjänsten representeras av en SocialOperation-klass. Klassen OperationExtensions kan anropas under körningen genom att anropa metoderna

Klassen OperationExtension operationextension-class

Klasserna OperationExtension är anpassade koddelar som kan injiceras i en åtgärd som gör att åtgärder kan anpassas efter affärsbehoven. Konsumenterna av komponenten kan dynamiskt och stegvis lägga till funktioner i komponenten. Med hjälp av tilläggs-/krokmönstret kan utvecklare fokusera enbart på själva tilläggen och ta bort behovet av att kopiera och åsidosätta hela åtgärder och komponenter.

Exempelkod sample-code

Exempelkod finns i Adobe Experience Cloud GitHub -databasen. Sök efter projekt som har prefix med antingen aem-communities eller aem-scf.

Bästa praxis best-practices

I avsnittet Riktlinjer för kodning finns olika riktlinjer för kodning och metodtips för AEM Communities-utvecklare.

Se även Lagringsresursprovidern (SRP) för UGC om du vill veta mer om hur du får åtkomst till användargenererat innehåll.