AEM ontwikkeling - Richtsnoeren en beste praktijken aem-development-guidelines-and-best-practices
Richtlijnen voor het gebruik van sjablonen en componenten guidelines-for-using-templates-and-components
Adobe Experience Manager (AEM)-componenten en -sjablonen vormen een krachtige toolkit. Ze kunnen door ontwikkelaars worden gebruikt om zakelijke gebruikers, editors en beheerders van websites de functionaliteit te bieden om hun websites aan te passen aan veranderende bedrijfsbehoeften (inhouds-behendigheid). Dit alles met behoud van de uniforme lay-out van de sites (merkbescherming).
Een typische uitdaging voor een persoon verantwoordelijk voor een website, of een reeks websites (bijvoorbeeld in een bijkantoor van een globale onderneming), is een nieuw type van inhoudspresentatie op hun websites te introduceren.
Laten we ervan uitgaan dat er een nieuwsbrief moet worden toegevoegd aan de websites, waarin uittreksels uit andere artikelen staan die al zijn gepubliceerd. De pagina moet hetzelfde ontwerp en dezelfde structuur hebben als de rest van de website.
De aanbevolen manier om een dergelijke uitdaging aan te gaan is:
- U kunt een bestaande sjabloon opnieuw gebruiken, zodat u een paginatype kunt maken. De sjabloon definieert grofweg de paginastructuur (navigatie-elementen, deelvensters, enzovoort), die verder wordt verfijnd door het ontwerp (CSS, afbeeldingen).
- Gebruik het paragraafsysteem (parsys/iparsys) op de nieuwe pagina's.
- Bepaal toegangsrecht tot de wijze van het Ontwerp van de paragraafsystemen, zodat slechts de gemachtigde mensen (gewoonlijk de beheerder) hen kunnen veranderen.
- Definieer de componenten die zijn toegestaan in het opgegeven alineasysteem, zodat editors de vereiste componenten op de pagina kunnen plaatsen. In dit geval kan het een component List zijn, die een subboomstructuur van pagina's kan doorlopen en de informatie kan ophalen volgens vooraf gedefinieerde regels.
- Editors voegen en configureren de toegestane componenten toe op de pagina's waarvoor ze verantwoordelijk zijn, om de gevraagde functionaliteit (informatie) aan het bedrijf te leveren.
Dit illustreert hoe deze benadering de bijdragende gebruikers en beheerders van de website machtigt om snel aan bedrijfsbehoeften te antwoorden, zonder de betrokkenheid van ontwikkelingsteams te vereisen. Alternatieve methodes, zoals het creëren van een malplaatje, zijn gewoonlijk een dure oefening, die een veranderingsbeheersproces en betrokkenheid van het ontwikkelingsteam vereist. Dit maakt het hele proces langer en kostbaar.
De ontwikkelaars van op AEM gebaseerde systemen moeten daarom gebruik maken van:
- sjablonen en toegangsbeheer voor het ontwerpen van alineasystemen voor uniformiteit en merkbescherming
- alineasysteem, met inbegrip van de configuratieopties voor flexibiliteit.
De volgende algemene regels voor ontwikkelaars zijn zinvol voor de meest gebruikelijke projecten:
- Houd het aantal sjablonen laag - zo laag als het aantal fundamenteel verschillende paginastructuren op de websites.
- Verstrek de noodzakelijke flexibiliteit en configuratiemogelijkheden aan uw douanecomponenten.
- Maximaliseer gebruik van de macht en de flexibiliteit van het de paragraafsysteem van de AEM - parsys & iparsys componenten.
Componenten en andere elementen aanpassen customizing-components-and-other-elements
Wanneer u uw eigen componenten maakt of een bestaande component aanpast, is het vaak het eenvoudigst (en veiligst) om bestaande definities opnieuw te gebruiken. Dezelfde beginselen gelden ook voor andere elementen binnen AEM, bijvoorbeeld de fouthandler.
Dit kan worden gedaan door de bestaande definitie te kopiëren en te bedekken. Met andere woorden, het kopiëren van de definitie van /libs naar /apps/<your-project> . Deze nieuwe definitie, in /apps, kan volgens uw vereisten worden bijgewerkt.
Bijvoorbeeld:
-
Hiervoor moest een componentdefinitie worden bedekt:
-
Maak een componentmap in
/apps/<website-name>/components/<MyComponent>door een bestaande component te kopiëren:-
Bijvoorbeeld om het de componentenexemplaar van de Tekst aan te passen:
- Van
/libs/foundation/components/text - tot
/apps/myProject/components/text
- Van
-
-
-
Pagina's aanpassen die worden weergegeven door de fouthandler
In dit geval wordt een servlet bedekt:
-
Kopieer een of meer standaardscripts in de opslagplaats:
- Van
/libs/sling/servlet/errorhandler/ - tot
/apps/sling/servlet/errorhandler/
- Van
-
/libs weg./libs de volgende keer dat u een upgrade uitvoert van uw exemplaar, wordt overschreven (en dat deze inhoud ook kan worden overschreven wanneer u een hotfix- of functiepakket toepast).- het item kopiëren in
/libsnaar/apps - om het even welke veranderingen aanbrengen binnen
/apps
Wanneer moeten JCR-query's worden gebruikt en wanneer moeten deze niet worden gebruikt? when-to-use-jcr-queries-and-when-not-to-use-them
JCR-query's zijn een krachtig hulpmiddel als ze correct worden uitgevoerd. Zij zijn geschikt voor:
-
echte eindgebruikervragen, zoals fullText onderzoeken op inhoud.
-
gevallen waarin gestructureerde inhoud moet worden gevonden in de gehele gegevensopslagruimte.
In dergelijke gevallen, zorg ervoor dat de vragen slechts wanneer vereist lopen. Bijvoorbeeld bij componentactivering of cachevalidatie (in tegenstelling tot bijvoorbeeld Workflows Stappen, Gebeurtenishandlers die worden geactiveerd bij inhoudswijzigingen en Filters).
Gebruik nooit JCR-query's voor pure rendering-aanvragen. JCR-query's zijn bijvoorbeeld niet geschikt voor het volgende:
- renderingnavigatie
- een overzicht maken van de 10 meest recente nieuwsartikelen
- het tonen van tellingen van inhoudspunten
Gebruik voor het renderen van inhoud navigatie-toegang tot de inhoudsstructuur in plaats van een JCR-query uit te voeren.
Beveiligingsoverwegingen security-considerations
JCR-sessies (Repository) jcr-repository-sessions
Gebruik de gebruikerssessie, niet de beheersessie. Dit betekent dat u het volgende moet gebruiken:
slingRequest.getResourceResolver().adaptTo(Session.class);
Protect tegen XSS (Cross-Site Scripting) protect-against-cross-site-scripting-xss
Met XSS (Cross-site scripting) kunnen aanvallers code injecteren in webpagina's die door andere gebruikers worden weergegeven. Deze kwetsbaarheid op het gebied van beveiliging kan door kwaadaardige webgebruikers worden misbruikt om toegangsbesturingselementen te omzeilen.
AEM past het beginsel toe van het filtreren van alle gebruiker-geleverde inhoud op output. Het voorkomen van XSS krijgt de hoogste prioriteit tijdens zowel ontwikkeling als testen.
Ook, kan een firewall van de Webtoepassing, zoals mod_security voor Apache, betrouwbare, centrale controle over de veiligheid van het plaatsingsmilieu verstrekken en tegen eerder onontdekte dwars-plaats scripting aanvallen beschermen.
Het XSS API-taakblad bevat informatie waarvan u moet weten dat u de XSS-API kunt gebruiken en een AEM-app veiliger kunt maken. U kunt het hier downloaden:
Het XSSAPI-controleblad.
Communicatie beveiligen voor vertrouwelijke informatie securing-communication-for-confidential-information
Bij elke internettoepassing moet u ervoor zorgen dat bij het vervoer van vertrouwelijke informatie
- verkeer wordt beveiligd via SSL
- Indien van toepassing wordt HTTP-POST gebruikt
Dit geldt voor informatie die vertrouwelijk is voor het systeem (zoals configuratie of administratieve toegang) en informatie die vertrouwelijk is voor de gebruikers (zoals hun persoonlijke gegevens).
Specifieke ontwikkelingstaken distinct-development-tasks
Foutpagina's aanpassen customizing-error-pages
Foutpagina's kunnen voor AEM worden aangepast. Dit is aan te raden, zodat de instantie geen bewegingssporen weergeeft bij interne serverfouten.
Zie Aanpassen van de Pagina's van de Fout die door de Handler van de Foutvoor volledige details worden getoond.
Bestanden openen in het Java™-proces open-files-in-the-java-process
Omdat AEM tot vele dossiers kan toegang hebben, wordt het geadviseerd dat het aantal open dossiers voor een proces Java™uitdrukkelijk voor AEM worden gevormd.
Om dit probleem tot een minimum te beperken, moet bij de ontwikkeling ervoor worden gezorgd dat geopende bestanden correct worden gesloten wanneer dat (zinvol) mogelijk is.