はじめに

トラフィックは、CDN を経由して Apache Web サーバーレイヤーに渡されます。このレイヤーは、Dispatcher を含むモジュールをサポートします。パフォーマンスを向上させるために、主にキャッシュとして Dispatcher を使用し、パブリッシュノードでの処理を制限します。
Dispatcher 設定にルールを適用して、デフォルトのキャッシュ有効期限設定を変更すると、CDN でキャッシュできるようになります。Dispatcher の設定で enableTTL が有効な場合、Dispatcher は、結果として生成されるキャッシュの有効期限のヘッダーも順守することに注意してください。これは、再公開されているコンテンツ以外でも特定のコンテンツを更新することを意味します。

またこのページでは、Dispatcher キャッシュの無効化の方法、およびクライアントサイドライブラリに関するブラウザーレベルでのキャッシュの動作についても説明します。

キャッシュ

HTML/Text

• デフォルトでは、Apache レイヤーが送出する cache-control ヘッダーに基づいて、ブラウザーによって 5 分間キャッシュされます。CDN はこの値も順守します。
• デフォルトの HTML/Text キャッシュ設定は、global.vars で DISABLE_DEFAULT_CACHING 変数を次のように定義することで無効にできます。

Define DISABLE_DEFAULT_CACHING

これは、例えば、デフォルトで年齢ヘッダーが 0 に設定されているので、ビジネスロジックで（カレンダー日に基づいた値による）年齢ヘッダーの微調整が必要な場合に便利です。ただし、デフォルトのキャッシュをオフにする場合は注意が必要です。

• AEM as a Cloud Service の SDK Dispatcher ツールを使用して、global.vars の EXPIRATION_TIME 変数を定義することにより、すべての HTML/Text コンテンツに対して上書きできます。

• 次の Apache mod_headers ディレクティブを使用して、CDN とブラウザーキャッシュを個別に制御するなど、より細かいレベルでオーバーライドすることができます。

  <LocationMatch "^/content/.*\.(html)$">
       Header set Cache-Control "max-age=200"
       Header set Surrogate-Control "max-age=3600"
       Header set Age 0
  </LocationMatch>
  

  メモ

  サロゲート制御ヘッダーは、アドビが管理する CDN に適用されます。顧客が管理する CDN を使用する場合、CDN プロバイダーに応じて異なるヘッダーが必要になる場合があります。

  グローバルキャッシュコントロールヘッダーや、広範囲の正規表現に一致するヘッダーを設定する場合は、プライベートに保つ必要があるコンテンツに適用されないように注意が必要です。複数のディレクティブを使用して、ルールをきめ細かく適用することを検討してください。とは言え、Dispatcher のドキュメントに記載されているように、AEM as a Cloud Service は Dispatcher によってキャッシュ不可であることが検出されたものに対してキャッシュヘッダーが適用されていることを検出すると、キャッシュヘッダーを削除します。AEM で常にキャッシュヘッダーを適用するように強制するには、次のように always オプションを追加します。

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

  src/conf.dispatcher.d/cache の下のファイルに次のルール（デフォルト設定）があることを確認する必要があります。

  /0000
  { /glob "*" /type "allow" }
  

• 特定のコンテンツが CDN で​キャッシュされないようにするには、Cache-Control ヘッダーを private に設定します。例えば、次の例では、secure という名前のディレクトリ下の HTML コンテンツが CDN でキャッシュされないようにしています。

     <LocationMatch "/content/secure/.*\.(html)$">.  // replace with the right regex
     Header unset Cache-Control
     Header unset Expires
     Header always set Cache-Control "private"
    </LocationMatch>
  

• プライベートに設定された HTML コンテンツは CDN でキャッシュされませんが、権限に影響を受けるキャッシュが設定されている場合は Dispatcher でキャッシュでき、許可されたユーザーのみにコンテンツを提供できるようになります。

  メモ

  dispatcher-ttl AEM ACS Commons プロジェクトなどの他のメソッドでは、値は上書きされません。

  メモ

  Dispatcher は独自のキャッシュ ルールに従ってコンテンツをキャッシュする場合があることに注意してください。コンテンツを完全にプライベートにするには、Dispatcher によってコンテンツがキャッシュされないようにする必要があります。

クライアントサイドライブラリ（js、css）

• AEM のクライアントサイドライブラリフレームワークを使用する場合、変更があると一意のパスを持つ新しいファイルとして表現されるので、JavaScript と CSS コードはブラウザーが無期限にキャッシュできるような方法で生成されます。つまり、クライアントライブラリを参照する HTML は必要に応じて作成されるので、顧客は公開時に新しいコンテンツを体験できます。「immutable」値を考慮しない古いブラウザーでは、cache-control は「immutable」または 30 日に設定されます。
• 詳しくは、クライアントサイドライブラリとバージョンの整合性を参照してください。

BLOB ストレージに格納される大きい画像とコンテンツ

2022年5月中旬以降に作成されたプログラム（特に、プログラム ID が 65000 より大きい場合）のデフォルトの動作は、デフォルトでキャッシュされると同時に、リクエストの認証コンテキストも考慮されます。古いプログラム（プログラム ID が 65000 以下）は、デフォルトでは BLOB コンテンツをキャッシュしません。

どちらの場合も、キャッシュヘッダーは、Apache mod_headers ディレクティブを使用して、Apache／Dispatcher レイヤーでより細かいレベルでオーバーライドすることができます。次に例を示します。

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

Dispatcher レイヤーのキャッシュヘッダーを変更する場合は、あまり広くキャッシュしないように注意してください。上記の HTML/Text のセクションの説明を参照してください。また、（キャッシュせずに）非公開にするアセットが、LocationMatch ディレクティブフィルターの一部ではないことも確認してください。

新しいデフォルトのキャッシュ動作

AEM レイヤーは、キャッシュヘッダーの設定の有無、およびリクエストタイプの値に応じて、キャッシュヘッダーを設定します。キャッシュ制御ヘッダーが設定されていない場合、パブリックコンテンツはキャッシュされ、認証済みトラフィックはプライベートに設定されます。キャッシュコントロールヘッダーが設定されている場合、キャッシュヘッダーは変更されません。

推奨はしませんが、Cloud Manager の環境変数 AEM_BLOB_ENABLE_CACHING_HEADERS を false に設定することで、新しいデフォルトの動作を古い動作（プログラム ID が 65000 以下）に従うように変更することが可能です。

以前のデフォルトのキャッシュ動作

AEM レイヤーは、デフォルトでは BLOB コンテンツをキャッシュしません。

現在、プライベートとマークされた Blob ストレージ内の画像は、権限に影響を受けるキャッシュを使用して Dispatcher でキャッシュできません。画像は常に AEM 接触チャネルから要求され、ユーザーが承認されている場合に提供されます。

ノードストア内の他のコンテンツファイルタイプ

• デフォルトのキャッシュなし
• HTML／Text ファイルタイプに使用する EXPIRATION_TIME 変数はデフォルトに設定できません
• キャッシュの有効期限は、HTML/Text の節で説明したのと同じ LocationMatch 方法で、適切な正規表現を指定することで設定できます

その他の最適化

• User-Agent を Vary ヘッダーの一部として使用しないでください。（アーキタイプバージョン 28 以前）の古いバージョンのデフォルトの Dispatcher 設定にはこれが含まれていたため、次の手順を使用して削除することをお勧めします。

  • <Project Root>/dispatcher/src/conf.d/available_vhosts/*.vhost で vhost ファイルを見つけます。
  • すべての vhost ファイルから、Header append Vary User-Agent env=!dont-vary を行ごと削除またはコメントアウトします（読み取り専用の default.vhost を除く）。

• ブラウザーのキャッシュとは別に、CDN キャッシュを制御するために Surrogate-Control ヘッダーを使用します。

• stale-while-revalidate および stale-if-error ディレクティブを適用することで、バックグラウンドでの更新を可能にし、キャッシュミスを回避して、ユーザーにとって高速で最新のコンテンツを維持することを検討してください。

  • これらのディレクティブを適用する方法は多数ありますが、30 分の stale-while-revalidate をすべてのキャッシュ制御ヘッダーに追加することは、出発点として適切です。

• 様々なコンテンツタイプの例が次に示されています。これらは、独自のキャッシュルールを設定する際にガイドとして使用できます。具体的な設定と要件を慎重に検討し、テストしてください。

  • 可変クライアントライブラリリソースを 12 時間キャッシュし、12 時間後にバックグラウンド更新を行います。

    <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>
    

  • ミスを避けるために、不変のクライアントライブラリリソースをバックグラウンド更新で長期（30 日）にキャッシュします。

    <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>
    

  • HTML ページを 5 分間キャッシュし、バックグラウンド更新でブラウザーに 1 時間、CDN に 12 時間キャッシュします。Cache-Control ヘッダーは常に追加されるので、/content/* 下の一致する html ページが公開を意図したものであることが重要です。そうでない場合は、より詳細な正規表現の使用を検討してください。

    <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>
    

  • コンテンツサービス／Sling モデルエクスポーターの json レスポンスを 5 分間キャッシュし、バックグラウンド更新でブラウザーに 1 時間、CDN に 12 時間キャッシュします。

    <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>
    

  • ミスを避けるために、コア画像コンポーネントからの不変 URL をバックグラウンド更新で長期（30 日）にキャッシュします。

    <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>
    

  • ミスを避けるために、24 時間の画像やビデオなど、DAM の可変リソースをキャッシュし、12 時間後にバックグラウンド更新を行います

    <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>
    

HEAD リクエスト動作

キャッシュされて​いない​リソースに対する HEAD リクエストを Adobe CDN で受信すると、そのリクエストは Dispatcher や AEM インスタンスによって GET リクエストとして変換および受信されます。応答がキャッシュ可能な場合、以降の HEAD リクエストは CDN から提供されます。応答がキャッシュ可能でない場合、それ以降の HEAD リクエストは Cache-Control TTL に依存する期間、Dispatcher や AEM インスタンスに引き渡されます。

マーケティングキャンペーンパラメーター

Web サイトの URL には、キャンペーンの成功をトラックするために使用されるマーケティングキャンペーンパラメーターが含まれることがよくあります。 Dispatcher のキャッシュを効果的に使用するには、Dispatcher 設定の ignoreUrlParams プロパティをここに記載されているように設定することをお勧めします。

この ignoreUrlParams セクションに対してはコメントを解除し、conf.dispatcher.d/cache/marketing_query_parameters.any のファイルを参照する必要があります。このファイルは、マーケティング チャネルに関連するパラメーターに対応する行のコメントを解除することで変更することができます。他のパラメーターも追加することができます。

/ignoreUrlParams {
{{ /0001 { /glob "*" /type "deny" }}}
{{ $include "../cache/marketing_query_parameters.any"}}
}

Dispatcher キャッシュの無効化

通常、Dispatcher キャッシュを無効にする必要はありません。代わりに、コンテンツが再公開される際に Dispatcher がキャッシュを更新したり、CDN がキャッシュの有効期限のヘッダーを考慮したりできる機能を使用できます。

アクティベーション／非アクティベーション中の Dispatcher キャッシュの無効化

以前のバージョンの AEM と同様に、ページを公開または非公開にすると、Dispatcher のキャッシュからコンテンツがクリアされます。キャッシュに問題があると疑われる場合は、該当するページを再度公開し、ServerAlias localhost に一致する仮想ホスト（Dispatcher キャッシュの無効化に必要）が使用可能であることを確認する必要があります。

パブリッシュインスタンスは、オーサーから新しいバージョンのページまたはアセットを受け取ると、フラッシュエージェントを使用して Dispatcher 上の該当するパスを無効にします。更新されたパスは、そのパスの親とともに、Dispatcher キャッシュから最大で 1 レベル上位まで削除されます（削除されるレベルは statfilelevel で設定できます）。

Dispatcher キャッシュの明示的な無効化

アドビでは、標準のキャッシュヘッダーを使用して、コンテンツ配信のライフサイクルを制御することをお勧めします。ただし、必要に応じて、Dispatcher のコンテンツを直接無効にすることもできます。

次のリストには、キャッシュを明示的に無効にするシナリオ（オプションで無効化の完了をリッスン）が含まれています。

• エクスペリエンスフラグメントやコンテンツフラグメントなどのコンテンツを公開した後、それらの要素を参照する公開済みおよびキャッシュされたコンテンツを無効化します。
• 参照ページが正常に無効化されると外部システムに通知します。

キャッシュを明示的に無効にする方法は 2 つあります。

• 推奨されるアプローチは、オーサーから Sling コンテンツ配布（SCD）を使用することです。
• Replication API を使用して、パブリッシュ Dispatcher フラッシュレプリケーションエージェントを呼び出します。

アプローチは、階層の可用性、イベントの重複排除機能、イベント処理の保証の観点によって異なります。次の表に、これらのオプションの概要を示します。

キャッシュの無効化に直接関連する 2 つのアクションは、Sling コンテンツ配布（SCD）API の無効化とレプリケーション API の非アクティブ化です。

また、表からは、次のことがわかります。

• SCD API は、正確な知識を必要とする外部システムとの同期など、すべてのイベントを保証する必要がある場合に必要です。無効化呼び出しの時点でパブリッシュ層のアップスケーリングイベントがある場合、新しいパブリッシュがそれぞれ無効化を処理すると、追加のイベントが発生します。

• レプリケーション API の使用は一般的なユースケースではありませんが、キャッシュを無効にするトリガーがオーサー層ではなくパブリッシュ層から提供される場合に使用する必要があります。これは、Dispatcher の TTL が設定されている場合に役立ちます。

最後に、Dispatcher のキャッシュを無効にする場合は、オーサーの SCD API の無効化アクションを使用することをお勧めします。また、イベントをリッスンして、さらにダウンストリームアクションをトリガーすることもできます。

Sling コンテンツ配布（SCD）

オーサーで SCD アクションを使用する場合、実装パターンは次のようになります。

1. オーサーからカスタムコードを記述して Sling コンテンツ配布 API を呼び出し、パスのリストを含む無効化アクションを渡します。

@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);

• （オプション）すべての Dispatcher インスタンスで無効化されるリソースを反映するイベントをリッスンします。

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);
    }
}

• （オプション）上記の invalidated(String[] paths, String packageId) メソッドでビジネスロジックを実行します。

レプリケーション API

レプリケーション API の非アクティブ化アクションを使用する際の実装パターンを次に示します。

1. パブリッシュ層で Replication API を呼び出して、パブリッシュ Dispatcher フラッシュレプリケーションエージェントをトリガーします。

フラッシュエージェントのエンドポイントは設定できませんが、フラッシュエージェントと共に実行するパブリッシュサービスと一致させて、 Dispatcher を指すように事前設定されています。

フラッシュエージェントは、通常、OSGi のイベントまたはワークフローに基づくカスタムコードでトリガーできます。

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);

クライアントサイドライブラリとバージョンの整合性

ページは、HTML、JavaScript、CSS、画像で構成されています。JS ライブラリ間の依存関係を考慮して、クライアントサイドライブラリ（clientlibs）フレームワークを活用し、JavaScript および CSS リソースを HTML ページに読み込むことをお勧めします。

clientlibs フレームワークは、自動バージョン管理を提供します。つまり、開発者はソース管理で JS ライブラリに対する変更をチェックインでき、最新バージョンは、顧客がリリースをプッシュしたときに利用可能になります。この機能がないと、開発者は新しいバージョンのライブラリを参照して HTML を手動で変更する必要があります。同じライブラリを共有する HTML テンプレートが多い場合は特に負担がかかります。

新しいバージョンのライブラリが実稼動環境にリリースされると、参照する HTML ページは、更新されたライブラリバージョンへの新しいリンクで更新されます。特定の HTML ページのブラウザーキャッシュの有効期限が切れると、（AEM から）更新されたページが新しいバージョンのライブラリを参照することが保証されるので、古いライブラリがブラウザーキャッシュから読み込まれる心配はありません。更新された HTML ページには、最新のライブラリバージョンがすべて含まれます。

このメカニズムはシリアル化されたハッシュで、クライアントライブラリリンクに追加され、ブラウザーが CSS／JS をキャッシュするための一意のバージョン付き URL を確保します。シリアル化されたハッシュは、クライアントライブラリの内容が変更された場合にのみ更新されます。つまり、新しいデプロイメントでも、関係ない更新（クライアントライブラリの基になる CSS／JS の変更はなし）が発生した場合、参照は同じままになるので、ブラウザーのキャッシュの中断が少なくなります。

クライアントサイドライブラリの Longcache バージョンの有効化 - AEM as a Cloud Service の SDK クイックスタート

HTML ページにインクルードされるデフォルトの clientlib は、次の例のようになります。

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

厳密な clientlib のバージョン管理が有効な場合、クライアントライブラリに長期ハッシュキーがセレクターとして追加されます。その結果、clientlib の参照は次のようになります。

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

厳密な clientlib のバージョン管理は、すべての AEM as a Cloud Service 環境で、デフォルトで有効になっています。

ローカル SDK クイックスタートで厳密な clientlib のバージョン管理を有効にするには、次の操作を実行します。

1. OSGi Configuration manager <host>/system/console/configMgr へ移動する。
2. Adobe Granite HTML Library Manager の OSGi Config を探します。
   • 「厳密なバージョン管理」チェックボックスをオンにして有効にします。
   • 「長期クライアントサイドキャッシュキー」というラベルの付いたフィールドに、値「/.*;hash」を入力します。
3. 変更内容を保存します。AEM as a Cloud Service は、開発、ステージ、実稼動環境でこの設定を自動的に有効にするので、この設定をソース管理に保存する必要はありません。
4. クライアントライブラリのコンテンツが変更されるたびに、新しいハッシュキーが生成され、HTML 参照が更新されます。

Business.Adobe.com リソース