Introduktion intro

Trafiken passerar genom CDN till ett Apache-webbserverlager som stöder moduler som Dispatcher. För att öka prestandan används Dispatcher främst som ett cacheminne för att begränsa bearbetningen av publiceringsnoderna.
Regler kan tillämpas på Dispatcher-konfigurationen för att ändra standardinställningarna för cacheförfallotid, vilket resulterar i cachelagring vid CDN. Dispatcher respekterar även de cacheförfallorubriker som skapas om enableTTL är aktiverat i Dispatcher-konfigurationen, vilket innebär att det uppdaterar visst innehåll även utanför det innehåll som publiceras om.

På den här sidan beskrivs också hur cacheminnet i Dispatcher ogiltigförklaras och hur cachning fungerar på webbläsarnivå för bibliotek på klientsidan.

Cachning caching

HTML/text html-text

  • som standard cachelagras av webbläsaren i fem minuter, baserat på det cache-control-huvud som skickas från Apache-lagret. CDN respekterar också detta värde.
  • standardinställningen för cachning mellan HTML/text kan inaktiveras genom att variabeln DISABLE_DEFAULT_CACHING definieras i global.vars:
Define DISABLE_DEFAULT_CACHING

Den här metoden är till exempel användbar när din affärslogik kräver finjustering av sidhuvudet (med ett värde som baseras på kalenderdag) eftersom sidhuvudet som standard är 0. Var försiktig när du stänger av standardcachelagring.

  • kan åsidosättas för allt HTML/Text-innehåll genom att definiera variabeln EXPIRATION_TIME i global.vars med AEM as a Cloud Service SDK Dispatcher-verktygen.

  • kan åsidosättas på en mer detaljerad nivå, inklusive kontroll av CDN och webbläsarcache separat, med följande Apache mod_headers-direktiv:

    code language-none
    <LocationMatch "^/content/.*\.(html)$">
         Header set Cache-Control "max-age=200"
         Header set Surrogate-Control "max-age=3600"
         Header set Age 0
    </LocationMatch>
    
    note note
    NOTE
    Rubriken Surrogate-Control gäller för CDN som hanteras av Adobe. Om du använder ett kundhanterat CDN kan ett annat huvud behövas beroende på din CDN-leverantör.

    Var försiktig när du anger rubriker för global cachekontroll eller liknande cacherubriker som matchar ett brett register så att de inte tillämpas på innehåll som du måste behålla privat. Överväg att använda flera direktiv för att säkerställa att reglerna tillämpas på ett detaljerat sätt. AEM as a Cloud Service tar därför bort cachehuvudet om det upptäcker att det har tillämpats på det som Dispatcher inte kan tolka, vilket beskrivs i Dispatcher-dokumentationen. Om du vill tvinga AEM att alltid använda cachelagringshuvuden kan du lägga till alternativet always enligt följande:

    code language-none
    <LocationMatch "^/content/.*\.(html)$">
         Header unset Cache-Control
         Header unset Expires
         Header always set Cache-Control "max-age=200"
         Header set Age 0
    </LocationMatch>
    

    Kontrollera att en fil under src/conf.dispatcher.d/cache har följande regel (som finns i standardkonfigurationen):

    code language-none
    /0000
    { /glob "*" /type "allow" }
    
  • Om du vill förhindra att specifikt innehåll cachelagras vid CDN anger du rubriken Cache-Control till private. Följande förhindrar till exempel att HTML-innehåll under en katalog med namnet secure cachas vid CDN:

    code language-none
       <LocationMatch "/content/secure/.*\.(html)$">.  // replace with the right regex
       Header unset Cache-Control
       Header unset Expires
       Header always set Cache-Control "private"
      </LocationMatch>
    
  • HTML-innehåll som är inställt på privat cachelagras inte i CDN, men det kan cachas i Dispatcher om Behörighetskänslig cachelagring är konfigurerad, vilket säkerställer att endast behöriga användare kan betjäna innehållet.

    note note
    NOTE
    De andra metoderna, inklusive Dispatcher-ttl AEM ACS Commons-projektet, åsidosätter inte värdena.
    note note
    NOTE
    Dispatcher kan fortfarande cachelagra innehåll enligt sina egna cachelagringsregler. Om du vill göra innehållet helt privat ser du till att det inte cachas av Dispatcher.

Klientbibliotek (js, css) client-side-libraries

  • När du använder AEM biblioteksramverk på klientsidan genereras JavaScript- och CSS-kod på ett sådant sätt att webbläsare kan cachelagra den i oändlighet, eftersom alla ändringar visas som nya filer med en unik sökväg. HTML som refererar till klientbiblioteken skapas med andra ord efter behov så att kunderna kan uppleva nytt innehåll när det publiceras. Cachekontrollen är inställd på"oföränderlig" eller 30 dagar för äldre webbläsare som inte respekterar det oföränderliga" värdet.
  • Mer information finns i avsnittet Bibliotek på klientsidan och versionskonsekvens.

Bilder och allt innehåll som är tillräckligt stort för att lagras i blob images

Standardbeteendet för program som skapats efter mitten av maj 2022 (särskilt för program-ID som är högre än 65000) är att cachelagra som standard, samtidigt som autentiseringskontexten för begäran respekteras. Äldre program (program-ID som är lika med eller lägre än 65000) cache-lagrar inte blobbinnehåll som standard.

I båda fallen kan cachelagringshuvuden åsidosättas på en mer detaljerad nivå i lagret Apache/Dispatcher genom att använda Apache mod_headers-direktiven, till exempel:

   <LocationMatch "^/content/.*\.(jpeg|jpg)$">
     Header set Cache-Control "max-age=222"
     Header set Age 0
   </LocationMatch>

Var försiktig så att du inte cachelagrar för mycket när du ändrar cache-rubrikerna i Dispatcher-lagret. Mer information finns i avsnittet HTML/text ovan. Se även till att resurser som ska hållas privata (i stället för cachelagrade) inte ingår i LocationMatch-direktivets filter.

JCR-resurser (större än 16 kB) som lagras i blobbutiken hanteras vanligtvis som 302 omdirigeringar av AEM. Dessa omdirigeringar fångas upp och följs av CDN och innehållet levereras direkt från blobbbutiken. Endast en begränsad uppsättning rubriker kan anpassas för dessa svar. Om du till exempel vill anpassa Content-Disposition bör du använda dispatcherdirektiven på följande sätt:

<LocationMatch "\.(?i:pdf)$">
  ForceType application/pdf
  Header set Content-Disposition inline
  </LocationMatch>

Listan med rubriker som kan anpassas för blobbsvar är:

content-security-policy
x-frame-options
x-xss-protection
x-content-type-options
x-robots-tag
access-control-allow-origin
content-disposition
permissions-policy
referrer-policy
x-vhost
content-disposition
cache-control
vary

Nytt standardbeteende för cachelagring new-caching-behavior

AEM anger cacherubriker beroende på om cachehuvudet redan har angetts och värdet för begärandetypen. Om ingen cache-kontrollrubrik har angetts cachelagras offentligt innehåll och autentiserad trafik anges till privat. Om en cache-kontrollrubrik anges ändras inte cacherubrikerna.

Cachekontrollhuvud finns?
Typ av begäran
AEM anger cacherubriker till
Nej
public
Cache-Control: public, max-age=600, oföränderlig
Nej
autentiserad
Cache-Control: private, max-age=600, oföränderlig
Ja
alla
oförändrad

Även om det inte rekommenderas går det att ändra det nya standardbeteendet så att det följer det äldre beteendet (program-ID som är lika med eller lägre än 65000) genom att ange Cloud Manager-miljövariabeln AEM_BLOB_ENABLE_CACHING_HEADERS till false.

Äldre standardbeteende för cachelagring old-caching-behavior

Det AEM lagret cache-lagrar inte blobbinnehåll som standard.

NOTE
Ändra det äldre standardbeteendet så att det överensstämmer med det nya beteendet (program-ID som är högre än 65000) genom att ange Cloud Manager-miljövariabeln AEM_BLOB_ENABLE_CACHING_HEADERS som true. Om programmet redan är öppet kontrollerar du att innehållet fungerar som du tänkt dig efter ändringarna.

Nu går det inte att cachelagra bilder i bloblagring som markerats som privata på Dispatcher med Behörighetskänslig cachelagring. Bilden efterfrågas alltid från AEM ursprung och hanteras om användaren är behörig.

NOTE
De andra metoderna, inklusive dispatcher-ttl AEM ACS Commons-projektet, åsidosätter inte värdena.

Andra innehållsfiltyper i nodarkivet other-content

  • ingen standardcachelagring
  • standard kan inte anges med variabeln EXPIRATION_TIME som används för HTML-/textfiltyper
  • cacheminnets förfallotid kan anges med samma LocationMatch-strategi som beskrivs i avsnittet html/text genom att ange lämplig regex

Ytterligare optimeringar further-optimizations

  • Undvik att använda User-Agent som en del av rubriken Vary. Äldre versioner av Dispatcher-standardinställningen (före arkivtypsversion 28) innehöll den och Adobe rekommenderar att du tar bort den genom att följa stegen nedan.

    • Leta reda på värdfilerna i <Project Root>/dispatcher/src/conf.d/available_vhosts/*.vhost
    • Ta bort eller kommentera ut raden: Header append Vary User-Agent env=!dont-vary från alla värdfiler, förutom default.vhost, som är skrivskyddad
  • Använd rubriken Surrogate-Control för att kontrollera CDN-cachning oberoende av webbläsarcachning

  • Överväg att tillämpa direktiven stale-while-revalidate och stale-if-error för att tillåta bakgrundsuppdatering och undvika cachemissar, så att innehållet hålls snabbt och uppdaterat för användarna.

    • Det finns många sätt att tillämpa de här direktiven, men att lägga till en 30-minuters stale-while-revalidate till alla cachekontrollhuvuden är en bra startpunkt.
  • Några exempel följer för olika innehållstyper, som kan användas som vägledning när du ställer in egna cachningsregler. Fundera noggrant på och testa dina specifika inställningar och krav:

    • Cachelagra biblioteksresurser för ändringsbara klienter i 12 timmar och bakgrundsuppdatering efter 12 timmar.

      code language-none
      <LocationMatch "^/etc\.clientlibs/.*\.(?i:json|png|gif|webp|jpe?g|svg)$">
         Header set Cache-Control "max-age=43200,stale-while-revalidate=43200,stale-if-error=43200,public" "expr=%{REQUEST_STATUS} < 400"
         Header set Age 0
      </LocationMatch>
      
    • Cachelagra oföränderliga biblioteksresurser på lång sikt (30 dagar) med bakgrundsuppdatering för att undvika MISS.

      code language-none
      <LocationMatch "^/etc\.clientlibs/.*\.(?i:js|css|ttf|woff2)$">
         Header set Cache-Control "max-age=2592000,stale-while-revalidate=43200,stale-if-error=43200,public,immutable" "expr=%{REQUEST_STATUS} < 400"
         Header set Age 0
      </LocationMatch>
      
    • Cachelagra HTML-sidor i fem minuter med bakgrundsuppdatering en timme i webbläsaren och 12 timmar i CDN. Cache-Control-rubriker läggs alltid till så det är viktigt att se till att matchande HTML-sidor under /content/* är avsedda att vara offentliga. Om så inte är fallet bör du överväga att använda en mer specifik regex.

      code language-none
      <LocationMatch "^/content/.*\.html$">
         Header unset Cache-Control
         Header always set Cache-Control "max-age=300,stale-while-revalidate=3600" "expr=%{REQUEST_STATUS} < 400"
         Header always set Surrogate-Control "stale-while-revalidate=43200,stale-if-error=43200" "expr=%{REQUEST_STATUS} < 400"
         Header set Age 0
      </LocationMatch>
      
    • Cachelagra innehållstjänster/Sling-modellexporterarens json-svar i fem minuter med bakgrundsuppdatering en timme i webbläsaren och 12 timmar i CDN.

      code language-none
      <LocationMatch "^/content/.*\.model\.json$">
         Header set Cache-Control "max-age=300,stale-while-revalidate=3600" "expr=%{REQUEST_STATUS} < 400"
         Header set Surrogate-Control "stale-while-revalidate=43200,stale-if-error=43200" "expr=%{REQUEST_STATUS} < 400"
         Header set Age 0
      </LocationMatch>
      
    • Cachelagra oföränderliga URL:er från huvudbildkomponenten på lång sikt (30 dagar) med bakgrundsuppdatering för att undvika MISS.

      code language-none
      <LocationMatch "^/content/.*\.coreimg.*\.(?i:jpe?g|png|gif|svg)$">
         Header set Cache-Control "max-age=2592000,stale-while-revalidate=43200,stale-if-error=43200,public,immutable" "expr=%{REQUEST_STATUS} < 400"
         Header set Age 0
      </LocationMatch>
      
    • Cachelagra oföränderliga resurser från DAM som bilder och video i 24 timmar och uppdatera bakgrunden efter 12 timmar för att undvika MISS.

      code language-none
      <LocationMatch "^/content/dam/.*\.(?i:jpe?g|gif|js|mov|mp4|png|svg|txt|zip|ico|webp|pdf)$">
         Header set Cache-Control "max-age=43200,stale-while-revalidate=43200,stale-if-error=43200" "expr=%{REQUEST_STATUS} < 400"
         Header set Age 0
      </LocationMatch>
      

Analyserar CDN-cacheträffrekvens analyze-chr

I självstudiekursen cache-hit för analys av träffkvot finns information om hur du hämtar CDN-loggar och analyserar webbplatsens cachekvot med hjälp av en instrumentpanel.

HEAD beteende vid begäran request-behavior

När en begäran från HEAD tas emot i CDN i Adobe för en resurs som inte är cachelagrad, omvandlas begäran och tas emot av Dispatcher- och/eller AEM-instansen som en GET-begäran. Om svaret är tillgängligt kan efterföljande förfrågningar från HEAD besvaras av CDN. Om svaret inte är tillgängligt skickas efterföljande HEAD-begäranden till Dispatcher- eller AEM-instansen, eller båda, under en tid som beror på Cache-Control-TTL:n.

Parametrar för marknadsföringskampanjer marketing-parameters

Webbplatsadresser innehåller ofta marknadsföringskampanjparametrar som används för att spåra en kampanjs framgång.

För miljöer som skapats i oktober 2023 eller senare kommer CDN att ta bort vanliga marknadsföringsrelaterade frågeparametrar, särskilt de som matchar följande regex-mönster, för att bättre cachelagra begäranden:

^(utm_.*|gclid|gdftrk|_ga|mc_.*|trk_.*|dm_i|_ke|sc_.*|fbclid)$

Skicka en supportanmälan om du vill att det här beteendet ska inaktiveras.

För miljöer som skapats före oktober 2023 bör du konfigurera Dispatcher-konfigurationens ignoreUrlParams-egenskap enligt dokumenteras här.

Det finns två möjligheter att ignorera marknadsföringsparametrar. (Där den första är att föredra att ignorera cachebusting via frågeparametrar):

  1. Ignorera alla parametrar och tillåt selektivt parametrar som används.
    I följande exempel ignoreras bara parametrarna page och product och förfrågningarna vidarebefordras till utgivaren.
/ignoreUrlParams {
   /0001 { /glob "*" /type "allow" }
   /0002 { /glob "page" /type "deny" }
   /0003 { /glob "product" /type "deny" }
}
  1. Tillåt alla parametrar utom marknadsföringsparametrarna. Filen marketing_query_parameters.any definierar en lista över vanliga marknadsföringsparametrar som kommer att ignoreras. Adobe kommer inte att uppdatera den här filen. Den kan utökas av användare beroende på vilka marknadsföringsleverantörer de har.
/ignoreUrlParams {
   /0001 { /glob "*" /type "deny" }
   $include "../cache/marketing_query_parameters.any"
}

Invalidering av Dispatcher Cache disp

Vanligtvis behöver du inte göra Dispatcher-cachen ogiltig. Du bör i stället förlita dig på att Dispatcher uppdaterar sin cache när innehåll publiceras om och att CDN respekterar förfallorubriker för cachen.

Invalidering av Dispatcher-cache vid aktivering/inaktivering cache-activation-deactivation

Precis som i tidigare versioner av AEM rensas innehållet från Dispatcher cache när du publicerar eller avpublicerar sidor. Om ett problem med cachelagring misstänks bör du publicera om sidorna i fråga och se till att det finns en virtuell värd som matchar den ServerAlias-språkvärden, vilket krävs för att Dispatcher-cachen ska ogiltigförklaras.

NOTE
För att Dispatcher ska bli korrekt måste du se till att begäranden från"127.0.0.1","localhost","*.local", "*.adobeaemcloud.com" och "*.adobeaemcloud.net" matchas och hanteras av en värdkonfiguration så att begäran kan hanteras. Du kan utföra den här aktiviteten genom att globalt matcha "*" i en konfiguration som fångar upp alla värden enligt mönstret i referensens AEM arkivtyp. Du kan också se till att den tidigare nämnda listan fångas av någon av värdarna.

När publiceringsinstansen tar emot en ny version av en sida eller en resurs från författaren, används justeringsagenten för att göra lämpliga sökvägar ogiltiga i dess Dispatcher. Den uppdaterade sökvägen tas bort från Dispatcher-cachen, tillsammans med dess överordnade objekt, upp till en nivå (du kan konfigurera den här nivån med statusfilnivå).

Explicit ogiltigförklaring av Dispatcher-cachen explicit-invalidation

Adobe rekommenderar att du använder standardcache-huvuden för att styra innehållets leveranslivscykel. Om det behövs kan du emellertid göra innehåll ogiltigt direkt i Dispatcher.

Följande lista innehåller scenarier där du kanske vill göra cachen ogiltig (men avlyssna när ogiltigförklaringen har slutförts):

  • Efter publicering av innehåll som upplevelsefragment eller innehållsfragment blir publicerat och cachelagrat innehåll som refererar till dessa element ogiltigt.
  • Meddela ett externt system när refererade sidor har ogiltigförklarats.

Det finns två sätt att göra cacheminnet explicit ogiltigt:

  • Det bästa sättet är att använda Sling Content Distribution (SCD) från författaren.
  • Den andra metoden är att använda replikerings-API:t för att anropa den publicerade Dispatcher-replikeringsagenten.

Metoderna skiljer sig åt när det gäller tillgång till nivån, möjlighet att deduplicera händelser och händelsebearbetningsgaranti. Tabellen nedan sammanfattar dessa alternativ:

Ej tillämpligt
Tillgång till nivån
Deduplicering
Garanti
Åtgärd
Effekt
Beskrivning
Sling Content Distribution (SCD) API
Författare
Möjligt med antingen identifierings-API:t eller genom att aktivera dedupliceringsläget.
Minst en gång.
  1. LÄGG TILL
  2. DELETE
  3. OGILTIG
  1. Hierarkisk/stationär nivå
  2. Hierarkisk/stationär nivå
  3. Endast nivå-resurs
  1. Publicerar innehåll och gör cachen ogiltig.
  2. Tar bort innehåll och gör cachen ogiltig.
  3. Gör innehållet ogiltigt utan att publicera det.
Replikerings-API
Publish
Inte möjligt, händelse som aktiveras för varje publiceringsinstans.
Bästa försök.
  1. AKTIVERA
  2. INAKTIVERA
  3. DELETE
  1. Hierarkisk/stationär nivå
  2. Hierarkisk/stationär nivå
  3. Hierarkisk/stationär nivå
  1. Publicerar innehåll och gör cachen ogiltig.

  2. Från författare/Publish-nivå - Tar bort innehåll och gör cachen ogiltig.

  3. Från författarnivå - Tar bort innehåll och gör cachen ogiltig (om den aktiveras från AEM författarnivå på Publish-agenten).

    Från Publish-nivå - Invaliderar endast cachen (om den aktiveras från AEM Publish-nivå i agenten för tömning eller tömning enbart med resurs).

De två åtgärder som är direkt relaterade till cacheogiltigförklaring är API-inaktivering för Sling Content Distribution (SCD) och replikerings-API.

I tabellen kan du även se följande:

  • SCD API behövs när varje händelse måste garanteras, till exempel synkronisering med ett externt system som kräver korrekt kunskap. Om det finns en publiceringsnivåuppskalningshändelse vid tidpunkten för ogiltigförklaringsanropet, utlöses en extra händelse när varje ny publiceringsnivå bearbetar ogiltigförklaringen.

  • Det är inte vanligt att använda replikerings-API:t, men det kan användas om utlösaren för att göra cachen ogiltig kommer från publiceringsskiktet och inte från författarskiktet. Den här metoden kan vara användbar om Dispatcher TTL har konfigurerats.

Sammanfattningsvis, om du vill göra Dispatcher-cachen ogiltig, rekommenderar vi att du använder SCD API-åtgärden Ovalidate från författare. Du kan också lyssna efter händelsen så att du sedan kan utlösa ytterligare åtgärder längre fram.

Sling Content Distribution (SCD) sling-distribution

NOTE
När du använder instruktionerna nedan testar du den anpassade koden i en AEM Cloud Service Dev-miljö och inte lokalt.

När du använder SCD-åtgärden från författaren ser implementeringsmönstret ut så här:

  1. Skriv anpassad kod från författaren för att anropa sling-innehållsdistributionen API och skicka invalidate-åtgärden med en lista över sökvägar:
@Reference
private Distributor distributor;

ResourceResolver resolver = ...; // the resource resolver used for authorizing the request
String agentName = "publish";    // the name of the agent used to distribute the request

String pathToInvalidate = "/content/to/invalidate";
DistributionRequest distributionRequest = new SimpleDistributionRequest(DistributionRequestType.INVALIDATE, false, pathToInvalidate);
distributor.distribute(agentName, resolver, distributionRequest);
  • (Valfritt) Lyssna efter en händelse som återspeglar den resurs som ogiltigförklaras för alla Dispatcher-instanser:
package org.apache.sling.distribution.journal.shared;

import org.apache.sling.discovery.DiscoveryService;
import org.apache.sling.distribution.journal.impl.event.DistributionEvent;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.event.Event;
import org.osgi.service.event.EventHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static org.apache.sling.distribution.DistributionRequestType.INVALIDATE;
import static org.apache.sling.distribution.event.DistributionEventProperties.DISTRIBUTION_PATHS;
import static org.apache.sling.distribution.event.DistributionEventProperties.DISTRIBUTION_TYPE;
import static org.apache.sling.distribution.event.DistributionEventTopics.AGENT_PACKAGE_DISTRIBUTED;
import static org.osgi.service.event.EventConstants.EVENT_TOPIC;

@Component(immediate = true, service = EventHandler.class, property = {
        EVENT_TOPIC + "=" + AGENT_PACKAGE_DISTRIBUTED
})
public class InvalidatedHandler implements EventHandler {
    private static final Logger LOG = LoggerFactory.getLogger(InvalidatedHandler.class);

    @Reference
    private DiscoveryService discoveryService;

    @Override
    public void handleEvent(Event event) {

        String distributionType = (String) event.getProperty(DISTRIBUTION_TYPE);

        if (INVALIDATE.name().equals(distributionType)) {
            boolean isLeader = discoveryService.getTopology().getLocalInstance().isLeader();
            // process the OSGi event on the leader author instance
            if (isLeader) {
                String[] paths = (String[]) event.getProperty(DISTRIBUTION_PATHS);
                String packageId = (String) event.getProperty(DistributionEvent.PACKAGE_ID);
                invalidated(paths, packageId);
            }
        }
    }

    private void invalidated(String[] paths, String packageId) {
        // custom logic
        LOG.info("Successfully applied package with id {}, paths {}", packageId, paths);
    }
}
  • (Valfritt) Kör affärslogik i metoden invalidated(String[] paths, String packageId) ovan.
NOTE
CDN i Adobe rensas inte när Dispatcher ogiltigförklaras. CDN som hanteras av Adobe respekterar TTL:er och behöver därför inte tömmas.

Replikerings-API replication-api

Nedan visas implementeringsmönstret när åtgärden för inaktivering av replikerings-API används:

  1. Anropa replikerings-API:t på publiceringsnivån för att utlösa den publicerade Dispatcher flush-replikeringsagenten.

Slutpunkten för rensningsagenten kan inte konfigureras utan är i stället förkonfigurerad så att den pekar på Dispatcher, och matchas med publiceringstjänsten som körs tillsammans med tömningsagenten.

Flush-agenten kan oftast aktiveras av anpassad kod som baseras på OSGi-händelser eller arbetsflöden.

String[] paths = …
ReplicationOptions options = new ReplicationOptions();
options.setSynchronous(true);
options.setFilter( new AgentFilter {
  public boolean isIncluded (Agent agent) {
   return agent.getId().equals("flush");
  }
});

Replicator.replicate (session,ReplicationActionType.DELETE,paths, options);

Bibliotek på klientsidan och versionskonsekvens content-consistency

Sidorna består av HTML, JavaScript, CSS och bilder. Kunder uppmuntras att använda ramverket Klientbibliotek (klientlibs) för att importera JavaScript- och CSS-resurser till HTML-sidor, vilket anger beroenden mellan JS-bibliotek.

Med clientlibs Framework får du automatisk versionshantering. Det innebär att utvecklare kan checka in ändringar i JS-bibliotek i källkontrollen och att den senaste versionen blir tillgänglig när kunden publicerar sin release. Utan det här arbetsflödet måste utvecklare ändra HTML manuellt med referenser till den nya versionen av biblioteket, vilket är särskilt betungande om samma bibliotek delar många HTML-mallar.

När de nya versionerna av biblioteken släpps i produktion uppdateras de refererande HTML-sidorna med nya länkar till de uppdaterade biblioteksversionerna. När webbläsarcachen har upphört att gälla för en viss HTML-sida behöver du inte bekymra dig om att de gamla biblioteken läses in från webbläsarens cacheminne. Orsaken är att den uppdaterade sidan (från AEM) nu garanterat refererar till de nya versionerna av biblioteken. Det vill säga att en uppdaterad HTML-sida innehåller alla de senaste biblioteksversionerna.

Mekanismen bakom den här funktionen är en serialiserad hash som läggs till i klientbibliotekslänken. Den ser till att webbläsaren har en unik versionsadress för att cachelagra CSS/JS. Den serialiserade hashen uppdateras bara när innehållet i klientbiblioteket ändras. Det innebär att om det inte sker några ändringar (det vill säga om klientbibliotekets underliggande css/js ändras) även om det finns en ny distribution, förblir referensen densamma. Det säkerställer i sin tur färre avbrott i webbläsarens cache.

Aktivera Longcache-versioner av klientbibliotek - AEM as a Cloud Service SDK QuickStart enabling-longcache

Standardversionen av Clientlib som finns på en HTML-sida ser ut som i följande exempel:

<link rel="stylesheet" href="/etc.clientlibs/wkndapp/clientlibs/clientlib-base.css" type="text/css">

När strikt klientlib-versionshantering är aktiverad läggs en långsiktig hash-nyckel till som väljare i klientbiblioteket. Därför ser clientlib-referensen ut så här:

<link rel="stylesheet" href="/etc.clientlibs/wkndapp/clientlibs/clientlib-base.lc-7c8c5d228445ff48ab49a8e3c865c562-lc.css" type="text/css">

Strikta versioner av klientlib är aktiverat som standard i alla AEM as a Cloud Service-miljöer.

Så här aktiverar du strikt versionshantering av klientlib i den lokala SDK QuickStart:

  1. Navigera till OSGi Configuration Manager <host>/system/console/configMgr

  2. Hitta OSGi Config för Adobe Granite HTML Library Manager:

    • Markera kryssrutan så att Strikta versionshantering aktiveras
    • I fältet Långsiktig cachenyckel på klientsidan anger du värdet för /.*;hash
  3. Spara ändringarna. Du behöver inte spara den här konfigurationen i källkontrollen eftersom AEM as a Cloud Service automatiskt aktiverar den här konfigurationen i miljöer med dev, stage och production.

  4. När innehållet i klientbiblioteket ändras skapas en ny hash-nyckel och HTML-referensen uppdateras.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab