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查询的优化方案等。

推荐阅读更多精彩内容