graphQL自定义标量

除规范定义的标量外,还可以按需定义业务范畴内的标量。语法非常简单

本文是基于node实现的服务定义

scalar Datetime

注意,这只是语义范畴定义,还需要定义序列化、反序列化函数:

new GraphQLScalarType({
  name: "Datetime",
  description: "日期时间标量类型",
  // 序列化函数
  serialize(value) {
    return value.toString();
  },
  // 解析函数
  parseValue(value) {
    if (typeof value === "string") {
      return new Date(value);
    }
    throw new Error("参数类型错误");
  },
  // 解析函数
  parseLiteral(ast) {
    if (ast.kind === Kind.STRING) {
      return new Date(ast.value);
    }
    throw new Error("参数类型错误");
  }
});

关于graphQL标量类型定义详细内容参考官方文档

下面我们一个一个看这些配置:

  1. name: 字段名,请保持与schema中定的标量类型名称保持一致
  2. description: 类型描述,在一些诊断工具上还是很有用的
  3. serialize: 序列化函数,用于将结果转换为适合 http 传输的数值类型
  4. parseValue: 解析函数,用于将客户端通过 variables 参数传递的数值为 Date 类型
  5. parseLiteral: 同样是解析函数,将客户端传递的字面量参数解析为 Date 类型

配置中的 parseValue、parseLiteral 两个函数功能上相似,都用于解析客户端参数,分别处理两种参数传递方式:

# 1. variables 参数
# 引擎将调用 parseValue 函数
query (before: Datetime){
  users(before: $before) {
    id
    name
  }
}

variables {
  before: "1991-02-19"
}

# 2. 字面量参数
# 引擎将调用 parseLiteral 函数
query {
  users(before: "1991-02-19") {
    id
    name
  }
}

最后说一些注意点:

  1. 如果类型确定不会作为 InputType,可以省略 parseValue、parseLiteral
  2. parseValue 接收到的是 variables 对象中对应的值;而 parseLiteral 接收的则是引擎从 query 语句中解析出的 AST 节点。AST 节点内容形如:
{
  // 字面量类型
  "kind": "StringValue",
  // 字面量值
  "value": "1991-02-19",
  // 指明字面量是否为 [BlockStringValue](https://facebook.github.io/graphql/June2018/#BlockStringValue()) 类型
  "block": false,
  // token 位置
  "loc":
  {
    "start": 18,
    "end": 30
  }
}

在定义具体数据类型的时候可以使用这个新类型:

type Comment {
  id: Int!
  content: String
  feedbackId: Int
  gmtCreate: Datetime
  gmtModified: Datetime
}
返回对象的标量

标量类型也支持返回结构化的对象,只要能为引擎提供符合规则的 serialize 函数,一切皆有可能。我们可以写出这样一个标量:

// Address 对象类型,不过这是一个标量
new GraphQLScalarType({
  name: "Address",
  description: "对象类型的标量",
  serialize(value) {
    // value 为对象类型
    // value = { city: '深圳', province: '广东省', country: '中国' }
    return value;
  }
});

但是要注意,标量类型是 不可分割 的,不能再传入查询子集:

# 合法请求
query {
  users {
    id
    name
    # Address 类型值
    bornOrigin
  }
}

返回结果:

{
  "data": {
    "users": [
      {
        "id": "1",
        "name": "foo",
        "bornOrigin": {
          "city": "深圳",
          "province": "广东省",
          "country": "中国"
        }
      }
    ]
  }
}

总结

标量是 GraphQL 中的原子类型,一般充当查询的叶子节点。 GraphQL 规范提供了五种标量类型,其中 ID 最为特殊,用于唯一标志一个资源实例。 在标准标量之外,也可以按需定义新的标量,规则如上。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容