永続的な GraphQL クエリ

永続的なクエリは、Adobe Experience Manager(AEM)as a Cloud Service サーバーで作成および保存される GraphQL クエリです。永続的なクエリは、クライアントアプリケーションから GET リクエストでリクエストできます。GET リクエストの応答は、Dispatcher および CDN レイヤーでキャッシュできるので、最終的には、要求元のクライアントアプリケーションのパフォーマンスが向上します。これは、標準の GraphQL クエリとは異なります。標準クエリは、応答を簡単にはキャッシュできない POST リクエストを使用して実行されます。

メモ

永続クエリをお勧めします。詳しくは、GraphQL クエリのベストプラクティス(Dispatcher)と、関連する Dispatcher の設定を参照してください。

AEM では GraphiQL IDE を使用して、実稼動環境に移行する前に GraphQL クエリを開発、テスト、保持できます。カスタマイズが必要な場合(例えば、キャッシュをカスタマイズする場合)、API を使用できます。GraphQL クエリを永続化する方法で示される curl の例を参照してください。

永続的なクエリとエンドポイント

持続的なクエリでは、常に適切な Sites 設定に関連するエンドポイントを使用する必要があるため、次のどちらかまたは両方を使用できます。

  • グローバル設定とエンドポイント:
    クエリは、すべてのコンテンツフラグメントモデルにアクセスできます。
  • 特定の Sites 設定およびエンドポイント:
    特定の Sites 設定用の永続クエリを作成するには、対応する Sites 設定固有のエンドポイント(関連するコンテンツフラグメントモデルへのアクセスを提供)が必要です。例えば、WKND Sites 設定専用の永続クエリを作成するには、対応する WKND 固有の Sites 設定と、WKND 固有のエンドポイントを事前に作成する必要があります。
メモ

詳しくは、設定ブラウザーでのコンテンツフラグメント機能の有効化を参照してください。

適切な Sites 設定用に、GraphQL 永続クエリ​を有効にする必要があります。

例えば、my-query という特定のクエリがあり、このクエリが Sites 設定 my-conf のモデル my-model を使用する場合は、次のようになります。

  • 特定エンドポイント my-conf を使用してクエリを作成すると、クエリは次のように保存されます。
    /conf/my-conf/settings/graphql/persistentQueries/my-query
  • global エンドポイントを使用して同じクエリを作成できますが、クエリは次のように保存されます。
    /conf/global/settings/graphql/persistentQueries/my-query
メモ

これらは 2 つの異なるクエリで、異なるパスに保存されます。

同じモデルを使用していますが、異なるエンドポイントを介しています。

GraphQL クエリを永続化する方法

最初に AEM オーサー環境でクエリを永続化し、その後、アプリケーションで使用するために、実稼動 AEM パブリッシュ環境にクエリを移行することをお勧めします

クエリを永続化するには、次のような様々な方法があります。

  • GraphiQL IDE - 永続クエリの保存を参照してください(推奨される方法)
  • curl - 次の例を参照してください。
  • その他のツール(Postman など)

GraphiQL IDE は、クエリを保持するための​推奨​される方法です。curl コマンドラインツールを使用して特定のクエリを保持するには:

  1. 新しいエンドポイント URL /graphql/persist.json/<config>/<persisted-label> に PUT してクエリを準備します。

    例えば、次のようにして、永続的クエリを作成します。

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
        }
      }
    }'
    
  2. この段階で、応答を確認します。

    例えば、以下が成功するかどうかを確認します。

    {
      "action": "create",
      "configurationName": "wknd",
      "name": "plain-article-query",
      "shortPath": "/wknd/plain-article-query",
      "path": "/conf/wknd/settings/graphql/persistentQueries/plain-article-query"
    }
    
  3. その後、URL /graphql/execute.json/<shortPath> を GET して、永続的クエリをリクエストできます。

    例えば、次のような永続的クエリを使用します。

    $ curl -X GET \
        http://localhost:4502/graphql/execute.json/wknd/plain-article-query
    
  4. 既存のクエリパスに POST して、永続的クエリを更新します。

    例えば、次のような永続的クエリを使用します。

    $ curl -X POST \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query" \
        -d \
    '{
      articleList {
        items{
            _path
            author
            main {
                json
            }
          referencearticle {
            _path
          }
        }
      }
    }'
    
  5. ラップされたプレーンクエリを作成します。

    次に例を示します。

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-wrapped" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }"}'
    
  6. キャッシュコントロール付きのラップされたプレーンクエリを作成します。

    次に例を示します。

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-max-age" \
        -d \
    '{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'
    
  7. パラメーター付きの永続的クエリを作成します。

    次に例を示します。

    $ curl -X PUT \
        -H 'authorization: Basic YWRtaW46YWRtaW4=' \
        -H "Content-Type: application/json" \
        "http://localhost:4502/graphql/persist.json/wknd/plain-article-query-parameters" \
        -d \
    'query GetAsGraphqlModelTestByPath($apath: String!, $withReference: Boolean = true) {
      articleByPath(_path: $apath) {
        item {
          _path
            author
            main {
            plaintext
            }
            referencearticle @include(if: $withReference) {
            _path
            }
          }
        }
      }'
    

永続クエリの実行方法

永続クエリを実行するには、クライアントアプリケーションで次の構文を使用して GET リクエストを実行します。

GET <AEM_HOST>/graphql/execute.json/<PERSISTENT_PATH>

PERSISTENT_PATH は、永続クエリが保存される場所への短縮パスです。

  1. 例えば、wknd は設定名で、plain-article-query は永続クエリの名前です。クエリを実行するには:

    $ curl -X GET \
        https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query
    
  2. パラメーター付きのクエリを実行します。

    メモ

    永続クエリを実行する場合は、クエリ変数と値を適切にエンコードする必要があります。

    次に例を示します。

    $ curl -X GET \
        "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/plain-article-query-parameters%3Bapath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fmagazine%2Falaska-adventure%2Falaskan-adventures%3BwithReference%3Dfalse
    

    詳しくは、クエリ変数の使用を参照してください。

クエリ変数の使用

クエリ変数は、永続クエリで使用できます。クエリ変数をリクエストに付加するには、先頭にセミコロン(;)を付けた変数名と値を使用します。複数の変数はセミコロンで区切ります。

次のようなパターンになります。

<AEM_HOST>/graphql/execute.json/<PERSISTENT_QUERY_PATH>;variable1=value1;variable2=value2

例えば、次のクエリには、アクティビティ値に基づいてリストをフィルタリングするための変数 activity が含まれています。

query getAdventuresByActivity($activity: String!) {
      adventureList (filter: {
        adventureActivity: {
          _expressions: [
            {
              value: $activity
            }
          ]
        }
      }){
        items {
          _path
        adventureTitle
        adventurePrice
        adventureTripLength
      }
    }
  }

このクエリは、パス wknd/adventures-by-activity の下に保持できます。activity=Camping で永続クエリを呼び出すには、リクエストは次のようになります。

<AEM_HOST>/graphql/execute.json/wknd/adventures-by-activity%3Bactivity%3DCamping

なお、%3B; の UTF-8 エンコーディングで、%3D= のエンコーディングです。永続クエリを実行するには、クエリ変数と特殊文字を適切にエンコードする必要があります。

永続クエリのキャッシュ

永続クエリは、Dispatcher と CDN レイヤーでキャッシュされ、最終的に要求元のクライアントアプリケーションのパフォーマンスを向上させることができるので、推奨されます。

デフォルトでは、AEM はデフォルトの有効期間(TTL)に基づいてコンテンツ配信ネットワーク(CDN)のキャッシュを無効にします。

この値は次のように設定されます。

  • Dispatcher および CDN のキャッシュ(共有キャッシュ​とも呼ばれます)のデフォルト TTL は 7200 秒です
    • デフォルト:s-maxage=7200
  • クライアント(ブラウザーなど)のキャッシュのデフォルト TTL は 60 秒です
    • デフォルト:maxage=60

GraphQL クエリの TTL を変更する場合、クエリは次のいずれかである必要があります。

GraphQL での HTTP キャッシュヘッダーの管理

GraphiQL IDE - 永続クエリの保存を参照してください。

API からのキャッシュの管理

これには、コマンドラインインターフェイスで CURL を使用して AEM にクエリをポストします。

次に例を示します。

curl -X PUT \
    -H 'authorization: Basic YWRtaW46YWRtaW4=' \
    -H "Content-Type: application/json" \
    "https://publish-p123-e456.adobeaemcloud.com/graphql/persist.json/wknd/plain-article-query-max-age" \
    -d \
'{ "query": "{articleList { items { _path author main { json } referencearticle { _path } } } }", "cache-control": { "max-age": 300 }}'

cache-control は、作成時に設定することもできますし(PUT リクエストを使用)、後で設定することもできます(例えば、POST リクエストを使用)。AEM ではデフォルト値を提供できるので、永続クエリを作成する際に cache-control はオプションです。curl を使用してクエリを永続化する例については、GraphQL クエリを永続化する方法を参照してください。

アプリで使用するクエリ URL のエンコード

アプリケーションで使用するには、クエリ変数の構築時に使用される特殊文字(セミコロン(;)、等号(=)、スラッシュ(/))を、対応する UTF-8 エンコーディングで変換する必要があります。

次に例を示します。

curl -X GET \ "https://publish-p123-e456.adobeaemcloud.com/graphql/execute.json/wknd/adventure-by-path%3BadventurePath%3D%2Fcontent%2Fdam%2Fwknd%2Fen%2Fadventures%2Fbali-surf-camp%2Fbali-surf-camp"

URL は次の部分に分解できます。

URL の部分 説明
/graphql/execute.json 永続クエリのエンドポイント
/wknd/adventure-by-path 永続クエリのパス
%3B ; のエンコーディング
adventurePath クエリ変数
%3D = のエンコーディング
%2F / のエンコーディング
%2Fcontent%2Fdam... コンテンツフラグメントへのエンコードされたパス

プレーンテキストでは、リクエスト URI は次のようになります。

/graphql/execute.json/wknd/adventure-by-path;adventurePath=/content/dam/wknd/en/adventures/bali-surf-camp/bali-surf-camp

クライアントアプリで永続クエリを使用するには、AEM ヘッドレス クライアント SDK を JavaScriptJava または NodeJS に使用する必要があります。ヘッドレスクライアント SDK は、自動的にリクエスト内のクエリ変数を適切にエンコードします。

実稼動環境への永続クエリの移行

永続クエリは、常に、AEM オーサーサービスで作成してから、AEM パブリッシュサービスに公開(レプリケート)する必要があります。多くの場合、永続クエリは、ローカル環境や開発環境などの下位環境で作成およびテストされます。その後、永続クエリを上位レベルの環境に昇格し、最終的に実稼動 AEM パブリッシュ環境で使用できるようにして、クライアントアプリケーションが使用できるようにする必要があります。

永続クエリのパッケージ化

永続クエリは、AEM パッケージに組み込むことができます。その後、AEM パッケージをダウンロードして、様々な環境にインストールできます。AEM パッケージは、AEM オーサー環境から AEM パブリッシュ環境にレプリケートすることもできます。

パッケージを作成するには:

  1. ツールデプロイメントパッケージ​に移動します。
  2. パッケージを作成」をタップして新しいパッケージを作成します。パッケージを定義するダイアログが開きます。
  3. パッケージ定義ダイアログの「一般」で、「wknd-persistent-queries」などの​名前​を入力します。
  4. 「1.0」のようなバージョン番号を入力します。
  5. フィルター」で、新しい​フィルター​を追加します。パスファインダーを使用して、設定の下にある persistentQueries フォルダーを選択します。例えば、wknd 設定の場合、フルパスは /conf/wknd/settings/graphql/persistentQueries になります。
  6. 保存」をタップして新しいパッケージ定義を保存し、ダイアログを閉じます。
  7. 新しく作成されたパッケージ定義で「ビルド」ボタンをタップします。

パッケージが構築されたら、次の操作を実行できます。

  • パッケージを​ダウンロード​し、別の環境で再アップロードする。
  • その他レプリケート​をタップして、パッケージを​レプリケート​する。これにより、接続された AEM パブリッシュ環境にパッケージがレプリケートされます。

このページ