没有 `graphql-tools` 的 GraphQL 自定义标量定义

Question

阅读官方文档中的本演练后：

http://graphql.org/graphql-js/object-types/

我很困惑如何在没有第三方库的情况下制作自定义标量类型解析器。这是文档中的示例代码：

var express = require('express');
var graphqlHTTP = require('express-graphql');
var { buildSchema } = require('graphql');

// Construct a schema, using GraphQL schema language
var schema = buildSchema(`
  type RandomDie {
    numSides: Int!
    rollOnce: Int!
    roll(numRolls: Int!): [Int]
  }

  type Query {
    getDie(numSides: Int): RandomDie
  }
`);

// This class implements the RandomDie GraphQL type
class RandomDie {
  constructor(numSides) {
    this.numSides = numSides;
  }

  rollOnce() {
    return 1 + Math.floor(Math.random() * this.numSides);
  }

  roll({numRolls}) {
    var output = [];
    for (var i = 0; i < numRolls; i++) {
      output.push(this.rollOnce());
    }
    return output;
  }
}

// The root provides the top-level API endpoints
var root = {
  getDie: function ({numSides}) {
    return new RandomDie(numSides || 6);
  }
}

var app = express();
app.use('/graphql', graphqlHTTP({
  schema: schema,
  rootValue: root,
  graphiql: true,
}));
app.listen(4000);
console.log('Running a GraphQL API server at localhost:4000/graphql');

我知道我可以使用 graphql-tools 从基于字符串的类型定义和解析器对象中生成 "executable schema"。我想知道的是为什么没有较低级别/命令式 graphql-js API 我可以用来定义和解析自定义标量类型？换句话说，graphql-tools 是如何工作的？

提前致谢！

编辑：

这里是一些概述问题的示例代码。在第 4 行你可以看到我正在导入 GraphQLJSON 但它从未被使用过。我知道如何使用 graphql-tools 来完成这项工作，但我想了解如何它的工作原理。换句话说，如果 graphql-tools 不存在，我将如何注入自定义标量类型，同时仍然使用 graphql 语法编写我的模式？据我所知，唯一的 graphql-js 解决方案是使用非声明性方法来编写模式（下面的第二个示例）

import express from 'express';
import graphqlHTTP from 'express-graphql';
import { buildSchema } from 'graphql';
import GraphQLJSON from 'graphql-type-json'; // where should I inject this?

const schema = buildSchema(`
  type Image {
    id: ID!
    width: Int!
    height: Int!
    metadata: JSON!
  }

  type Query {
    getImage(id: ID!): Image!
  }

  scalar JSON
`);

class Image {
  constructor(id) {
    this.id = id;
    this.width = 640;
    this.height = 480;
  }
  metadata() {
    // what do I need to do in order to have this return value parsed by GraphQLJSON
    return { foo: 'bar' };
  }
}

const rootValue = {
  getImage: function({ id }) {
    return new Image(id);
  },
};

const app = express();
app.use(
  '/graphql',
  graphqlHTTP({
    schema: schema,
    rootValue: rootValue,
    graphiql: true,
  })
);
app.listen(4000);

运行这个查询：

{
    getImage(id: "foo") {
    id
    width
    height
    metadata
  }
}

导致此错误：

Expected a value of type \"JSON\" but received: [object Object]

我正在寻找的答案将帮助我 return JSON 类型而不使用 graphql-tools。我并不反对这个库，但我必须使用第三方库来处理 graphql-js 中类型解析系统如此基础的东西，这对我来说似乎很奇怪。在采用它之前，我想详细了解为什么需要这种依赖。

这里有另一种方法来完成这项工作：

import { GraphQLObjectType, GraphQLInt, GraphQLID } from 'graphql/type';

const foo = new GraphQLObjectType({
  name: 'Image',
  fields: {
    id: { type: GraphQLID },
    metadata: { type: GraphQLJSON },
    width: { type: GraphQLInt },
    height: { type: GraphQLInt },
  },
});

然而，这不允许我使用 graphql 语法创作我的模式，这是我的目标。

Answer 1

更新

经过一番澄清，您似乎正在尝试将自定义标量添加到使用模式语言创建的模式中。由于构建 buildSchema（或其他客户端工具）的模式没有针对 serialize、parseValue 和 parseLiteral 绑定的处理函数，因此您需要修改构建的模式以包含这些.你可以做类似

的事情

import { buildSchema } from 'graphql'
import GraphQLJSON from 'graphql-type-json'

const definition = `
type Foo {
  config: JSON
}

scalar JSON

Query {
  readFoo: Foo
}

schema {
  query: Query
}`

const schema = buildSchema(definition)
Object.assign(schema._typeMap.JSON, GraphQLJSON)

或者，您也可以执行以下操作，这可能有助于将标量重命名为其他名称

Object.assign(schema._typeMap.JSON, {
  name: 'JSON',
  serialize: GraphQLJSON.serialize,
  parseValue: GraphQLJSON.parseValue,
  parseLiteral: GraphQLJSON.parseLiteral
})

原答案

buildSchema 确实创建了一个模式，但该模式没有解析、序列化、parseLiteral 等与之关联的函数。我相信 graphql-tools 只允许您将解析器函数映射到字段，这在您尝试创建自定义标量时对您没有帮助。

graphql-js 有一个 GraphQLScalarType 可用于构建自定义标量。请参阅 http://graphql.org/graphql-js/type/#graphqlscalartype

上的官方文档和示例

npm 中也有几个包可以作为例子

我觉得非常有用的一个是 https://github.com/taion/graphql-type-json/blob/master/src/index.js

例如，如果您想创建一个 base64 类型，将字符串存储为 base64 并在响应中返回之前解码 base64 字符串，您可以像这样创建自定义 base64 标量

import { GraphQLScalarType, GraphQLError, Kind } from 'graphql'

const Base64Type = new GraphQLScalarType({
  name: 'Base64',
  description: 'Serializes and Deserializes Base64 strings',
  serialize (value) {
    return (new Buffer(value, 'base64')).toString()
  },
  parseValue (value) {
    return (new Buffer(value)).toString('base64')
  },
  parseLiteral (ast) {
    if (ast.kind !== Kind.STRING) {
      throw new GraphQLError('Expected Base64 to be a string but got: ' + ast.kind, [ast])
    }
    return (new Buffer(ast.value)).toString('base64')
  }
})

没有 `graphql-tools` 的 GraphQL 自定义标量定义

GraphQL custom scalar definition without `graphql-tools`

javascript

graphql

graphql-js