如何在 Ruby on Rails 中使用 GraphQL-JavaScript中文网-JavaScript教程资源分享门户

随着前端应用的复杂性增加，前后端分离的架构也越来越受到重视。而 GraphQL 作为一种新型的跨平台的数据查询语言，更是成为了前后端分离场景下的理想选择。在这篇文章中，我们将学习如何在 Ruby on Rails 中使用 GraphQL。

什么是 GraphQL?

GraphQL 是 Facebook 推出的一种 API 查询语言，它可以实现更加高效和灵活的数据查询。相比于传统的 RESTful 架构，GraphQL 具有以下优点：

客户端可以自由选择需要的数据，大大减少了网络传输的数据量；
前后端之间的 API 接口非常简单，GraphQL 的类型系统可以提供完善的文档；
GraphQL 支持多个并行查询，可以提高数据查询效率；
通过 GraphQL 的中间层，可以实现更加灵活和可扩展的数据接口。

安装和使用 GraphQL

在 Ruby on Rails 中，我们可以通过 graphql-ruby 这个库来实现 GraphQL 功能的支持。首先需要在 Gemfile 文件中加入以下代码：

gem 'graphql'

然后运行 bundle install 安装相应的依赖包。

在 app/graphql 目录中新建一个 schema.rb 文件，该文件的作用是定义 GraphQL 的类型和查询操作。

class MyAppSchema < GraphQL::Schema
  query(Types::QueryType)
  mutation(Types::MutationType)
end

在 Types 目录中定义数据类型：

// www.javascriptcn.com code example
module Types
  class QueryType < Types::BaseObject
    field :users, [UserType], null: false
    
    def users
      User.all
    end
  end
  
  class UserType < Types::BaseObject
    field :id, ID, null: false
    field :name, String, null: false
    field :email, String, null: false
    field :posts, [PostType], null: false
    
    def posts
      object.posts
    end
  end
  
  class PostType < Types::BaseObject
    field :id, ID, null: false
    field :title, String, null: false
    field :content, String, null: false
    field :user, UserType, null: false
    
    def user
      object.user
    end
  end
end

这里我们定义了三种类型：UserType、PostType 和 QueryType，分别对应用户、文章和查询操作。其中 UserType 和 PostType 用来描述数据的结构，而 QueryType 用来定义查询操作。需要注意的是，最终的 Schema 也基于这些类型进行组合。

在 app/controllers 目录中新建一个 graphql_controller.rb 文件，该文件的作用是处理客户端发来的 GraphQL 查询请求。

class GraphqlController < ApplicationController
  def query
    result = MyAppSchema.execute(params[:query])
    render json: result
  end
end

这里我们可以看到，execute 函数解析客户端发来的查询请求，并且调用 app/graphql/schema.rb 中定义的类型和操作进行处理，最终返回一个 JSON 格式的响应。

在 routes.rb 中，添加 GraphQL 的路由：

post '/graphql', to: 'graphql#query'

现在我们就可以向 http://localhost:3000/graphql 发生 GraphQL 查询请求了。

GraphQL 基本操作

客户端发起的 GraphQL 查询请求由多个字段组成，每个字段对应后端返回的一个特定的数据类型。以下是一些基本的查询操作：

// www.javascriptcn.com code example
query {
  users {
    id
    name
    posts {
      title
      content
    }
  }
}

mutation {
  createUser(name: "Alice", email: "alice@example.com") {
    id
    name
  }
}

这里我们可以看到，GraphQL 查询语句有两个基本的操作：

query：查询数据的操作（对应 Rails 中的 GET 方法）；
mutation：改变数据的操作（对应 Rails 中的 POST、PUT、DELETE 方法）。

在实际场景中，我们还需要用到各种参数和过滤条件，这里就不一一列举了。建议参考 GraphQL 官方文档或者 graphql-ruby 的官方文档进行深入学习。

结语

本文简单介绍了如何在 Ruby on Rails 环境下使用 GraphQL，并提供了一些示例代码进行演示。GraphQL 能够极大地提高前后端的接口效率，同时还可以提供可扩展性和灵活性。如果你想要在实际项目中使用 GraphQL，还需要更进一步的了解和实践。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/67d7cd6fa941bf7134df71d0

如何在 Ruby on Rails 中使用 GraphQL

什么是 GraphQL?

安装和使用 GraphQL

GraphQL 基本操作

结语

接着读