GraphQL on Rails(三) 结合Rails的修改API

GraphQL on Rails(一) GraphQL介绍
GraphQL on Rails(二) 结合Rails的查询API

接着上一个写到的GraphQL在RailsAPI应用中的查询功能,这次我们来实现修改数据的功能,修改数据的操作在GraphQL中被称为 突变(mutation即修改数据),它在GraphQL schema中的定义是这样的。

QuerySchema =  GraphQL::Schema.new(mutation: TODO)

我们还是延续上一篇的例子,一个博客系统,其中包含三个模型:ArticleUserComment

突变

mutation在GraphQL中与其他元素一样也是一个类型的定义,那么既然是类型的定义,我们就可以将它存放在 types目录下面,:

MutationType = GraphQL::ObjectType.define do
  # TODO
end

然后就像上面提到的那样,我们需要在schema定义中指定需要加载的mutation

QuerySchema =  GraphQL::Schema.new(query: QueryType, mutation: MutationType)

接下来我们就编写 MutationType中的内容,定义一下具体可以操作的数据类型。既然构建的是博客系统那么系统是要提供,对文章的发布和修改,以及对文章记性评论,和违禁评论的删除功能。

MutationType = GraphQL::ObjectType.define do

  field :CreateArticle, field: ArticleMutations::Create
  
  field :UpdateArticle, field: ArticleMutations::Update 
  
  field :CreateComment, field: CommentMutations::Create

  field :DestroyComment, field: CommentMutations::Destroy

end

现在MutationType中就已经有了这四种操作的类型,可以看到上面的每一行定义中存在两个field关键字,这其中第一个field是我们定义的MutationType的字段名,后面的Symbol field才是正在的类型定义存在的地方,当然如果你愿意的话其实可以将它们直接写在 MutationType的定义当中的,但是因为程序复杂起来后,像上面的这种写法更容易模块化,所以使用这种写法。
我们将上面提到的四个mutations的文件存放在对应的./app/graph/mutations 中

├── app
│   ├── graph
│   │   ├── fields
│   │   ├── schemas
|   |   ├── mutations
│   │   └── types

**app/graph/mutations/article_mutations.rb **

module ArticleMutations

  Create = GraphQL::Field.define do
    type -> { ArticleType }
    description 'create a article'

    argument :title, !types.String

    argument :content, !types.String

    resolve -> (obj, input_fields, ctx)  do
      ctx[:current_user].articles.create(title: input_fields['title'], content: input_fields['content'])
    end

  end

  Update = GraphQL::Field.define do
    type -> { ArticleType }
    description 'update title of article'

    argument :id, types.ID

    argument :title, !types.String

    resolve -> (obj, input_fields, ctx)  do
      article = Article.find_by(id: input_fields['id'])
      article.update(title: input_fields['title'])
      article
    end
  end
end

**app/graph/mutations/comment_mutations.rb **

module CommentMutations
  Create = GraphQL::Field.define do
    type -> { CommentType }
    description 'create a comment of article'

    argument :article_id, types.ID

    argument :content, !types.String

    resolve -> (obj, input_fields, ctx)  do
      article = Article.find_by(id: input_fields['article_id'])
      article.comments.create(content: input_fields['content'], user: ctx[:current_user])
    end

  end

  Destroy = GraphQL::Field.define do
    type -> { types.Boolean }
    description 'delete a comment'

    argument :id, types.ID

    resolve -> (obj, input_fields, ctx)  do
      !!Comment.delete(input_fields['id'])
    end
  end
end

从上面的两段代码看到,mutation其实和query是基本一样的类型定义,首先由type指定修改数据后的返回值类型,argument定义可以传递的参数,resolve 方法的block参数是最后具体执行操作的代码。其中还有一个需要注意的就是 resolve 方法中的第三个参数,ctx (context) 它是用于存放controller中传递进来的上下文数据,我们这个博客系统的创建数据操作都需要用户信息所以,需要在controller中把当前用户传进来。

class QueriesController < ApplicationController
  def create
    result = ::QuerySchema.execute(params[:query], context: {current_user: current_user})
    render json: result
  end
end  

接下来,让我们来创建一个文章看看效果:


Paste_Image.png

文章被创建成功,并且返回了作者的ID以及,文章的ID和标题。

总结

通过上面的实例,我们可以看出GraphQL中不管是查询还是突变都保持着统一的类型系统的样子,其中有要注意的几点是:突变字段中的 resolve方法的返回值的类型要和声明的类型一致,还有就是多个突变操作在一个查询中是顺序执行的。
后面的话这一系列文章会写到GraphQL的其他高级功能在Rails中的应用,以及GraphQL查询的优化方案等。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容