在GraphQL typeDefs中定义String/Boolean联合类型时出现500错误

我之前也踩过这个坑！GraphQL的union类型有个容易忽略的严格限制：它只能用来组合对象类型（Object Types），像String、Boolean这种内置标量类型是不能直接作为Union成员的，这就是你在GraphiQL查询时出现500错误的核心原因。

要实现datesValid字段同时支持返回String或Boolean类型，正确的做法是创建一个自定义标量类型，下面是完整的解决方案：

步骤1：定义自定义标量和修改TypeDefs #

首先在你的typeDefs里声明自定义标量，并把datesValid字段的类型替换成这个标量：

const typeDefs = `
  # 声明自定义标量，用来处理String或Boolean类型
  scalar StringOrBoolean

  type Analysis {
    id: String
    analysisName: String
    creator: String
    description: String
    datesValid: StringOrBoolean
  }

  # 记得加上你的查询根类型（根据实际业务调整）
  type Query {
    getAnalysis(id: String): Analysis
  }
`;

步骤2：实现自定义标量的解析逻辑 #

接下来需要在resolver里实现这个自定义标量的序列化、解析逻辑，确保它能正确处理String和Boolean两种类型：

const { GraphQLScalarType, Kind } = require('graphql');

// 定义自定义标量的处理逻辑
const StringOrBooleanScalar = new GraphQLScalarType({
  name: 'StringOrBoolean',
  description: '支持String或Boolean类型的自定义标量',
  // 序列化：把服务器端的值转换为客户端可接收的格式
  serialize(value) {
    if (typeof value === 'string' || typeof value === 'boolean') {
      return value;
    }
    throw new Error('StringOrBoolean标量仅支持String或Boolean类型的值');
  },
  // 解析客户端传入的变量值
  parseValue(value) {
    if (typeof value === 'string' || typeof value === 'boolean') {
      return value;
    }
    throw new Error('StringOrBoolean标量仅能解析String或Boolean类型的变量');
  },
  // 解析GraphQL查询中的字面量（比如直接写的字符串或布尔值）
  parseLiteral(ast) {
    if (ast.kind === Kind.STRING || ast.kind === Kind.BOOLEAN) {
      return ast.value;
    }
    throw new Error('StringOrBoolean标量仅能解析String或Boolean类型的字面量');
  },
});

// 在resolvers中注册这个自定义标量
const resolvers = {
  StringOrBoolean: StringOrBooleanScalar,
  Query: {
    getAnalysis: (parent, args) => {
      // 示例返回数据，这里可以根据业务逻辑返回String或Boolean
      return {
        id: args.id,
        analysisName: '用户行为分析',
        creator: 'Musa',
        description: '针对用户行为的统计分析',
        datesValid: true, // 或者返回字符串比如 "2024-01-01至2024-12-31"
      };
    },
  },
};

注意事项 #

• 在客户端查询时，你需要处理datesValid可能返回两种类型的情况，比如通过typeof判断返回值是字符串还是布尔值后再做后续逻辑。
• 如果你的业务需要在mutation输入中也支持这个类型，上面的自定义标量已经处理了parseValue和parseLiteral，可以直接使用。

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