如何在Apollo GraphQL中避免返回null值 适配功能开关开发场景

GraphQL 规范默认行为是：只要客户端查询中显式请求了某个字段，服务端就会在响应中返回对应的键，若该字段无值且类型允许为空时，会自动填充null。要实现未返回的字段直接不展示，可选择以下两种方案：

方案1：全局响应后置处理（推荐适配功能开关场景） #

直接在express-graphql的响应格式化钩子中递归移除所有值为null的字段，无需修改现有类型定义和resolver逻辑：

1. 首先定义null值清理工具函数

function removeNullFields(obj) {
  // 处理数组类型
  if (Array.isArray(obj)) {
    return obj.map(removeNullFields).filter(item => item !== null)
  }
  // 处理对象类型
  if (obj && typeof obj === 'object') {
    return Object.fromEntries(
      Object.entries(obj)
        .filter(([_, value]) => value !== null)
        .map(([key, value]) => [key, removeNullFields(value)])
    )
  }
  return obj
}

2. 在express-graphql初始化配置中添加formatResponse钩子

app.use('/graphql', graphqlHTTP({
  schema: yourSchema, // 替换为你自己的schema实例
  graphiql: true,
  // 新增响应格式化配置
  formatResponse: (response) => removeNullFields(response)
}))

方案2：字段级别单独控制 #

如果仅需要对功能开关类字段做省略null的处理，不想全局修改响应逻辑，可以给每个开关字段单独添加resolver：

const GetResponseType = new GraphQLObjectType({
  name: 'GetResponseType',
  fields: () => ({
    someFieldA: { 
      type: GraphQLBoolean,
      resolve: (parent) => parent.someFieldA
    },
    someFieldB: { 
      type: GraphQLBoolean,
      // 父对象不存在该属性时直接返回undefined
      resolve: (parent) => parent.hasOwnProperty('someFieldB') ? parent.someFieldB : undefined
    },
  })
})

该方案需要注意：如果仅用此方案未搭配全局处理，部分graphql版本仍会自动将undefined转为null返回，因此更推荐方案1。

内容的提问来源于stack exchange，提问作者Mike K