Absinthe GraphQL 教程：深入理解查询参数的使用-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00359/article/details/148527352

Absinthe GraphQL 教程：深入理解查询参数的使用

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

引言

在现代API设计中，过滤和精确查询数据是核心需求。Absinthe作为Elixir生态中强大的GraphQL实现，提供了灵活而强大的参数处理机制。本文将深入探讨如何在Absinthe中定义和使用查询参数，帮助开发者构建更加动态和实用的GraphQL API。

基础查询参数

让我们从一个基本场景开始：通过用户ID查询特定用户及其发布的文章。对应的GraphQL查询可能如下：

{
  user(id: "1") {
    name
    posts {
      id
      title
    }
  }
}

这个查询在user字段后使用了id参数。要在Absinthe中实现这个功能，我们需要在schema中定义相应的类型和解析器。

类型定义

首先定义用户类型和它与文章类型的关系：

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

  @desc "博客用户"
  object :user do
    field :id, :id
    field :name, :string
    field :email, :string
    field :posts, list_of(:post)  # 与文章的一对多关系
  end
end

同时，我们需要在文章类型中添加作者字段，形成双向关联：

object :post do
  # 其他字段...
  field :author, :user  # 反向关联到用户
end

查询字段与参数定义

在根查询类型中添加user字段，并定义必需的id参数：

query do
  @desc "获取博客用户"
  field :user, :user do
    arg :id, non_null(:id)  # 非空ID参数
    resolve &Resolvers.Accounts.find_user/3
  end
end

non_null修饰符确保该参数必须提供，否则Absinthe会在执行前返回错误，而不会调用解析器。

解析器实现

解析器负责处理参数并返回相应数据：

defmodule BlogWeb.Resolvers.Accounts do
  def find_user(_parent, %{id: id}, _resolution) do
    case Blog.Accounts.find_user(id) do
      nil -> {:error, "找不到ID为#{id}的用户"}
      user -> {:ok, user}
    end
  end
end

这里我们处理了用户不存在的场景，返回错误信息。根据业务需求，也可以选择返回{:ok, nil}。

非根字段的参数

更复杂的场景是在嵌套字段中使用参数。例如，查询用户在某天发布的文章：

{
  user(id: "1") {
    name
    posts(date: "2017-01-01") {
      title
      body
      publishedAt
    }
  }
}

首先为文章添加发布时间字段（使用Absinthe内置的:naive_datetime类型）：

field :published_at, :naive_datetime

然后在用户类型的posts字段中添加可选日期参数：

field :posts, list_of(:post) do
  arg :date, :date  # 可选日期参数
  resolve &Resolvers.Content.list_posts/3
end

解析器需要处理两种场景：有父用户和无父用户：

def list_posts(%Blog.Accounts.User{} = author, args, _resolution) do
  {:ok, Blog.Content.list_posts(author, args)}
end

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