GraphQL 中的 Schema Stitching 理解及实践

GraphQL 是一个深受欢迎的用于构建 API 的技术，它的优势在于可以让前端开发者查询自己所需的数据，而不是收到后端传来的所有数据。在使用 GraphQL 构建 API 时，尤其是在团队协作中，需要组合多个 schema 时，使用 Schema Stitching 可以方便地将这些 schema 融合到一个大 schema 中。

什么是 Schema Stitching

Schema Stitching 即将多个 schema 合并成一个大 schema，使其看起来像单个 schema，从而让客户端能够像发起单一请求一样请求到组合后的数据。在 GraphQL 中，每个 schema 都描述了对应的 API 的数据模型，其中包含了类型定义，查询、变更和订阅等操作。

实际上，在应用程序的不同层级中都可能存在着多个 schema，例如在微服务中，一个 API 服务可能有不同的数据源，每个数据源都有自己的 schema。使用 Schema Stitching 可以将这些 schema 组合成一个大 schema，然后由客户端对它进行查询。这样做的好处在于：

• 更好的抽象和复用多个 GraphQL API
• 在 GraphQL API 中引入可重用和可组合的代码和功能
• 可以更好地支持微服务架构，更灵活地处理 schema 和数据源的组合

实现 Schema Stitching

Schema Stitching 是一个复杂的概念，但我们可以将其拆分成各个部分来更好地理解它的实现细节。

模式通信

首先，让我们建立一个小型的 schema。考虑以下的类型定义，其中包含了一个 Query 类型和一个 Movie 类型：

type Query {
  movie(id: ID!): Movie
}

type Movie {
  id: ID!
  title: String!
  year: Int!
  director: String!
}

怎样合并这个 schema 呢？首先，我们需要将其转换成一个对象。可以使用以下代码将其转换成一个封装了类型定义的对象：

const schema = makeExecutableSchema({
  typeDefs: `
    type Query {
      movie(id: ID!): Movie
    }

    type Movie {
      id: ID!
      title: String!
      year: Int!
      director: String!
    }
  `,
  resolvers: {},
});

然后我们需要将所有需要合并的 schema 转换成对象并将它们传递给一个 mergeSchemas 函数：

import { mergeSchemas } from "graphql-tools";

const schema1 = makeExecutableSchema({
  typeDefs: `
    type Query {
      foo: String
    }
  `,
  resolvers: {},
});

const schema2 = makeExecutableSchema({
  typeDefs: `
    type Query {
      bar: String
    }
  `,
  resolvers: {},
});

const mergedSchema = mergeSchemas({
  schemas: [schema1, schema2, schema],
});

这里，我们使用了 mergeSchemas 函数来合并三个 schema，即 schema1、schema2 和我们之前定义的 schema。该函数将这三个 schema 合并成一个大 schema。我们可以像对待单个 schema 一样对待合并后的 schema，从而获得相同的查询和变更能力。

解析器

其次，我们需要将解析器添加到所有受到合并的 schema 中，从而能够处理查询和变更。一个解析器负责处理某个类型的查询或变更，可以是一个 JavaScript 类或函数。解析器需要从一个 GraphQL 对象中获取所需的数据并将其返回给客户端。

const resolvers = {
  Query: {
    movie(_, { id }) { // 获取 ID 参数
      return movies.find((movie) => movie.id === id); // 从电影数组中返回电影对象
    },
  },
};

对于每个类型字段，我们需要提供一个对应的解析器。解析器需要将某个对象或值映射到该类型的解析函数。

const resolvers = {
  Query: {
    movie(_, { id }) { // 获取 ID 参数
      return movies.find((movie) => movie.id === id); // 从电影数组中返回电影对象
    },
  },
  Movie: {
    // 解析器负责将电影对象映射到 GraphQL 中的 Movie 类型
    title(movie) {
      return movie.title;
    },
    year(movie) {
      return movie.year;
    },
    director(movie) {
      return movie.director;
    },
  },
};

按需解析

最后，我们需要确保按需解析返回的字段。这是 GraphQL 的一个强大功能，它能够减少网络请求，快速返回请求结果。

例如，假设我们要查询电影的标题、年份和导演：

{
  movie(id: "1") {
    title
    year
    director
  }
}

这就意味着我们需要为每个字段提供一个对应的解析器。但是，如果我们查询以下字段，

{
  movie(id: "1") {
    title
  }
}

那么我们便不需要为年份和导演提供解析器。

解决这个问题的方法是使用“添加一些”模式（additive pattern）。我们可以在每个解析器函数中检查 GraphQL 对象中的字段：

const resolvers = {
  Query: {
    movie(_, { id }) { // 获取 ID 参数
      return movies.find((movie) => movie.id === id); // 从电影数组中返回电影对象
    },
  },
  Movie: {
    title(movie, _, context, info) {
      // 如果客户端只请求了 `title`，那么我们只需要返回电影名称
      if (info.fieldNodes.some((node) => node.name.value === "title")) {
        return movie.title;
      }

      // 如果客户端请求了所有字段，我们返回一个包含全部字段的电影对象
      return movie;
    },
    year(movie, _, context, info) {
      if (info.fieldNodes.some((node) => node.name.value === "year")) {
        return movie.year;
      }

      return null;
    },
    director(movie, _, context, info) {
      if (info.fieldNodes.some((node) => node.name.value === "director")) {
        return movie.director;
      }

      return null;
    },
  },
};

这里，我们使用了 fieldNodes 属性来检查客户端请求的字段，并返回响应的数据。如果客户端查询所有字段，我们将返回一个完整的电影对象，如果只查询了部分字段，我们只需返回相应的字段即可。

示例代码

下面是一个演示了如何使用 Schema Stitching 的示例代码。我们有两个 schema，分别用于处理用户和文章数据：

import { makeExecutableSchema } from "graphql-tools";

const userSchema = makeExecutableSchema({
  typeDefs: `
    type Query {
      user(id: ID!): User
    }

    type User {
      id: ID!
      name: String!
      email: String!
    }
  `,
  resolvers: {
    Query: {
      user: (_, { id }) => {
        return { id, name: "Alice", email: "alice@example.com" };
      },
    },
  },
});

const postSchema = makeExecutableSchema({
  typeDefs: `
    type Query {
      post(id: ID!): Post
    }

    type Post {
      id: ID!
      title: String!
      authorId: ID!
    }
  `,
  resolvers: {
    Query: {
      post: (_, { id }) => {
        return { id, title: "Hello, world!", authorId: "1" };
      },
    },
    Post: {
      author(post) {
        return { id: post.authorId };
      },
      title(post) {
        return "Hello, GraphQL!";
      },
    },
  },
});

我们可以使用 mergeSchemas 函数将这两个 schema 合并成一个大 schema：

import { mergeSchemas } from "graphql-tools";

const schema = mergeSchemas({
  schemas: [userSchema, postSchema],
});

接下来，我们可以在客户端查询 graphql API，使用以下代码查询用户和文章信息：

const query = `
  {
    user(id: "1") {
      name
      email
    }
    post(id: "1") {
      title
      author {
        name
        email
      }
    }
  }
`;

graphql(schema, query).then((result) => {
  console.log(JSON.stringify(result, null, 2));
});

这里，我们查询了用户 Alice 和她的文章 "Hello, GraphQL!"，并打印出了结果：

{
  "data": {
    "user": {
      "name": "Alice",
      "email": "alice@example.com"
    },
    "post": {
      "title": "Hello, GraphQL!",
      "author": {
        "name": "Alice",
        "email": "alice@example.com"
      }
    }
  }
}

总结

在本文中，我们介绍了什么是 Schema Stitching 及其优势。我们还讨论了如何实现 Schema Stitching，包括模式通信、解析器和按需解析。最后，我们演示了一个使用 Schema Stitching 的示例代码。

如果你正在使用 GraphQL 构建 API，那么 Schema Stitching 是一个非常有用的工具，可以帮助你更好地管理你的 schema，并支持微服务架构。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65a4cb8eadd4f0e0ffd22104