Apollo Client 中实现客户端专属字段参数的技巧

在 Apollo Client 项目中，开发者经常会遇到需要在不修改服务器端 GraphQL 模式的情况下，为字段添加客户端专属逻辑的需求。本文将深入探讨一种优雅的解决方案，通过自定义 Apollo Link 和类型策略来实现客户端专属字段参数。

问题背景

在典型的 GraphQL 应用中，我们可能遇到这样的场景：服务器返回一个包含完整姓名的字段，但在客户端大多数情况下只需要显示简化的姓名格式（如仅显示姓氏和名字）。然而，在某些特定场景下，又需要显示完整的原始姓名。

传统解决方案的局限性

常见的解决方案包括：

1. 使用 useFragment 直接从缓存中读取数据
2. 在客户端扩展 GraphQL 类型，添加 shortName 等新字段
3. 创建自定义 Hook 来访问缓存数据

这些方法虽然可行，但都存在一定局限性，要么不够优雅，要么需要大量重复代码。

创新解决方案：客户端专属参数

更优雅的解决方案是创建一个客户端专属的字段参数，该参数不会发送到服务器，但可以在客户端的类型策略中使用。实现这一方案需要以下几个关键步骤：

1. 扩展 GraphQL 类型定义

首先在本地 schema 中扩展类型定义，添加可选的参数：

extend type Model {
  name(full: Boolean): String!
}

2. 创建自定义指令

定义一个客户端指令来标记需要从请求中移除的参数：

directive @omitArgs(names: [String!]!) on FIELD

3. 实现 Apollo Link

创建自定义 Apollo Link 来处理 GraphQL 文档转换：

import { ApolloLink } from '@apollo/client'
import { ASTNode, FieldNode, Kind, visit } from 'graphql'

const OMIT_ARGS_DIRECTIVE_NAME = 'omitArgs'

function isField(node: unknown): node is FieldNode {
  return (node as ASTNode | undefined)?.kind === Kind.FIELD
}

function getOmittedArgs(field: FieldNode) {
  const toOmit = field.directives
    ?.find(d => d.name.value === OMIT_ARGS_DIRECTIVE_NAME)
    ?.arguments?.find(arg => arg.name.value === 'names')
  if (toOmit?.value.kind === Kind.LIST) {
    return toOmit.value.values
  }
}

export const stripClientArgs = new ApolloLink((operation, forward) => {
  operation.query = visit(operation.query, {
    Argument(node, _key, _parent, _path, ancestors) {
      const maybeField = ancestors.at(-1)
      if (isField(maybeField)) {
        const toOmit = getOmittedArgs(maybeField)
        const shouldOmit = toOmit?.some(f => {
          if (f.kind === Kind.STRING) {
            return f.value === node.name.value
          }
        })
        if (shouldOmit) {
          return null
        }
      }
    },
    Directive(node) {
      if (node.name.value === OMIT_ARGS_DIRECTIVE_NAME) {
        return null
      }
    },
  })
  return forward(operation)
})

4. 配置类型策略

在 Apollo Client 的类型策略中，根据参数值决定返回完整姓名还是简化格式：

import { TypePolicies } from '@apollo/client'

export const typePolicies: TypePolicies = {
  Model: {
    fields: {
      name: (name: string | undefined, { args }) => {
        if (!name || args?.full) {
          return name
        }
        const split = name.split(' ')
        if (split.length === 1) {
          return name
        }
        return `${split[0]} ${split.at(-1)}`
      },
    }
  }
}

5. 使用示例

在查询中使用自定义参数和指令：

query GetModels {
  models {
    name(full: true) @omitArgs(names: ["full"])
  }
}

方案优势

1. 代码简洁：无需创建额外字段或自定义 Hook
2. 类型安全：通过 GraphQL 代码生成器保持类型安全
3. 灵活性：可以根据不同场景轻松切换显示格式
4. 性能优化：避免了不必要的网络请求

总结

通过结合 Apollo Link 的文档转换能力和类型策略，我们实现了一种优雅的客户端专属参数解决方案。这种方法不仅解决了特定业务场景下的需求，还为类似问题提供了可复用的模式。开发者可以根据实际需求调整和扩展这一方案，例如支持更多类型的客户端参数或更复杂的转换逻辑。

这种解决方案展示了 Apollo Client 强大的可扩展性，通过合理利用其提供的各种扩展点，开发者可以创建出既符合业务需求又保持代码整洁的 GraphQL 客户端应用。