設定伺服器端快取和 API 承載壓縮 in AWS AppSync

AWS AppSync的伺服器端資料快取功能可在高速記憶體內快取中提供資料，進而提升效能並減少延遲。這可減少直接存取資料來源的需求。快取適用於單元和管道解析程式。

AWS AppSync 也可讓您壓縮 API 回應，以便更快速地載入和下載承載內容。這可能會降低應用程式的壓力，也可能降低您的資料傳輸費用。壓縮行為是可設定的，您可以自行決定設定。

如需在 AWS AppSync API 中定義伺服器端快取和壓縮所需行為的說明，請參閱本節。

執行個體類型

AWS AppSync 在與 AWS AppSync API 相同的 AWS 帳戶和 AWS 區域中託管 Amazon ElastiCache (Redis OSS) 執行個體。

下列 ElastiCache (Redis OSS) 執行個體類型可供使用：

快取行為

以下是與快取相關的行為：

快取加密

當您使用 AWS AppSync伺服器端資料快取功能時，靜態和傳輸中的加密一律會針對新快取啟用，且無法停用。

若要在現有 API 快取上啟用加密，請刪除快取，然後重新建立快取。

若要使快取項目失效，您可以使用 AWS AppSync 主控台或 () 進行排清快取 API AWS Command Line Interface 呼叫AWS CLI。

如需詳細資訊，請參閱 AWS AppSync API 參考中的 ApiCache 資料類型。

快取移出

當您設定 AWS AppSync 的伺服器端快取時，您可以設定最大 TTL。此值定義快取項目儲存在記憶體中的時間量。在您必須從快取移除特定項目的情況下，您可以在解析程式的請求或回應中使用 AWS AppSync 的evictFromApiCache延伸公用程式。（例如，當您資料來源中的資料變更，且您的快取項目現在已過時。) 若要從快取中移出項目，您必須知道其金鑰。因此，如果您必須以動態方式移出項目，建議您使用每個解析程式快取，並明確定義要用來將項目新增至快取的金鑰。

移出快取項目

若要從快取中移出項目，請使用evictFromApiCache延伸項目公用程式。指定類型名稱和欄位名稱，然後提供索引鍵值項目的物件，以建置您要移出的項目索引鍵。在 物件中，每個金鑰代表快取解析程式cachingKey清單中所用context物件的有效項目。每個值都是用來建構金鑰值的實際值。您必須以與快取解析程式cachingKey清單中快取金鑰相同的順序，將項目放在物件中。

例如，請參閱下列結構描述：

type Note {
  id: ID!
  title: String
  content: String!
}

type Query {
  getNote(id: ID!): Note
}

type Mutation {
  updateNote(id: ID!, content: String!): Note
}

在此範例中，您可以啟用每個解析程式快取，然後針對getNote查詢啟用它。然後，您可以將快取金鑰設定為包含 [context.arguments.id]。

當您嘗試取得 時Note，若要建置快取金鑰， AWS AppSync 會使用getNote查詢的 id 引數在其伺服器端快取中執行查詢。

當您更新 時Note，必須移出特定備註的項目，以確保下一個請求從後端資料來源擷取它。若要這樣做，您必須建立請求處理常式。

下列範例顯示使用此方法處理移出的一個方法：

import { util, Context } from '@aws-appsync/utils';
import { update } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	extensions.evictFromApiCache('Query', 'getNote', { 'ctx.args.id': ctx.args.id });
	return update({ key: { id: ctx.args.id }, update: { context: ctx.args.content } });
}

export const response = (ctx) => ctx.result;

或者，您也可以在回應處理常式中處理移出。

處理updateNote變動時， AWS AppSync 會嘗試移出項目。如果項目已成功清除，回應會在 extensions 物件中包含一個apiCacheEntriesDeleted值，顯示已刪除的項目數量：

"extensions": {  "apiCacheEntriesDeleted": 1}

根據身分移出快取項目

您可以根據 context 物件中的多個值建立快取金鑰。

例如，採用下列結構描述，使用 Amazon Cognito 使用者集區做為預設身分驗證模式，並由 Amazon DynamoDB 資料來源提供支援：

type Note {
  id: ID! # a slug; e.g.: "my-first-note-on-graphql"
  title: String
  content: String!
}

type Query {
  getNote(id: ID!): Note
}

type Mutation {
  updateNote(id: ID!, content: String!): Note
}

Note 物件類型會儲存在 DynamoDB 資料表中。資料表具有複合索引鍵，其使用 Amazon Cognito 使用者名稱做為主索引鍵，並使用 id(Slug) Note做為分割區索引鍵。這是多租用戶系統，可讓多個使用者託管和更新其私有Note物件，而這些物件永遠不會共用。

由於這是一個讀取密集型系統，getNote查詢會使用每個解析程式的快取來快取，快取金鑰由 組成[context.identity.username, context.arguments.id]。Note 更新 時，您可以移出該特定 的項目Note。您必須以解析程式cachingKeys清單中指定的相同順序，在物件中新增元件。

下列範例顯示：

import { util, Context } from '@aws-appsync/utils';
import { update } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
	extensions.evictFromApiCache('Query', 'getNote', {
		'ctx.identity.username': ctx.identity.username,
		'ctx.args.id': ctx.args.id,
	});
	return update({ key: { id: ctx.args.id }, update: { context: ctx.args.content } });
}

export const response = (ctx) => ctx.result;

後端系統也可以更新 Note並移出項目。例如，採用此變動：

type Mutation {
  updateNoteFromBackend(id: ID!, content: String!, username: ID!): Note @aws_iam
}

您可以移出項目，但將快取金鑰的元件新增至cachingKeys物件。

在下列範例中，移出發生在解析程式的回應中：

import { util, Context } from '@aws-appsync/utils';
import { update } from '@aws-appsync/utils/dynamodb';

export function request(ctx) {
    return update({ key: { id: ctx.args.id }, update: { context: ctx.args.content } });
}

export function response(ctx) {
    extensions.evictFromApiCache('Query', 'getNote', {
        'ctx.identity.username': ctx.args.username,
        'ctx.args.id': ctx.args.id,
    });
    return ctx.result;
}

如果您的後端資料已在 AWS AppSync 外部更新，您可以透過呼叫使用NONE資料來源的變動，從快取中移出項目。

壓縮 API 回應

AWS AppSync 允許用戶端請求壓縮的承載。如果請求，會壓縮並傳回 API 回應，以回應表示偏好壓縮內容的請求。壓縮的 API 回應載入速度更快、內容下載速度更快，而且您的資料傳輸費用也可能降低。

AWS AppSync 可以將 GraphQL 查詢承載大小壓縮在 1，000 到 10，000，000 個位元組之間。若要啟用壓縮，用戶端必須傳送具有值 的 Accept-Encoding 標頭gzip。您可以透過檢查回應中的Content-Encoding標頭值來驗證壓縮 (gzip)。

根據預設， AWS AppSync 主控台中的查詢瀏覽器會自動設定請求中的標頭值。如果您執行的查詢有足夠的回應，可以使用瀏覽器開發人員工具來確認壓縮。