Framework sociale component social-component-framework

Het sociale componentenkader (SCF) vereenvoudigt het proces om, componenten van Gemeenschappen op zowel server-kant als cliënt-kant te vormen aan te passen en uit te breiden.

De voordelen van het kader:

Onderzoek op een auteur of publiceer instantie gebruikend de interactieve gids van de Componenten van de Gemeenschap.

Overzicht overview

In SCF, wordt een component samengesteld uit een POJO SocialComponent, een Malplaatje van Handlebars JS (om de component terug te geven), en CSS (om de component te stileren).

Een JS-sjabloon Handlebars kan de JS-componenten model/weergave uitbreiden om gebruikersinteractie met de component op de client af te handelen.

Als een component wijziging van gegevens moet ondersteunen, kan de implementatie van de API voor sociale componenten worden geschreven ter ondersteuning van het bewerken/opslaan van gegevens die vergelijkbaar zijn met model- en gegevensobjecten in traditionele webtoepassingen. Daarnaast kunnen bewerkingen (controllers) en een bewerkingsservice worden toegevoegd om bewerkingsverzoeken te verwerken, bedrijfslogica uit te voeren en de API's op het model/de gegevensobjecten aan te roepen.

De API van de sociale component kan worden uitgebreid om gegevens te verstrekken die door een cliënt voor een meningslaag of een cliënt van HTTP worden vereist.

Hoe pagina's voor de client worden gerenderd how-pages-are-rendered-for-client

Component Customization and Extension component-customization-and-extension

Als u de componenten wilt aanpassen of uitbreiden, schrijft u alleen de overlays en extensies naar de map /apps waarmee u het upgradeproces naar toekomstige releases kunt vereenvoudigen.

Server-Side Framework server-side-framework

Het framework biedt API's voor toegang tot functionaliteit op de server en voor ondersteuning van interactie tussen de client en de server.

Java™ API's java-apis

De Java™ API's bieden abstracte klassen en interfaces die gemakkelijk kunnen worden overgeërfd of gesubclassificeerd.

De belangrijkste klassen worden beschreven op de server-kant pagina van de Aanpassing.

Bezoek Overzicht van de Leverancier van het Middel van de Opslagom over het werken met UGC te leren.

HTTP-API http-api

De HTTP-API ondersteunt eenvoudige aanpassingen en keuzemogelijkheden van clientplatforms voor PhoneGap-apps, native apps en andere integraties en mashups. Bovendien staat HTTP API een communautaire plaats toe om als dienst zonder een cliënt te lopen, zodat de kadercomponenten in om het even welke webpage kunnen worden geïntegreerd die op om het even welke technologie wordt voortgebouwd.

HTTP API - GET http-api-get-requests

Voor elke SocialComponent, verstrekt het kader een op HTTP-Gebaseerd API eindpunt. Het eindpunt wordt betreden door een verzoek van de GET naar het middel met ".social.json"selecteur + uitbreiding te verzenden. Met Sling wordt de aanvraag aan de DefaultSocialGetServlet overhandigd.

DefaultSocialGetServlet

GET Request

Een standaard GET servlet luistert naar .social.json verzoeken waaraan de SocialComponent met klantgerichte JSON antwoordt.

HTTP API - POST-aanvragen http-api-post-requests

Naast de (Gelezen) verrichtingen van de GET, bepaalt het kader een eindpuntpatroon om andere verrichtingen op een component toe te laten, met inbegrip van Create, Update, en Schrapping. Deze eindpunten zijn HTTP-API's die invoer accepteren en reageren met een HTTP-statuscode of met een JSON-reactieobject.

Dit patroon van het kadereindpunt maakt de verrichtingen van de CUD verlengbaar, herbruikbaar, en testbaar.

POST Request

Er is een Sling POST:verrichting voor elke verrichting SocialComponent. De bedrijfslogica en onderhoudscode voor elke verrichting zijn verpakt in een OperationService die door HTTP API of van elders als dienst OSGi toegankelijk is. Hooks wordt geleverd ter ondersteuning van instelbare bewerkingsextensies voor acties voor en na acties.

Storage Resource Provider (SRP) storage-resource-provider-srp

Om over behandeling UGC te leren die in de wordt opgeslagen opslag van de communautaire inhoud, zie:

Aanpassingen op de server server-side-customizations

Bezoek server-Kant Aanpassingenvoor informatie bij het aanpassen van de bedrijfslogica en het gedrag van een component van Gemeenschappen op server-kant.

Handlebars JS Templating Language handlebars-js-templating-language

Een van de merkbaardere wijzigingen in het nieuwe framework is het gebruik van de sjabloontaal Handlebars JS (HBS), een populaire open-source technologie voor rendering van servers en clients.

HBS-scripts zijn eenvoudig, zonder logica, kunnen op zowel de server als de client worden gecompileerd, zijn eenvoudig te bedekken en aan te passen en zijn op natuurlijke wijze gebonden aan de client-UX, omdat HBS renderen op de client ondersteunt.

Het kader verstrekt verscheidene helpers Handlebarsdie wanneer het ontwikkelen van SocialComponents nuttig zijn.

Op de server, wanneer het Sling een verzoek van de GET verhelpt, identificeert het het manuscript dat wordt gebruikt om op het verzoek te antwoorden. Als het manuscript een malplaatje HBS (.hbs) is, zal het Sling het verzoek aan de Motor van Handlebars delegeren. De Motor Handlebars zal dan de SocialComponent van aangewezen SocialComponentFactory krijgen, een context bouwen, en de HTML teruggeven.

Geen toegangsbeperking no-access-restriction

Handlebars (HBS) malplaatjedossiers (.hbs) zijn analoog aan .jsp en .html malplaatjedossiers, behalve zij kunnen voor het teruggeven zowel in cliëntbrowser als op de server worden gebruikt. Daarom ontvangt een cliëntbrowser die om een cliënt-zijmalplaatje verzoekt een .hbs dossier van de server.

Dit vereist dat alle malplaatjes van HBS in de sling onderzoekspad (om het even welke .hbs dossiers onder /libs/ of /apps) door om het even welke gebruiker van auteur kunnen worden gehaald of publiceren.

De toegang van HTTP tot .hbs dossiers kan niet worden verboden.

Een onderdeel van een Gemeenschappen toevoegen of opnemen add-or-include-a-communities-component

De meeste componenten van Gemeenschappen moeten worden toegevoegd als het Verzenden adresseerbare middel. Een uitgezochte paar componenten van Gemeenschappen kan ** in een malplaatje als niet bestaand middel {worden omvat om voor dynamische opneming en aanpassing van de plaats toe te staan waarbij om gebruiker-geproduceerde inhoud (UGC) te schrijven.

In één van beide geval, moeten de van de component vereiste cliëntbibliothekenook aanwezig zijn.

voeg een Component toe

Het toevoegen van een component verwijst naar het proces om een geval van een middel (component) toe te voegen, zoals wanneer gesleept van componentenbrowser (sidekick) op een pagina in auteur uitgeeft wijze.

Het resultaat is een JCR-onderliggend knooppunt onder een pari-knooppunt, dat adresseerbaar is.

omvat een Component

Het omvatten van een component verwijst naar het proces om een verwijzing naar een "niet bestaand"middel(geen knoop JCR) binnen het malplaatje toe te voegen, zoals het gebruiken van een scripting taal.

Vanaf Adobe Experience Manager (AEM) 6.1, wanneer een component dynamisch inbegrepen in plaats van toegevoegd is, is het mogelijk om de eigenschappen van de component op auteur ontwerp wijze uit te geven.

Slechts een paar AEM Communities-componenten kunnen dynamisch worden opgenomen. Het zijn:

De Communautaire Gids van Componentenstaat includible componenten toe om van het worden van een knevel te worden voorzien van worden toegevoegd aan inbegrepen.

wanneer het gebruiken van de Templating taal van Handels, wordt het niet bestaande middel inbegrepen gebruikend omvat helperdoor zijn resourceType te specificeren:

{{include this.id path="comments" resourceType="social/commons/components/hbs/comments"}}

wanneer het gebruiken van JSP, is een middel inbegrepen gebruikend de markering cq:omvat:

<cq:include path="votes"
 resourceType="social/tally/components/voting" />

Handlebars Helpers handlebars-helpers

Zie SCF de Helpers van Handlebarsvoor een lijst en een beschrijving van douanhelpers beschikbaar in SCF.

Client-Side Framework client-side-framework

Model-View JavaScript Framework model-view-javascript-framework

Het kader omvat een uitbreiding van Backbone.js, een model-mening kader van JavaScript, om ontwikkeling van rijke, interactieve componenten te vergemakkelijken. De objectgeoriënteerde aard ondersteunt een uitbreidbaar/herbruikbaar framework. De communicatie tussen client en server wordt vereenvoudigd met de HTTP API.

Het framework gebruikt server-side Handlebars-sjablonen om de componenten voor de client te renderen. De modellen zijn gebaseerd op de JSON-reacties die door de HTTP-API zijn gegenereerd. De meningen binden zich aan HTML die door de malplaatjes Handlebars wordt geproduceerd en verstrekken interactiviteit.

CSS-conventies css-conventions

Hieronder vindt u aanbevolen conventies voor het definiëren en gebruiken van CSS-klassen:

Aanpassingen op de client client-side-customizations

Voor het aanpassen van de verschijning en het gedrag van een component van Gemeenschappen op de cliënt-kant, verwijzing Cliënt-Kant Aanpassingen, die informatie over omvatten:

Essentiële functies en componenten feature-and-component-essentials

De essentiële informatie voor ontwikkelaars wordt beschreven in de sectie van de Hoofdzaak van de Eigenschap en van de Component.

De extra ontwikkelaarinformatie kan in de sectie van de Richtlijnen van de Coderingworden gevonden.

Problemen oplossen troubleshooting

De gemeenschappelijke zorgen en bekende kwesties worden beschreven in de 1} sectie van het Oplossen van problemen.