GraphQL：如何使用 Sift.js 启用任意列表过滤。

原创文章

通常，您的 GraphQL 模式中存在一个列表数据类型，并且常见的要求是根据某些输入变量过滤列表。过滤是一项至关重要的功能，它允许用户仅检索他们需要的数据，从而使应用程序更加高效且用户友好。

使用支持查询的外部数据源时，有许多库和资源可用于过滤，例如数据库前面的 Prisma。然而，当编写您自己的返回 GraphQL 对象列表的解析器时，抽象出过滤逻辑并使其可在您的架构中重用将是有益的。

让我们考虑一个用于书籍列表的简单 GraphQL 模式：

type Book {
  title: String
  price: Float
}

type Query {
  books: [Book]
}

下面的解析器从简单列表中返回书籍列表。这可以是任何数据源。

const books = [
  { title: 'The Great Gatsby', price: 10.99 },
  { title: 'To Kill a Mockingbird', price: 12.99 },
  // more books
];

const resolvers = {
  Query: {
    books: () => books,
  },
};

对于我们的示例，假设用户需要根据以下条件过滤书籍：

• 标题以什么开头

• 价格在一定范围内，小于和大于

如何在 GraphQL 中定义单独的过滤器和逻辑

实现过滤器的一种方法是单独定义每个过滤器。这涉及对 GraphQL 架构输入类型进行更改并在解析器逻辑中实现过滤器。

您可以更新架构以包含这些新的输入变量，从而允许您表达允许的过滤器以及使用它们所需的参数：

input BookFilter {
  titleStartsWith: String
  priceLessThan: Float
  priceGreaterThan: Float
}

type Query {
  books(filter: BookFilter): [Book]
}

更新后的解析器可能如下所示：

const resolvers = {
  Query: {
    books: (_, { filter }) => {
      return books.filter(book => {
        if (filter.titleStartsWith && !book.title.startsWith(filter.titleStartsWith)) {
          return false;
        }
        if (filter.priceLessThan !== undefined && book.price >= filter.priceLessThan) {
          return false;
        }
        if (filter.priceGreaterThan !== undefined && book.price <= filter.priceGreaterThan) {
          return false;
        }
        return true;
      });
    },
  },
};

使用这种语法进行查询相当容易理解。您可以向 GraphQL 解析器提供一个过滤器参数，并根据需要为这些过滤器输入字段提供值。

这种方法的好处

仅支持您希望允许用户使用的过滤器。

这是由 GraphQL 类型验证系统支持的，该系统不允许进行超出允许范围的过滤。后端的解析器代码本身甚至不支持不允许的过滤器。

这种方法的缺点

您必须在 GraphQL 模式和代码实现中单独定义每个过滤器。

您无法在不同的 GraphQL 对象之间轻松共享此代码。如果您还有视频并想要过滤它们，则需要一个新的视频过滤输入类型。 （您可以概括为过滤器输入，但书籍和视频不会有所不同。）

如果需要新的过滤器，则需要更改代码以添加到输入过滤器类型并更新解析器代码以支持它。

例如，如果您想过滤在任何地方（而不仅仅是开头）包含子字符串的标题，这是一个新的过滤器输入和解析器中的新实现。

通过接受 Sift 查询语言作为过滤器输入进行任意过滤

我发现的一个有趣的库 sift，允许使用 MongoDB 查询语法轻松过滤 JavaScript 中的任意数据列表。我认为这真的很酷，可以在 GraphQL 中启用任意过滤。无头 CMS Strapi 之前使用 Sift，然后转向更自定义的解决方案来启用其 GraphQL 查询！

我对此感到最兴奋，因为它似乎是一种在某种程度上重现一些 ORM 和提供商已内置到其 GraphQL 服务中的有用自动过滤的方法。即使数据不是来自某个数据库也没关系。

您可以将上述架构重写为以下内容：

input SiftQueryInput {
  field: String
  filter: String
}

type Query {
  books(filter: [SiftQueryInput]): [Book]
}

解析器：

const sift = require('sift').default;

const resolvers = {
  Query: {
    books: (_, { filter }) => {
      const siftQuery = filter.reduce((acc, { field, filter }) => {
        acc[field] = JSON.parse(filter);
        return acc;
      }, {});
      return books.filter(sift(siftQuery));
    },
  },
};

那么这是如何运作的呢？假设您要查询所有以“The”开头的书籍。您可以执行此查询：

query {
  books(filter: [{ field: "title", filter: "{\"$regex\": \"^The\"}" }]) {
    title
    price
  }
}

使用这些变量：

{
  "filter": [
    { "field": "title", "filter": "{\"$regex\": \"^The\"}" }
  ]
}

正如预期的那样，您将返回过滤为“了不起的盖茨比”的列表！

另一个例子，如果您想过滤包含字母“i”并且价格大于 10 的书籍，您可以提供以下变量：

{
  "filter": [
    { "field": "title", "filter": "{\"$regex\": \"i\"}" },
    { "field": "price", "filter": "{\"$gt\": 10}" }
  ]
}

然后你就拿回了《杀死一只知更鸟》这本书！

请注意，我们不必更改查询、架构或解析器中的任何内容！我们能够表达全新的过滤器，而这些过滤器在其他方法中需要新的过滤器输入，只需使用 Sift 查询语法在变量中即可！

这种方法的好处

Sift 支持的任何过滤逻辑现在都可以在您的查询中表达。如果不同的过滤器出现新的需求，则不需要使用新的输入类型和解析器逻辑进行更新。

相同的过滤方法可以用于所有类型！仅接受 SiftQueryInputs 列表，以及处理这些 Sift 输入并将它们应用到对象列表的后端实现不会因列表类型而改变。

如果对象的形状发生变化或嵌套，这可以轻松支持对象。 SiftQueryInput.field 的类型为 String，因为您可以使用点语法访问对象上的嵌套属性。

例如，可以通过包含此 Sift 查询进行过滤： { field: 'author.name.last', filter: JSON.stringify({ $eq: "Orwell" }) }

缺点和注意事项

当然，这是使用字符串来表达 Sift 查询语言，这很容易出错——因此使用这种方法需要仔细的验证和错误处理。

通过使用通用的 SiftQueryInput 类型来收集用户的过滤器，您将失去 GraphQL 的类型安全性 - 它无法验证该字段是否存在或您的过滤器是否以正确的方式使用该字段。

列表的数据需要在过滤解析器运行时完全解析。它无法访问查询中尚未解决的字段。但对于数据不是来自具有自己查询的数据库（可能来自 JSON 文件或 REST API 响应）的情况，这无论如何都是可能的。

未来的改进

我认为在这种情况下失去 GraphQL 安全性是一种耻辱。可以在构建时将可能的 Sift 查询选项编译到 GraphQL 模式中，因此语法更相似地反映 Sift 的实际情况，而不依赖于字符串。

结论

总之，在 GraphQL 中使用 Sift.js 提供了一种灵活而强大的方法来实现任意过滤。它为列表中的纯 JavaScript 对象带来了通常为 ORM 和某些 GraphQL 供应商保留的自动查询优势，无论其来源如何。

通过在 GraphQL 服务器中提供通用过滤“引擎”，以及可应用于任何类型的灵活查询语言，将过滤逻辑转移到 GraphQL 客户端。这使得过滤器的迭代速度更快，并在过滤器中实现更大程度的表达。

我很想听听您在 GraphQL 中实现过滤的想法和经验 - 在下面的评论中分享！

以上是GraphQL：如何使用 Sift.js 启用任意列表过滤。的详细内容。更多信息请关注PHP中文网其他相关文章！