持續性 GraphQL 查詢

持續查詢是儲存在Adobe Experience Manager (AEM)伺服器上的查詢。 使用者端可以傳送具有查詢名稱的HTTPGET要求來執行它。 此方法的好處是可快取。 雖然使用者端GraphQL查詢也可以使用無法快取的HTTPPOST請求來執行，但持久查詢可以由HTTP快取或CDN快取，從而提高效能。 持續查詢可讓您簡化請求並提高安全性，因為您的查詢會封裝在伺服器上，且AEM管理員可完全控制這些查詢。 它是 最佳實務與強烈建議 以便在使用AEM GraphQL API時使用持久查詢。

在上一章中，您已探索一些進階GraphQL查詢來收集WKND應用程式的資料。 在本章中，您會將查詢保留到AEM，並瞭解如何對保留的查詢使用快取控制。

必備條件

本檔案是多部分教學課程的一部分。 請確保 上一章 已完成，再繼續本章節。

目標

在本章中，瞭解如何：

  • 使用引數保留GraphQL查詢
  • 對持久查詢使用快取控制引數

檢閱 GraphQL持續查詢 組態設定

讓我們來檢視一下 GraphQL持續查詢 已在AEM執行個體中為WKND網站專案啟用。

  1. 導覽至 工具 > 一般 > 設定瀏覽器.

  2. 選取 WKND已共用，然後選取 屬性 以開啟設定屬性。 在組態特性頁面上，您應該會看到 GraphQL持續查詢 許可權已啟用。

    組態屬性

使用內建GraphiQL Explorer工具保留GraphQL查詢

在本節中，我們將持續儲存GraphQL查詢，該查詢稍後用於使用者端應用程式中，以擷取及轉譯Adventure內容片段資料。

  1. 在GraphiQL Explorer中輸入以下查詢：

    query getAdventureDetailsBySlug($slug: String!) {
adventureList(filter: {slug: {_expressions: [{value: $slug}]}}) {
    items {
    _path
    title
    activity
    adventureType
    price
    tripLength
    groupSize
    difficulty
    primaryImage {
        ... on ImageRef {
        _path
        mimeType
        width
        height
        }
    }
    description {
        html
        json
    }
    itinerary {
        html
        json
    }
    location {
        _path
        name
        description {
        html
        json
        }
        contactInfo {
        phone
        email
        }
        locationImage {
        ... on ImageRef {
            _path
        }
        }
        weatherBySeason
        address {
        streetAddress
        city
        state
        zipCode
        country
        }
    }
    instructorTeam {
        _metadata {
        stringMetadata {
            name
            value
        }
        }
        teamFoundingDate
        description {
        json
        }
        teamMembers {
        fullName
        contactInfo {
            phone
            email
        }
        profilePicture {
            ... on ImageRef {
            _path
            }
        }
        instructorExperienceLevel
        skills
        biography {
            html
        }
        }
    }
    administrator {
        fullName
        contactInfo {
        phone
        email
        }
        biography {
        html
        }
    }
    }
    _references {
    ... on ImageRef {
        _path
        mimeType
    }
    ... on LocationModel {
        _path
        __typename
    }
    }
}
}

    在儲存查詢之前，請先確認查詢可運作。

  2. 接著點選「另存新檔」並輸入 adventure-details-by-slug 作為「查詢名稱」。

    保留GraphQL查詢

透過編碼特殊字元來執行變數的持續查詢

讓我們瞭解使用者端應用程式如何藉由編碼特殊字元來執行具有變數的持續查詢。

若要執行持續查詢，使用者端應用程式會使用下列語法發出GET要求：

GET <AEM_HOST>/graphql/execute.json/<Project-Config-Name>/<Persisted-Query-Name>

執行持續查詢 使用變數，則上述語法會變更為：

GET <AEM_HOST>/graphql/execute.json/<Project-Config-Name>/<Persisted-Query-Name>;variable1=value1;variable2=value2

特殊字元(如分號(；)、等號(=)、斜線(/)和空格)必須轉換為使用對應的UTF-8編碼。

藉由執行 getAllAdventureDetailsBySlug 從命令列終端機進行查詢時，我們會檢閱這些概念的實際運作情況。

  1. 開啟GraphiQL Explorer並按一下 橢圓 (…)永久查詢旁邊 getAllAdventureDetailsBySlug，然後按一下 複製URL. 將複製的URL貼到文字輸入板中，如下所示：

        http://<AEM_HOST>/graphql/execute.json/wknd-shared/getAllAdventureDetailsBySlug;slug=

  2. 新增 yosemite-backpacking 作為變數值

        http://<AEM_HOST>/graphql/execute.json/wknd-shared/getAllAdventureDetailsBySlug;slug=yosemite-backpacking

  3. 編碼分號(；)和等號(=)特殊字元

        http://<AEM_HOST>/graphql/execute.json/wknd-shared/getAllAdventureDetailsBySlug%3Bslug%3Dyosemite-backpacking

  4. 開啟命令列終端機並使用 Curl 執行查詢

    $ curl -X GET http://<AEM_HOST>/graphql/execute.json/wknd-shared/getAllAdventureDetailsBySlug%3Bslug%3Dyosemite-backpacking
秘訣

如果針對AEM作者環境執行上述查詢，您必須傳送認證。 另請參閱 本機開發存取權杖 以示範 呼叫AEM API 以取得檔案詳細資訊。

此外，請檢閱 如何執行持久查詢， 使用查詢變數、和 為應用程式使用的查詢URL編碼 以瞭解使用者端應用程式的持久查詢執行。

更新持續性查詢中的快取控制引數

AEM GraphQL API可讓您更新查詢的預設快取控制引數，以改進效能。 預設cache-control值為：

  • 60秒是使用者端（例如瀏覽器）的預設(maxage=60) TTL

  • 7200秒是Dispatcher和CDN的預設(s-maxage=7200) TTL；也稱為共用快取

使用 adventures-all 查詢以更新快取控制引數。 查詢回應很大，可用來控制其 age 在快取中。 此持久查詢稍後用於更新 使用者端應用程式.

  1. 開啟GraphiQL Explorer並按一下 橢圓 (…)，然後按一下 標頭 以開啟 快取設定 強制回應視窗。

    保留GraphQL標頭選項

  2. 在 快取設定 強制回應視窗，更新 max-age 標題值至 600 秒（10分鐘），然後按一下 儲存

    保留GraphQL快取設定

檢閱 快取您的持續查詢 以取得預設快取控制引數的詳細資訊。

恭喜！

恭喜！您現在已瞭解如何使用引數保留GraphQL查詢、更新持久查詢，以及使用快取控制引數保留查詢。

後續步驟

在 下一個章節，您將會在WKND應用程式中實施持續查詢的要求。

本頁內容