条件表达式

在您使用 PutItem、UpdateItem 和 DeleteItem DynamoDB 操作变更 DynamoDB 中的对象时，您可以选择指定一个条件表达式，以根据执行操作之前 DynamoDB 中的已有对象状态控制请求是否应成功。

AWS AppSync DynamoDB 函数允许在 PutItem、UpdateItem 和 DeleteItem 请求对象中指定条件表达式，并提供在条件失败并且未更新对象时遵循的策略。

示例 1

以下 PutItem 请求对象没有条件表达式。因此，即使已存在具有相同键的项目，它也会将项目放置在 DynamoDB 中，从而覆盖现有的项目。

import { util } from '@aws-appsync/utils';
export function request(ctx) {
  const { foo, bar, ...values} = ctx.args
  return {
    operation: 'PutItem',
    key: util.dynamodb.toMapValues({foo, bar}),
    attributeValues: util.dynamodb.toMapValues(values),
  };
}

示例 2

以下 PutItem 对象确实具有一个条件表达式，只有在 DynamoDB 中不 存在具有相同键的项目时，该操作才会成功。

import { util } from '@aws-appsync/utils';
export function request(ctx) {
  const { foo, bar, ...values} = ctx.args
  return {
    operation: 'PutItem',
    key: util.dynamodb.toMapValues({foo, bar}),
    attributeValues: util.dynamodb.toMapValues(values),
    condition: { expression: "attribute_not_exists(id)" }
  };
}

默认情况下，如果条件检查失败，则 AWS AppSync DynamoDB 函数在 ctx.error 中提供一个错误。您可以返回变更错误，并在 GraphQL 响应 error 部分的 data 字段中返回 DynamoDB 中的对象的当前值。

不过，AWS AppSync DynamoDB 函数提供了一些额外的功能，以帮助开发人员处理一些常见的边缘情况：

在处理条件检查失败一节中更详细地介绍了这些内容。

有关 DynamoDB 条件表达式的更多信息，请参阅 DynamoDB 条件表达式文档。

指定条件

PutItem、UpdateItem 和 DeleteItem 请求对象都允许指定可选的 condition 部分。如果省略，则不会进行条件检查。如果指定，条件必须为 true，操作才能成功。

condition 部分具有以下结构：

type ConditionCheckExpression = {
  expression: string;
  expressionNames?: { [key: string]: string};
  expressionValues?: { [key: string]: any};
  equalsIgnore?: string[];
  consistentRead?: boolean;
  conditionalCheckFailedHandler?: {
    strategy: 'Custom' | 'Reject';
    lambdaArn?: string;
  };
};

下列字段指定条件：

其余字段指示 AWS AppSync DynamoDB 函数如何处理条件检查失败：

处理条件检查失败

在条件检查失败时，AWS AppSync DynamoDB 函数可以使用 util.appendError 实用程序传递变更错误和对象的当前值。这会在 GraphQL 响应的 error 部分中添加 data 字段。不过，AWS AppSync DynamoDB 函数提供了一些额外的功能，以帮助开发人员处理一些常见的边缘情况：

此过程的流程图为：

检查所需的结果

在条件检查失败时，AWS AppSync DynamoDB 函数执行 GetItem DynamoDB 请求，以从 DynamoDB 中获取项目的当前值。默认情况下，它将使用强一致性读取，但这可以使用 condition 数据块中的 consistentRead 字段进行配置，并将当前值与预期结果进行比较：

如果 DynamoDB 中的对象的当前状态与预期结果不同，则 AWS AppSync DynamoDB 函数按照配置的策略拒绝变更或调用 Lambda 函数以确定后续操作。

遵循“reject”策略

在遵循 Reject 策略时，AWS AppSync DynamoDB 函数返回变更错误，并且还会在 GraphQL 响应 error 部分的 data 字段中返回 DynamoDB 中的对象的当前值。从 DynamoDB 返回的项目通过函数响应处理程序转换为客户端的预期格式，并按选择集进行筛选。

例如，给定以下变更请求：

mutation {
    updatePerson(id: 1, name: "Steve", expectedVersion: 1) {
        Name
        theVersion
    }
}

如果从 DynamoDB 返回的项目如下所示：

{
   "id" : { "S" : "1" },
   "name" : { "S" : "Steve" },
   "version" : { "N" : 8 }
}

函数响应处理程序如下所示：

import { util } from '@aws-appsync/utils';
export function response(ctx) {
  const { version, ...values } = ctx.result;
  const result = { ...values, theVersion: version };
  if (ctx.error) {
    if (error) {
      return util.appendError(error.message, error.type, result, null);
    }
  }
  return result
}

GraphQL 响应如下所示：

{
  "data": null,
  "errors": [
    {
      "message": "The conditional request failed (Service: AmazonDynamoDBv2; Status Code: 400; Error Code: ConditionalCheckFailedException; Request ID: ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZ)"
      "errorType": "DynamoDB:ConditionalCheckFailedException",
      "data": {
        "Name": "Steve",
        "theVersion": 8
      },
      ...
    }
  ]
}

另外，如果返回的对象中的任何字段在变更成功后已由其他解析器填充，则当在 error 部分中返回此对象时，将不会对这些字段进行解析。

遵循“custom”策略

在遵循 Custom 策略时，AWS AppSync DynamoDB 函数调用 Lambda 函数以决定后续操作。Lambda 函数选择下列选项之一：

Lambda 调用请求

AWS AppSync DynamoDB 函数调用 lambdaArn 中指定的 Lambda 函数。它将使用在数据来源上配置的相同 service-role-arn。调用的负载具有以下结构：

{
    "arguments": { ... },
    "requestMapping": {... },
    "currentValue": { ... },
    "resolver": { ... },
    "identity": { ... }
}

字段定义如下：

负载的完整示例：

{
    "arguments": {
        "id": "1",
        "name": "Steve",
        "expectedVersion": 1
    },
    "requestMapping": {
        "version" : "2017-02-28",
        "operation" : "PutItem",
        "key" : {
           "id" : { "S" : "1" }
        },
        "attributeValues" : {
           "name" : { "S" : "Steve" },
           "version" : { "N" : 2 }
        },
        "condition" : {
           "expression" : "version = :expectedVersion",
           "expressionValues" : {
               ":expectedVersion" : { "N" : 1 }
           },
           "equalsIgnore": [ "version" ]
        }
    },
    "currentValue": {
        "id" : { "S" : "1" },
        "name" : { "S" : "Steve" },
        "version" : { "N" : 8 }
    },
    "resolver": {
        "tableName": "People",
        "awsRegion": "us-west-2",
        "parentType": "Mutation",
        "field": "updatePerson",
        "outputType": "Person"
    },
    "identity": {
        "accountId": "123456789012",
        "sourceIp": "x.x.x.x",
        "user": "AIDAAAAAAAAAAAAAAAAAA",
        "userArn": "arn:aws:iam::123456789012:user/appsync"
    }
}

Lambda 调用响应

Lambda 函数可以检查调用负载，并应用任何业务逻辑以决定 AWS AppSync DynamoDB 函数应如何处理失败。有三种选项可用于处理条件检查失败：

在下面的示例中，Lambda 函数处理失败的 PutItem 请求。业务逻辑将查看进行调用的用户。如果调用是由 jeffTheAdmin 进行的，则会重试该请求，并从当前位于 DynamoDB 的项目中更新 version 和 expectedVersion。否则，业务逻辑将拒绝变更。

exports.handler = (event, context, callback) => {
    console.log("Event: "+ JSON.stringify(event));

    // Business logic goes here.

    var response;
    if ( event.identity.user == "jeffTheAdmin" ) {
        response = {
            "action" : "retry",
            "retryMapping" : {
                "attributeValues" : event.requestMapping.attributeValues,
                "condition" : {
                    "expression" : event.requestMapping.condition.expression,
                    "expressionValues" : event.requestMapping.condition.expressionValues
                }
            }
        }
        response.retryMapping.attributeValues.version = { "N" : event.currentValue.version.N + 1 }
        response.retryMapping.condition.expressionValues[':expectedVersion'] = event.currentValue.version

    } else {
        response = { "action" : "reject" }
    }

    console.log("Response: "+ JSON.stringify(response))
    callback(null, response)
};