美文网首页GraphQL
GraphQL on Rails(一) GraphQL介绍

GraphQL on Rails(一) GraphQL介绍

作者: falm | 来源:发表于2016-05-07 18:06 被阅读1150次

    GraphQL

    GraphQL按照官方的说法它是一门声明式的查询语言,实际上它是领域特定查询语 DSQL,它通过定义的schema系统将复杂的逻辑拆分成细粒度的数据结构,来让前端应用的开发者能够通过GraphQL提供的类型查询系统,自由定制请求数据的能力。

    GraphQL与RESTful

    目前大多数应用的API采用的都是流行的RESTful API,但是对于很多需求变更频繁的,数据查询颗粒的小的应用来说,使用RESTful的API总是在不断的迭代,不断的更新版本。这会导致应用的API系统过于复杂,而且通常最后又大量冗余的API进而变动难以维护。

    “The REST interface is designed to be efficient for large-grain hypermedia data transfer…” - Dr Roy T Fielding, Author of REST

    其实REST本身更适合数据力度大,需求变更不频繁的应用场景,而在细粒度的应用场景下的解决方案,在Facebook的复杂系统中应运而生,GraphQL被用于解决细粒度的API问题已经3年多了,处理了260多亿次的请求,这注意证明它在真实的场景下是经得起考验的。

    整个GraphQL的核心就是一个类型定义系统,通过定义各种可能的查询类型和所有的返回数据的类型,来构建一个查询系统,让客户端通过统一的查询语言,来对系统中的类型进行匹配,并最终返回,相匹配的数据。

    GraphQL 由以下组件构成:

    • 类型系统(Type System)
    • 查询语言(Query Language)
    • 执行语义(Execution Semantics)
    • 静态验证(Static Validation)
    • 类型检查(Type Introspection)

    类型

    GraphQL中类型系统是最重要的组成部分之一,其中提供的类型分为两种,一种是标量类型,用于表示最细粒度的类型,这些类型基本可以和JavaScript,Ruby及其他通用编程语言对应上。
    标量类型:

    • Int : 整数,对应 JavaScript 的Number
    • Float :浮点数,对应 JavaScript 的 Number
    • Boolean:布尔值,对应 JavaScript 的 Boolean
    • String : 字符串,对应 JavaScript 的 String
    • ID : D 值,是一个序列化后值唯一的字符串,可以视作对应 ES 2015 新增的 Symbol

    其他的高级类型:

    • Object : 对象类型 ,用于表示GraphQL返回类型树的中间层级,标量类型表示的都是叶子节点,在GraphQL基本上所以的类型都是Object类型,它包含有一个name字段来描述定义的类型和fields字段描述该类型的完整数据结构。
    var AddressType = new GraphQLObjectType({
        name: 'Address',
        fields: {
          street: { type: GraphQLString },
          number: { type: GraphQLInt },
          formatted: {
            type: GraphQLString,
            resolve(obj) {
              return obj.number + ' ' + obj.street
            }
          }
        }
    });
    
    • Interface : 接口类型 用于描述多个类型中通用的字段
    var EntityType = new GraphQLInterfaceType({
        name: 'Entity',
        fields: {
          name: { type: GraphQLString }
        }
    });
    
    • Union : 联合 它有点像可选类型,用于表示这一个字段可能是一个类型集合下的某一种类型。
    var PetType = new GraphQLUnionType({
        name: 'Pet',
        types: [DogType, CatType],
        resolveType(value) {
          if (value instanceof Dog) {
            return DogType;
          }
          if (value instanceof Cat) {
            return CatType;
          }
        }
    });
    
    • Enum :枚举类型
    var RGBType = new GraphQLEnumType({
        name: 'RGB',
        values: { 
          RED: { value: 0 },
          GREEN: { value: 1 },
          BLUE: { value: 2 } 
        }
    });
    
    • List : 列表类型
    var PersonType = new GraphQLObjectType({
       name: 'Person',
        fields: () => ({
          parents: { type: new GraphQLList(Person) },
          children: { type: new GraphQLList(Person) },
        })
    });
    
    • Non-Null : 不为空类型,用于表示返回的字段不为空,如果为空就会发生异常,可用于数据库的主键。
    var RowType = new GraphQLObjectType({
        name: 'Row',
        fields: () => ({
          id: { type: new GraphQLNonNull(GraphQLString) }
        })
    });
    

    查询

    GraphQL的客户端,是通过一个查询字符串通过,GraphQL服务可以解析验证并执行这样的查询请求字符串,一个查询字符串有两部分组成:操作(Operation)和片段(Fragments) 一个 query 可以包含多个操作和片段。只有包含操作的 query 才会被 GraphQL 服务执行。但是不包含操作,只有片段的 query 也会被 GraphQL 服务解析验证,这样一份片段就可以在多个 query 文档内使用。

    GraphQL 规范支持两种操作:

    let schema = new GraphQLSchema({ query: UserType mutation: UpdateAgeType});
    
    • query:仅获取数据(fetch)的只读请求
    query {
        user(id: 3500401) {
          id,
          name,
          age
        }
    }
    
    • mutation:获取数据后还有写操作的请求
    mutation {
        updateAage
    }
    

    其中GraphQL对数据的修改称为mutation ,它在GraphQL的查询系统中是按照顺序序列化执行的。

    查询请求模型:


    总结

    GraphQL在技术上提供了区别于REST的解决方案,很好的解决了数据细粒度频繁变更的问题,使得数据和接口得到了解绑,在生态圈方便面,现已经有很多语言的GraphQL实现(Python 、Ruby 等)可以参见 GraphQL Awesome list。在应用方面虽然是2015年才被Facebook公布并且开源的,但是它已经在Facebook的应用系统中工作了快四年之久。而且现在不少国内的团队(比如淘宝)也已经在使用GraphQL构建应用系统的API,这些都足以证明这项技术的市场和潜力了。

    相关文章

      网友评论

        本文标题:GraphQL on Rails(一) GraphQL介绍

        本文链接:https://www.haomeiwen.com/subject/ijbcrttx.html