编写graphql服务

graphql用一种高效清晰的规范来替代目前正流行的RESTful架构。通过灵活的结构化查询语言让查询更高效,静态类型和规范提升前后端联调效率。作为一名前端我非常喜欢graphql,梦想有一天以前所有零散又没有文档的接口都被graphql所代替,这将极大提升我的开发效率和开发体验。等待不如自己动手,下面将介绍如何编写一个基于hackernews API的graphql服务。

在编写前先体验已经做好的graphql服务demo

这个graphql服务和hackernews官方API类似,提供了获取文章和用户信息的接口。 在开发graphql服务前你可能需要知道graphql提供了哪些能力,以及graphql定义了哪些规范,这些都可以在这里学习

graphql服务核心概念

  • 类型(type):type是最基础的因为graphql服务返回数据一定是定义好的类型的单个或者数组。类型就像面对对象编程里的class,返回数据是class的实例
  • 字段(filed):filed组成type,一个type由多个filed构成。filed就像面对对象编程里的class的一个属性。每个字段都有返回类型,返回类型是定义的type
  • 查询(query):通过query来暴露graphql服务所提供的所有读接口,query就是type它由filed组成
  • 变化(mutation):通过mutation来暴露graphql服务所提供的写接口,mutation就是type它由filed组成

graphql服务由type和filed构成,type和filed相互依赖

由于type由filed构成,编写graphql服务的核心工作就是编写filed,如何获取数据和处理写操作的逻辑全来自于filed。

接下来将使用golang开始编写。

所有查询的入口(query):
var RootQuery = graphql.NewObject(graphql.ObjectConfig{
    Name:        "RootQuery",
    Description: `hackernews's API`,
    Fields: graphql.Fields{
        "story": &graphql.Field{
            Type:        storyType,
            Description: `get story item by story.id`,
            Args: graphql.FieldConfigArgument{
                "id": &graphql.ArgumentConfig{
                    Type:        graphql.NewNonNull(graphql.Int),
                    Description: "item's unique id",
                },
            },
            Resolve: func(p graphql.ResolveParams) (interface{}, error) {
                if id, ok := p.Args["id"].(int); ok {
                    return model.GetStory(int32(id))
                }
                return nil, nil
            },
        },
        "topstories": &graphql.Field{
            Type:        graphql.NewList(storyType),
            Description: `Up to 500 top stories`,
            Resolve: func(p graphql.ResolveParams) (interface{}, error) {
                ids := []int32{}
                model.GetKV("topstories", &ids)
                return model.GetStories(ids), nil
            },
        },
    },
})

以上代码暴露出了2个查询接口(也是2个字段)

  • story字段通过id获取一个story,该字段返回类型是storyType
  • topstories获取500个热门的story,该字段返回类型是[storyType]

可以看到获取数据的逻辑都在Resolve函数里,由于篇幅有限model 里封装的如何去数据库获取数据的代码忽略了。

storyType的代码
var storyType = graphql.NewObject(graphql.ObjectConfig{
    Name: "Story",
    Description: `Stories, They're identified by their ids, which are unique integers.
    All items have some of the following properties.
    `,
    Fields: graphql.Fields{
        "id":      idField,
        "by":      byField,
        "time":    timeField,
        "deleted": deletedField,
        "dead":    deadField,
        "text":    textField,
        "score":   scoreField,

        "url":         urlField,
        "title":       titleField,
        "descendants": descendantsField,

        "doc": docField,
        "comments": &graphql.Field{
            Name:        "comments",
            Description: `this poll's comments`,
            Type:        graphql.NewList(commentType),
            Resolve: func(p graphql.ResolveParams) (interface{}, error) {
                poll := p.Source.(*model.Poll)
                return model.GetComments(poll.Kids), nil
            },
        },
    },
})

这段代码定义了要返回的storyType是什么样的以及storyType的每个字段的数据是怎么获取的。以storyTypecomments字段为例Resolve: func里告诉了如何去获取这篇文章的所有评论。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Jackson0714

WCF传输1-你是否使用过压缩或Json序列化?

1034
来自专栏决胜机器学习

设计模式专题(十五) ——组合模式

设计模式专题(十五)——组合模式 (原创内容,转载请注明来源,谢谢) 一、概述 组合模式(Composite)将对象组合成树形结构,以表示部分-整体的层次结构...

37411
来自专栏圣杰的专栏

DDD理论学习系列(6)-- 实体

1.引言 实体对应的英语单词为Entity。提到实体,你可能立马就想到了代码中定义的实体类。在使用一些ORM框架时,比如Entity Framework,实体作...

2068
来自专栏dotnet core相关

WCF入门 (14)

做了一份面试题,最后一题是数据库的,写个查询。要查出Score有两次及两次以上超过79的Name和他的最高得分,同时显示超过79分的次数。

702
来自专栏Java成神之路

java分层架构概念

1.JAVA中Action层, Service层 ,modle层 和 Dao层的功能区分?(下面所描述的service层就是biz)       首先这是现在...

784
来自专栏mukekeheart的iOS之旅

iOS学习——iOS 整体框架及类继承框架图

  整理自:IOS 整体框架类图值得收藏  一 整体框架 在iOS开发过程中,对iOS整体框架的了解和学习是必不可少的一个环节,今天我们就好好来了解一下iOS...

4117
来自专栏hbbliyong

依赖注入(IOC)二

上一章我们讲了构造注入与设值注入,这一篇我们主要讲接口注入与特性注入。 接口注入 接口注入是将抽象类型的入口以方法定义在一个接口中,如果客户类型需要获得这个...

3267
来自专栏点滴积累

使用C#将json字符串作为对象存入MongoDB

      今天刚好在工作中碰到一个小问题,并愉快的解决了,权当将其记录下来,供人查阅,首先声明本人是个忠实的微软技术爱好者,主要使用的也是.NET语言。下面进...

3097
来自专栏我就是马云飞

LiveDate和LifeRegistry的协同操作

前言 这个是Android Architecture Components(简称AAC)的第三篇,之前的两篇 文章分别介绍了Lifecycle和ViewMode...

1848
来自专栏技术墨客

Spring核心——设计模式与IoC 原

“Spring”——每一个Javaer开发者都绕不开的字眼,从21世纪第一个十年国内异常活跃的SSH框架,到现在以Spring Boot作为入口粘合了各种应用。...

561

扫码关注云+社区