管道解析器 (VTL) - Amazon AppSync
创建管道解析程序创建函数向管道解析程序添加函数执行查询
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

管道解析器 (VTL)

Amazon AppSync 在 GraphQL 字段上执行解析器。在某些情况下，应用程序需要执行多个操作以解析单个 GraphQL 字段。使用流水线解析器，开发人员现在可以编写名为 Functions 的操作并按顺序执行它们。例如，管道解析程序对于需要在获取字段数据之前执行授权检查的应用程序非常有用。

管道解析程序由一个之前映射模板、一个之后映射模板以及函数列表组成。每个函数都有一个针对数据源执行的请求和响应映射模板。由于管道解析程序将执行委托给函数列表，因此它不会链接到任何数据源。单元解析程序和函数是对数据源执行操作的基元。有关更多信息，请参阅 Resolver 映射模板概述。

创建管道解析程序

在 Amazon AppSync 控制台中，转至 Schema (架构) 页面。

保存以下架构：

schema {
    query: Query
    mutation: Mutation
}

type Mutation {
    signUp(input: Signup): User
}

type Query {
    getUser(id: ID!): User
}

input Signup {
    username: String!
    email: String!
}

type User {
    id: ID!
    username: String
    email: AWSEmail
}

我们将把管道解析器连接到 Mutat ion 类型上的 SignUp 字段。在右侧的 “突变类型” 中，选择signUp字段旁边的 “附加解析器”。在 Create Resolver (创建解析程序) 页面上，单击 Switch to Pipeline (切换到管道) 按钮。该页面现在应显示 3 个部分，一个 Before Mapping Template (之前映射模板) 文本区域、一个 Functions (函数) 部分和一个 After Mapping template (之后映射模板) 文本区域。

我们的管道解析程序通过先验证电子邮件地址输入，然后将用户保存在系统中来注册用户。我们将电子邮件验证封装在 validateEmail 函数中，并将用户保存在 saveUser 函数中。首先执行 validateEmail 函数，如果电子邮件有效，则执行 saveUser 函数。

执行流将如下所示：

  1. Mutation.signUp 解析程序请求映射模板

  2. validateEmail 函数

  3. saveUser 函数

  4. Mutation.signUp 解析程序响应映射模板

由于我们可能在 API 上的其他解析程序中重用 validateEmail 函数，因此，我们希望避免访问 $ctx.args，因为这些将从一个 GraphQL 字段更改为另一个字段。相反，我们可以使用 $ctx.stash 存储 signUp(input: Signup) 输入字段参数中的电子邮件属性。

之前映射模板：

## store email input field into a generic email key
$util.qr($ctx.stash.put("email", $ctx.args.input.email))
{}

控制台提供了一个我们将使用的默认传递之后映射模板：

$util.toJson($ctx.result)

创建函数

在管道解析程序页面上的 Functions (函数) 部分中，单击 Create Function (创建函数)。也可以在不通过解析程序页面的情况下创建函数，为此，请在 Amazon AppSync 控制台中，转到 Functions (函数) 页面。选择 Create Function (创建函数) 按钮。让我们创建一个函数来检查电子邮件是否有效并来自特定域。如果电子邮件无效，该函数会引发一个错误。否则，它将转发接收到的任何输入。

在函数页面上选择 “无” 数据源，然后填写 ValidateEmail 请求映射模板：

#set($valid = $util.matches("^[a-zA-Z0-9_.+-]+@(?:(?:[a-zA-Z0-9-]+\.)?[a-zA-Z]+\.)?(myvaliddomain)\.com", $ctx.stash.email))
#if (!$valid)
    $util.error("$ctx.stash.email is not a valid email.")
#end
{
    "payload": { "email": $util.toJson(${ctx.stash.email}) }
}

以及响应映射模板：

$util.toJson($ctx.result)

我们刚刚创建了 validateEmail 函数。重复这些步骤以使用以下请求和响应映射模板创建 saveUser 函数。为简单起见，我们使用 NONE 数据源，并在函数执行后假装用户已保存在系统中。

请求映射模板：

## $ctx.prev.result contains the signup input values. We could have also
## used $ctx.args.input.
{
    "payload": $util.toJson($ctx.prev.result)
}

以及响应映射模板：

## an id is required so let's add a unique random identifier to the output
$util.qr($ctx.result.put("id", $util.autoId()))
$util.toJson($ctx.result)

我们刚刚创建了我们的 SaveUser 函数。

向管道解析程序添加函数

我们的函数应已自动添加到刚刚创建的管道解析程序。如果您碰巧通过控制台 Functions (函数) 页面创建了函数，则可以单击解析程序页面上的 Add Function (添加函数) 来附加它们。将 validateEmail 和 saveUser 函数添加到解析程序。validateEmail 函数应放在 saveUser 函数之前。在添加更多函数时，您可以使用向上和向下箭头来重新组织函数的执行顺序。

执行查询

在 Amazon AppSync 控制台中，转到 Queries (查询) 页面。输入以下查询：

mutation {
  signUp(input: {
    email: "nadia@myvaliddomain.com"
    username: "nadia"
  }) {
    id
    username
  }
}

这应该返回如下内容：

{
  "data": {
    "signUp": {
      "id": "256b6cc2-4694-46f4-a55e-8cb14cc5d7fc",
      "username": "nadia"
    }
  }
}

我们已成功注册用户，并使用管道解析程序验证了输入电子邮件。要遵循有关管道解析程序的更完整的教程，您可以转到教程：管道解析程序