Pothos GraphQL 中自定义连接分页默认值的最佳实践

在 GraphQL 中，分页是一个常见需求，Pothos GraphQL 提供了强大的 Relay 风格连接分页功能。本文将深入探讨如何在使用 Pothos 时自定义连接分页的默认值和最大值设置。

默认分页限制的问题

Pothos GraphQL 默认将连接分页的大小设置为 20，这对于大多数应用来说是一个合理的默认值。然而，在某些特定场景下，特别是那些大量使用客户端分页的团队，这个默认值可能会显得过小。开发者经常需要为每个新创建的连接手动调整这个值，这不仅增加了工作量，也容易遗漏。

解决方案探讨

1. 自定义连接辅助函数

最直接的解决方案是创建自定义的连接辅助函数。这种方法允许你封装 Pothos 提供的原始连接方法，并注入你自己的默认值：

// 自定义连接辅助函数
function customRelatedConnection(t, name, options) {
  return t.relatedConnection(name, {
    defaultSize: 50,  // 自定义默认值
    maxSize: 100,     // 自定义最大值
    ...options
  });
}

使用这种方式，你可以在项目中统一使用这个自定义函数，而不是直接使用 Pothos 提供的原始方法。

2. 针对 Prisma 插件的特殊配置

如果你使用的是 Pothos 的 Prisma 插件，现在有更优雅的解决方案。最新版本的 Pothos 已经为 Prisma 相关的连接方法添加了配置选项：

const builder = new SchemaBuilder({
  plugins: [PrismaPlugin],
  prisma: {
    // 全局配置连接分页默认值
    defaultConnectionPageSize: 50,
    maxConnectionPageSize: 100,
  },
});

这种配置方式更加简洁，且不需要修改现有的连接创建代码。它特别适用于已经大量使用 Prisma 相关连接方法的项目。

实现选择建议

1. 小型项目或少量连接：使用自定义辅助函数是简单直接的选择
2. 大型项目或大量使用 Prisma：推荐使用全局配置方式
3. 混合使用场景：可以结合两种方法，对 Prisma 连接使用全局配置，对其他类型连接使用自定义函数

注意事项

1. 设置过大的分页值可能会影响性能，需要根据实际数据量和查询复杂度进行调整
2. 在 GraphQL 规范中，客户端通常应该能够覆盖默认分页设置
3. 考虑在 API 文档中明确说明默认和最大分页值，方便前端开发者使用

通过合理配置分页默认值，可以显著提升开发效率，同时保持 API 的灵活性和性能。Pothos 提供的多种配置方式让开发者能够根据项目需求选择最适合的方案。