Absinthe GraphQL 教程：构建第一个查询-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00238/article/details/148527242

Absinthe GraphQL 教程：构建第一个查询

absinthe The GraphQL toolkit for Elixir 项目地址: https://gitcode.com/gh_mirrors/ab/absinthe

前言

在现代Web开发中，GraphQL作为一种强大的API查询语言，因其灵活性和高效性而广受欢迎。Absinthe是Elixir生态中一个功能完善的GraphQL实现，本文将带你使用Absinthe构建第一个GraphQL查询。

理解GraphQL查询

假设我们正在开发一个博客系统，用户需要能够获取文章列表。在GraphQL中，这样的查询可能如下所示：

{
  posts {
    title
    body
  }
}

这个查询请求获取所有文章的标题和正文内容。接下来，我们需要在Absinthe中实现这个功能。

构建GraphQL类型系统

定义Post类型

GraphQL是强类型的，我们需要首先定义Post类型。在Absinthe中，我们使用object宏来定义对象类型：

defmodule BlogWeb.Schema.ContentTypes do
  use Absinthe.Schema.Notation

  object :post do
    field :id, :id
    field :title, :string
    field :body, :string
  end
end

这里有几个关键点需要注意：

:id类型是GraphQL规范定义的特殊标量类型，表示唯一标识符
:string是GraphQL内置的标量类型
Absinthe会自动将:post转换为规范的"Post"类型名称

类型系统设计原则

在设计GraphQL类型时，应遵循以下原则：

类型名称应具有描述性且唯一
字段命名应使用camelCase风格
每个字段都应明确其返回类型
可以为字段添加描述性文档（使用@desc属性）

构建Schema

定义查询入口

在GraphQL中，所有查询都从根Query类型开始。我们需要在Schema中定义posts字段：

defmodule BlogWeb.Schema do
  use Absinthe.Schema
  import_types BlogWeb.Schema.ContentTypes

  alias BlogWeb.Resolvers

  query do
    @desc "Get all posts"
    field :posts, list_of(:post) do
      resolve &Resolvers.Content.list_posts/3
    end
  end
end

这里的关键元素：

list_of(:post)表示返回一个Post类型的列表
resolve指定了处理该查询的解析函数
使用了Phoenix上下文命名约定保持代码组织清晰

实现解析器

解析器(Resolver)是GraphQL中处理实际业务逻辑的地方：

defmodule BlogWeb.Resolvers.Content do
  def list_posts(_parent, _args, _resolution) do
    {:ok, Blog.Content.list_posts()}
  end
end

解析器函数有三种可能的返回值：

{:ok, value} - 成功返回数据
{:error, reason} - 返回错误
:error - 简化的错误返回

配置路由

为了让我们的GraphQL API可通过HTTP访问，需要在Phoenix路由中配置：

scope "/api" do
  pipe_through :api

  forward "/graphiql", Absinthe.Plug.GraphiQL,
    schema: BlogWeb.Schema

  forward "/", Absinthe.Plug,
    schema: BlogWeb.Schema
end

这里我们配置了两个端点：