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

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

2025-05-11 05:07:19作者:谭伦延

在 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 客户端应用。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K
kernelkernel
deepin linux kernel
C
22
6
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0