Graphile/Crystal 中实现 GraphQL 联合类型返回的最佳实践

在 GraphQL 开发中，我们经常需要处理可能返回多种结果类型的操作。Graphile/Crystal 项目作为 PostGraphile 的下一代实现，提供了强大的功能来处理这种场景。本文将深入探讨如何在 Graphile/Crystal 中正确实现返回联合类型的 GraphQL 操作。

联合类型的使用场景

在实际应用中，很多操作都可能产生多种结果。以用户注册为例，成功时返回用户对象，失败时可能返回用户名已存在或邮箱已被占用等错误信息。传统 REST API 可能使用错误码表示，但在 GraphQL 中，我们可以利用联合类型(Union Type)更优雅地处理这种情况。

基础类型定义

首先，我们需要定义 GraphQL 类型系统。以下是一个完整的类型定义示例：

extend type Mutation {
  registerUser(input: RegisterUserInput!): RegisterUserPayload
}

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

type RegisterUserPayload {
  result: RegisterUserResult
  query: Query
}

union RegisterUserResult = User | UsernameConflict | EmailAddressConflict

type UsernameConflict {
  message: String!
  username: String!
}

type EmailAddressConflict {
  message: String!
  email: String!
}

实现解析逻辑

在 Graphile/Crystal 中，我们需要通过 makeExtendSchemaPlugin 插件来实现这些类型的解析逻辑。关键点在于处理联合类型的返回。

核心实现代码

import { withPgClient } from "@dataplan/pg";
import {
  access,
  constant,
  ExecutableStep,
  list,
  object,
  ObjectStep,
  polymorphicBranch,
} from "grafast";
import { DatabaseError } from "pg";
import { gql, makeExtendSchemaPlugin } from "postgraphile/utils";

export const RegisterUserPlugin = makeExtendSchemaPlugin((build) => {
  const { users } = build.input.pgRegistry.pgResources;
  const { executor } = users;
  return {
    typeDefs: gql`...`,
    plans: {
      Mutation: {
        registerUser(_, { $input: { $username, $email } }) {
          const $result = withPgClient(
            executor,
            list([$username, $email]),
            async (pgClient, [username, email]) => {
              try {
                return await pgClient.withTransaction(async (pgClient) => {
                  // 用户注册逻辑
                  const { rows: [user] } = await pgClient.query({
                    text: `INSERT INTO app_public.users (username) VALUES ($1) RETURNING *`,
                    values: [username],
                  });

                  await pgClient.query({
                    text: `INSERT INTO app_public.user_emails(user_id, email) VALUES ($1, $2)`,
                    values: [user.id, email],
                  });

                  await sendEmail(email, "Welcome!");
                  return { id: user.id };
                });
              } catch (e) {
                // 错误处理逻辑
                if (e instanceof DatabaseError && e.code === "23505") {
                  if (e.constraint === "unique_user_username") {
                    return {
                      __typename: "UsernameConflict",
                      message: `用户名'${username}'已被占用`,
                      username,
                    };
                  } else if (e.constraint === "unique_user_email") {
                    return {
                      __typename: "EmailAddressConflict",
                      message: `邮箱'${email}'已被使用`,
                      email,
                    };
                  }
                }
                throw e;
              }
            },
          );
          return object({ result: $result });
        },
      },
      RegisterUserPayload: {
        __assertStep: ObjectStep,
        result($data: ObjectStep) {
          const $result = $data.get("result");
          return polymorphicBranch($result, {
            UsernameConflict: {},
            EmailAddressConflict: {},
            User: {
              match(obj) {
                return obj.id != null;
              },
              plan($obj) {
                const $id = access($obj, "id");
                return users.get({ id: $id });
              },
            },
          });
        },
        query() {
          return constant(true);
        },
      },
      UsernameConflict: {
        __assertStep: ExecutableStep,
      },
      EmailAddressConflict: {
        __assertStep: ExecutableStep,
      },
    },
  };
});

关键技术点解析

1. 事务处理：使用 pgClient.withTransaction 确保操作的原子性，要么全部成功，要么全部回滚。

2. 错误处理：捕获数据库错误，根据错误代码和约束条件判断具体错误类型，返回相应的冲突对象。

3. 联合类型解析：使用 polymorphicBranch 方法处理联合类型的不同分支，确保 GraphQL 查询能够正确解析返回的数据。

4. 类型一致性：通过 __assertStep 确保所有联合类型成员都遵循相同的执行步骤模式，这是 Graphile/Crystal 特有的要求。

实际应用建议

1. 错误处理扩展：可以根据业务需求扩展冲突类型，添加更多字段如建议可用用户名等。

2. 邮件发送优化：建议将邮件发送逻辑放入任务队列，避免阻塞主流程。

3. 性能考虑：对于高频操作，可以考虑添加缓存层减少数据库查询。

4. 安全性：确保所有用户输入都经过适当验证和转义，防止注入攻击。

总结

Graphile/Crystal 提供了强大的工具来处理 GraphQL 中的复杂返回类型场景。通过合理使用联合类型和相应的解析逻辑，我们可以构建出既灵活又类型安全的 API。本文展示的用户注册场景只是其中一个示例，这种模式可以广泛应用于各种需要返回多种可能结果的 GraphQL 操作中。