Componentrichtlijnen component-guidelines

De Kernonderdelen moderne implementatiepatronen volgen die heel anders zijn dan de basiscomponenten.

Deze pagina verklaart deze patronen, en wanneer om hen te gebruiken om uw eigen authorable componenten te bouwen. De eerste sectie Algemene componentpatronen is van toepassing op alle onderdelen, terwijl de tweede sectie Herbruikbare componentpatronen is van toepassing op componenten die bedoeld zijn om op plaatsen of projecten, zoals de Componenten van de Kern worden hergebruikt bijvoorbeeld.

Algemene componentpatronen general-component-patterns

De richtlijnen in deze sectie worden geadviseerd voor om het even welk soort component, ongeacht of de component voor één enkel project specifiek is, of of de component bedoeld om over plaatsen of projecten wijd te worden hergebruikt.

Configureerbare componenten configurable-components

Componenten kunnen dialoogvensters met diverse opties hebben. Dit zou moeten worden leveraged om componenten flexibel en configureerbaar te maken, en het uitvoeren van veelvoudige componenten te vermijden die hoofdzakelijk variaties van elkaar zijn.

Als een draadframe of ontwerp variaties van vergelijkbare elementen bevat, moeten deze variaties gewoonlijk niet als verschillende componenten worden geïmplementeerd, maar als één component met opties om te kiezen tussen de variaties.

Als u deze stap verder wilt uitvoeren, raadpleegt u de Vooraf configureerbare mogelijkheden sectie.

Scheiding van bezorgdheid separation-of-concerns

Het is doorgaans een goede gewoonte om de logica (of het model) van een component los te houden van de opmaaksjabloon (of weergave). Er zijn verschillende manieren om dat te bereiken, maar het aanbevolen is om Verkoopmodellen voor de logica en de HTML Sjabloontaal (HTL) voor de markering, zoals de Componenten van de Kern ook doen.

Sling Models is een reeks aantekeningen van Java om tot noodzakelijke variabelen van POJOs gemakkelijk toegang te hebben, en daarom een eenvoudige, krachtige, en efficiënte manier te bieden om Java logica voor componenten uit te voeren.

HTML is ontworpen als een veilige en eenvoudige sjabloontaal die is toegesneden op AEM. Het kan vele vormen van logica noemen, die het zeer flexibel maakt.

Herbruikbare componentpatronen reusable-component-patterns

De richtlijnen in deze sectie kunnen ook voor om het even welk soort component worden gebruikt, maar zij zijn het meest logisch voor componenten die bedoeld zijn om over plaatsen of projecten, zoals de Componenten van de Kern worden opnieuw gebruikt. Deze richtlijnen kunnen daarom worden genegeerd voor componenten die slechts op één enkele plaats of project worden gebruikt.

Vooraf configureerbare mogelijkheden pre-configurable-capabilities

Naast het dialoogvenster Bewerken dat wordt gebruikt door auteurs van pagina's, kunnen componenten ook een ontwerpdialoogvenster hebben waarin sjabloonauteurs ze vooraf kunnen configureren. De Sjablooneditor staat aan opstelling toe al deze pre-configuraties, die "Beleid"worden genoemd.

Om componenten zo herbruikbaar mogelijk te maken, zouden zij van zinvolle opties moeten worden voorzien om vooraf te vormen. Hierdoor kunnen functies van de componenten worden in- of uitgeschakeld, zodat deze voldoen aan de specifieke behoeften van verschillende sites.

Proxycomponentpatroon proxy-component-pattern

Aangezien elke inhoudsbron een sling:resourceType eigenschap die verwijst naar de component om deze te renderen, is het meestal een goede gewoonte om deze eigenschappen te laten verwijzen naar sitespecifieke componenten in plaats van te verwijzen naar componenten die door meerdere sites worden gedeeld. Dit zal meer flexibiliteit aanbieden en inhoud het refactoring vermijden als één plaats een verschillend gedrag voor een component nodig heeft, omdat deze aanpassing dan op de plaats-specifieke component kan worden bereikt en niet de andere plaatsen zal beïnvloeden.

Nochtans, voor de project-specifieke componenten om het even welke code niet te dupliceren, zouden zij elk naar de gedeelde oudercomponent met moeten verwijzen sling:resourceSuperType eigenschap. Deze project-specifieke componenten die het meest enkel naar oudercomponenten verwijzen worden genoemd "volmachtscomponenten". Proxycomponenten kunnen volledig leeg zijn als ze de functionaliteit volledig overnemen of als ze bepaalde aspecten van de component opnieuw kunnen definiëren.

Componentversie component-versioning

Componenten moeten in de loop der tijd volledig compatibel blijven, maar soms zijn wijzigingen die niet compatibel kunnen worden gehouden noodzakelijk. Één oplossing aan deze tegengestelde behoeften is component het versioning door een aantal in hun middel typepad toe te voegen, en in volledig - gekwalificeerde de klassennamen van Java van hun implementaties te introduceren. Dit versienummer vertegenwoordigt een hoofdversie zoals gedefinieerd door semantische versierichtlijnen, die alleen wordt verhoogd voor wijzigingen die niet compatibel zijn met oudere versies.

Niet-compatibele wijzigingen in de volgende aspecten van componenten resulteren in een nieuwe versie ervan:

Zie voor meer informatie de Versioningsbeleid document in GitHub.

De versioning van de component leidt tot een vorm van contract die voor verbeteringen belangrijk is aangezien het verduidelijkt wanneer iets zou kunnen moeten worden verfrist. Zie ook de sectie Compatibiliteit van aanpassingen upgraden, waarin wordt uitgelegd welke overwegingen verschillende aanpassingen vereisen voor een upgrade.

Om pijnlijke inhoudsmigraties te vermijden, is het belangrijk om aan versioned componenten van inhoudsmiddelen nooit direct te richten. Als vuistregel geldt dat een sling:resourceType van de inhoud mag er nooit een versienummer in staan of voor het upgraden van componenten moet de inhoud ook opnieuw worden bekeken. De beste manier om dit te voorkomen is het volgen van de Proxycomponentpatroon hierboven beschreven.

Modelinterfaces model-interfaces

Dit patroon gaat over HTML data-sly-use instructie om naar een Java-interface te wijzen, terwijl de implementatie van het Sling Model ook wordt geregistreerd naar het bronnentype van de component.

Indien gecombineerd met de Proxycomponentpatroon Hierboven beschreven, biedt deze vorm van dubbel-bindende aanbiedingen volgende aardige uitbreidingspunten:

Alles samenvoegen putting-it-all-together

Hieronder volgt een overzicht van het volledige middeltype bindingsstructuur, die het voorbeeld van de Component van de Kern van de Titel neemt. Het illustreert hoe een plaats-specifieke volmachtscomponent toestaat om componentenversioning op te lossen, om te vermijden dat het inhoudsmiddel om het even welk versieaantal bevat. Vervolgens wordt getoond hoe de component title.html HTL het dossier gebruikt aan de modelinterface, terwijl de implementatie aan de specifieke versie van de component door bindt Verkoopmodel annotaties.

Hieronder volgt een ander overzicht, dat niet de details van de implementatie POJO toont, maar onthult hoe geassocieerd sjablonen en beleidsregels worden genoemd.

De cq:allowedTemplates eigenschap bepaalt welke sjablonen voor een site kunnen worden gebruikt, en de cq:template geeft voor elke pagina aan wat de bijbehorende sjabloon is. Elke sjabloon bestaat uit de volgende drie delen:

Projectarchetype AEM aem-project-archetype

Het AEM Project Archetype leidt tot een minimaal Adobe Experience Manager project als uitgangspunt voor uw eigen projecten, met inbegrip van een voorbeeld van douaneHTML componenten met SlingModels voor de logica en juiste implementatie van de Componenten van de Kern met het geadviseerde volmachtspatroon.

Volgende lezen: