没有`graphql-tools`

时间:2017-12-15 01:34:19

标签: javascript graphql graphql-js

在官方文档中阅读本演练后:

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制作&#34;可执行架构&#34;来自基于字符串的类型定义和解析器对象。我想知道为什么没有可用于定义和解析自定义标量类型的更低级别/命令式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]

我寻求的答案可以帮助我在不使用graphql-tools的情况下返回JSON类型。我没有反对这个库,但对我来说,我必须使用第三方库来获得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语法创建我的架构,这是我的目标。

1 个答案:

答案 0 :(得分:9)

<强>更新

经过一些澄清之后,看起来您正在尝试将自定义标量添加到使用模式语言创建的模式中。由于构建buildSchema(或其他客户端工具)的模式没有绑定serializeparseValueparseLiteral的处理函数,因此需要修改构建的模式以包含那些。你可以做点什么

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确实创建了一个模式,但该模式没有与之关联的resolve,serialize,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')
  }
})