Absinthe GraphQL 教程：处理复杂参数输入-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00285/article/details/148527239

Absinthe GraphQL 教程：处理复杂参数输入

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

引言

在现代 GraphQL API 开发中，处理复杂参数输入是一个常见需求。Absinthe 作为 Elixir 生态中强大的 GraphQL 工具包，提供了优雅的方式来处理这类场景。本文将深入探讨如何在 Absinthe 中定义和使用复杂参数，特别是输入对象(Input Object)和枚举(Enum)类型的应用。

为什么需要复杂参数

传统 REST API 通常使用扁平化的参数结构，这在处理复杂数据时显得力不从心。GraphQL 通过输入对象类型，允许我们将相关参数组织在一起，形成层次化的数据结构。

在我们的博客系统示例中，用户注册时需要提供联系方式，可能是邮箱或电话号码。这种"或"关系非常适合用复杂参数来表示。

定义枚举类型

首先我们需要定义联系方式类型的枚举：

enum :contact_type do
  value :phone, as: "phone"
  value :email, as: "email"
end

关键点说明：

enum 宏用于定义枚举类型
value 定义枚举的可能值
:as 选项指定内部表示形式（这里使用字符串而非原子）
GraphQL 文档中使用全大写形式（如 PHONE, EMAIL）

枚举类型会自动验证输入值，非法的枚举值会返回友好的错误信息。

创建输入对象

接下来定义联系方式输入对象：

input_object :contact_input do
  field :type, non_null(:contact_type)
  field :value, non_null(:string)
end

注意要点：

输入对象命名通常以 _input 结尾
使用 non_null 确保必填字段
输入对象只能包含标量或其他输入对象

构建用户创建 Mutation

将复杂参数集成到 Mutation 中：

mutation do
  @desc "Create a user"
  field :create_user, :user do
    arg :name, non_null(:string)
    arg :contact, non_null(:contact_input)
    arg :password, non_null(:string)
    
    resolve &Resolvers.Accounts.create_user/3
  end
end

这个设计允许客户端发送如下查询：

mutation CreateEmailUser {
  createUser(
    contact: { type: EMAIL, value: "foo@bar.com" }
    name: "Jane"
    password: "hunter1"
  ) {
    id
    contacts {
      type
      value
    }
  }
}

权限控制实现

在解析器中实现权限检查：

def create_user(_parent, args, %{context: %{current_user: %{admin: true}}}) do
  Blog.Accounts.create_user(args)
end

def create_user(_parent, _args, _resolution) do
  {:error, "Access denied"}
end

这里我们：