美文网首页
GraphQL查询语法

GraphQL查询语法

作者: 灯不梨喵 | 来源:发表于2017-12-15 22:32 被阅读0次

    中文官网指路:http://graphql.cn/code/#javascript
    github指路:https://github.com/graphql/graphql-js
    英文官网需要翻墙886:http://www.graphql.org/graphql-js/
    学习第一步,安装
    npm install --save graphql

    图片.png
    好了!开始学习!

    1小时后

    中文翻译什么鬼
    是我今天状态不好吗
    我真的阅读困难
    专有名词的解释实在是非常的不详细,结合例子才勉强理解,而且恕我直言,官方文档里面查询和schema的例子分离导致两边都不明确,一般学习数据库查询好歹让我知道我从什么东西里面查找吧?
    总之顶硬上啦嗨呀


    graphql的使用过程是:描述数据 - 请求数据 - 返回数据(JSON)
    graphql有两个大佬,一个是schema,一个是query
    schema是一个容器,它规定了我们可以查什么,而query则确定我们要查什么。
    schema是类似database的存在,但是并不是database。它具有权限方面的限制,一个用户对应一个schema。

    学习之前请打开源码对照

    例子源码在此
    事实上这是官方文档的例子,然而官方文档在开始前并没有告知,让我在前面摸不着头脑。
    源码有四个文件,截图方便我在预览模式下一边看代码一边写解释。

    图片.png
    我们先看schema文件葫芦里卖的什么药
    枚举Episode
    接口Character
    在这里出现了一个官方文档没有详细解说的东西,接口对象有一个函数resolveType,形参是character对象,函数判断character对象的类型然后返回相应的接口实现。
    实现接口的Human
    这是一个实现接口的类型,它的一个字段friends也自带了一个resolve函数返回值,使用了箭头函数表示,形参是human类型,返回getfriends(human),这个函数在别处声明了,我们等一下再回头分析。
    另一个实现接口的对象类型Droid
    查询对象Query
    在这里猛一回头发现自己重点学习应该是查询语法而不是后端要搞的定义对象,大意了,先不说这个了(我一时也没搞太清楚
    接下来say一下
    你以为我要说查询了吗
    我要说数据啦!
    humandata
    类似的还有droid的数据,这里不贴啦,再说说data文件提供了好多接口,否则schema文件里面没办法使用呢


    getHero方法的返回值是某一episode的主角,所以不要误会为什么它只有两个可能返回的值。
    方法接口在schema中被引入和使用。至于export type Human这样的接口,我找了好多文件还没找到引入它的,不知道在哪里起作用,哭哭
    这里的查询使用了mocha测试,那我们的 查询其实很简单,看语法解释,然后我们再用小例子做测试。

    schema

    • 查询类型
      schema 中大部分的类型都是普通对象类型,但是一个 schema 内有两个特殊类型:
    schema {
      query: Query
      mutation: Mutation
    }
    

    query类型声明依据具体查询而定,详看官方文档
    每一个 GraphQL 服务都有一个 query 类型,可能有一个 mutation 类型。

    • 对象类型
      GraphQL schema 中的最基本的组件是对象类型,它就表示你可以从服务上获取到什么类型的对象,以及这个对象有什么字段。
    type Student {
      name: String!
      course: [Courses]!
    }
    

    namecourse叫做字段String是graphql内置的标量类型,[Course]表示Course对象组成的数组。表示非空。
    数组非空的区别:
    myFiled:[String!]
    myField: null // 有效
    myField: [] // 有效
    myField: ['a', 'b'] // 有效
    myField: ['a', null, 'b'] // 错误

    myFiled[String]!
    myField: null // 错误
    myField: [] // 有效
    myField: ['a', 'b'] // 有效
    myField: ['a', null, 'b'] // 有效

    • 标量类型
      Int:有符号 32 位整数。
      Float:有符号双精度浮点值。
      String:UTF‐8 字符序列。
      Boolean:true 或者 false。
      ID:ID 标量类型表示一个唯一标识符,通常用以重新获取对象或者作为缓存中的键。ID 类型使用和 String 一样的方式序列化;然而将其定义为 ID 意味着并不需要人类可读型。
    • 枚举类型
    enum Courses {
      C++
      JAVA
      Software-Engineering
      Database Design
    }
    

    还有接口类型、联合类型、输入类型,详情看官方文档,这里主要讲述查询语法。

    query

    直接写例子吧

    query HeroNameAndFriends($episode: Episode = "JEDI", $withFriends: Boolean!) {
      firsthero:hero(episode: $episode) {
        name
        ... on Droid {
          primaryFunction
        }
        ... on Human {
          height
        }
      }
      secondhero:hero(episode: JEDI) {
        ...comparisonFields 
        friends @include(if: $withFriends) {   
          name
      }
    }
    fragment comparisonFields on Character {
      name
      appearsIn
    }
    

    HeroNameAndFriends是操作名称,可用可不用,方便回溯查询记录。
    $episode声明一个变量,它的类型是Episode,默认值为JEDI。$withFriends同理。变量在后面通过JSON传递值。
    firstherosecondhero是别名。例子中查询了两次hero字段,为了避免冲突,取了别名,于是在一次请求中获得两次结果。
    hero后面的(episode: $episode)表示参数,可以限定查询的条件。参数的值可以为常量。
    namefriendsappearsIn都是字段,代表查询的对象。字段可以二级查询,即查询该字段下的子字段。
    ...comparisonFields是片段,在后面声明了fragment。片段是一个可复用单元。
    @include(if: $withFriends)是一个指令。( @include(if: Boolean) 仅在参数为 true 时,包含此字段。@skip(if: Boolean)如果参数为 true,跳过此字段。)
    ...on Droid...on Human在整个查询中,我们查询的主题是hero(主角),而根据Query定义,hero返回的值由getHero函数和传入参数episode决定,该函数返回一个对象,对象的type可能是Human或者Droid。这部分语法就是根据查询返回对象的不同类型而输出不同的结果。

    进一步掌握

    进一步掌握就需要自己写例子啦,这个我后面再发布另外一篇文章,暂定编写一个简单的通讯录。

    相关文章

      网友评论

          本文标题:GraphQL查询语法

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