Activation de la mise en cache du réseau CDN

Découvrez comment activer la mise en cache des réponses HTTP dans le réseau CDN d’AEM as a Cloud Service. La mise en cache des réponses est contrôlée par par les en-têtes de cache de réponse HTTP Cache-Control, Surrogate-Control ou Expires.

Ces en-têtes de cache sont généralement définis dans les configurations vhost du Dispatcher d’AEM à l’aide de mod_headers, mais peuvent également être définis dans du code Java™ personnalisé s’exécutant dans l’instance de publication AEM directement.

Comportement de mise en cache par défaut

Lorsque des configurations personnalisées NE sont PAS présentes, les valeurs par défaut sont utilisées. Dans la copie d’écran suivante, vous pouvez voir le comportement de mise en cache par défaut pour les instances de publication et de création AEM lors du déploiement d’un projet AEM mynewsite basé sur l’archétype de projet AEM.

Pour plus d’informations, consultez Instance de publication AEM – Durée de vie du cache par défaut et Instance de création AEM – Durée de vie du cache par défaut.

En résumé, AEM as a Cloud Service met en cache la plupart des types de contenu (HTML, JSON, JS, CSS et Assets) dans l’instance de publication AEM et quelques types de contenu (JS, CSS) dans l’instance de création AEM.

Activer la mise en cache

Pour modifier le comportement de mise en cache par défaut, vous pouvez mettre à jour les en-têtes de cache de deux façons.

Examinons chacune de ces options.

Configuration vhost du Dispatcher

Cette option est l’approche recommandée pour activer la mise en cache, mais elle n’est disponible que pour l’instance de publication AEM. Pour mettre à jour les en-têtes de cache, utilisez le module mod_headers et la directive <LocationMatch> dans le fichier vhost du serveur Apache HTTP. La syntaxe générale se présente comme suit :

<LocationMatch "$URL$ || $URL_REGEX$">
    # Removes the response header of this name, if it exists. If there are multiple headers of the same name, all will be removed.
    Header unset Cache-Control
    Header unset Surrogate-Control
    Header unset Expires

    # Instructs the web browser and CDN to cache the response for 'max-age' value (XXX) seconds. The 'stale-while-revalidate' and 'stale-if-error' attributes controls the stale state treatment at CDN layer.
    Header set Cache-Control "max-age=XXX,stale-while-revalidate=XXX,stale-if-error=XXX"

    # Instructs the CDN to cache the response for 'max-age' value (XXX) seconds. The 'stale-while-revalidate' and 'stale-if-error' attributes controls the stale state treatment at CDN layer.
    Header set Surrogate-Control "max-age=XXX,stale-while-revalidate=XXX,stale-if-error=XXX"

    # Instructs the web browser and CDN to cache the response until the specified date and time.
    Header set Expires "Sun, 31 Dec 2023 23:59:59 GMT"
</LocationMatch>

Le tableau suivant résume l’objectif de chaque en-tête et des attributs applicables pour l’en-tête.

Pour plus d’informations, consultez les détails de l’obsolescence et de la revalidation.

Exemple

Pour augmenter la durée de vie du navigateur web et du cache du réseau CDN du type de contenu HTML à 10 minutes sans traitement d’état obsolète, procédez comme suit :

Cependant, pour avoir des valeurs différentes pour la durée de vie du navigateur web et du cache du réseau CDN, vous pouvez utiliser l’en-tête Surrogate-Control dans l’exemple ci-dessus. De même, pour que le cache arrive à expiration à une date et une heure spécifiques, vous pouvez utiliser l’en-tête Expires. En outre, à l’aide des attributs stale-while-revalidate et stale-if-error, vous pouvez contrôler le traitement de l’état obsolète du contenu de la réponse. Le projet AEM WKND comporte une configuration du cache du réseau CDN de traitement de l’état obsolète de référence.

De même, vous pouvez mettre à jour les en-têtes de cache d’autres types de contenu (JSON, JS, CSS et Assets).

Code Java™ personnalisé

Cette option est disponible pour les instances de publication et de création AEM. Toutefois, il n’est pas recommandé d’activer la mise en cache dans l’instance de création AEM et de conserver le comportement de mise en cache par défaut.

Pour mettre à jour les en-têtes de cache, utilisez l’objet HttpServletResponse dans le code Java™ personnalisé (servlet Sling, filtre de servlet Sling). La syntaxe générale se présente comme suit :

// Instructs the web browser and CDN to cache the response for 'max-age' value (XXX) seconds. The 'stale-while-revalidate' and 'stale-if-error' attributes controls the stale state treatment at CDN layer.
response.setHeader("Cache-Control", "max-age=XXX,stale-while-revalidate=XXX,stale-if-error=XXX");

// Instructs the CDN to cache the response for 'max-age' value (XXX) seconds. The 'stale-while-revalidate' and 'stale-if-error' attributes controls the stale state treatment at CDN layer.
response.setHeader("Surrogate-Control", "max-age=XXX,stale-while-revalidate=XXX,stale-if-error=XXX");

// Instructs the web browser and CDN to cache the response until the specified date and time.
response.setHeader("Expires", "Sun, 31 Dec 2023 23:59:59 GMT");