在Apollo Kotlin中使用GraphQL变量

GraphQL支持将参数值传递给您的操作与变量. 这使得您可以编写单个查询，您可以使用多个变量值进行重用（这是推荐的最佳实践）。

在 GraphQL 中，非空变量是必须的，而空变量始终是可选的。Apollo Kotlin使用它自己的 Optional 类型来区分存在（但可能为空）和不存在类型。

考虑以下具有两个空变量 GraphQL 查询：

1
query GetTodos($first: Int, $offset: Int) {
2
  todos(first: $first, offset: $offset) {
3
    id
4
    text
5
  }
6
}

Apollo Kotlin 为此查询生成以下 Kotlin 代码：

1
class GetTodosQuery(
2
    val first: Optional<Int?> = Optional.Absent,
3
    val offset: Optional<Int?> = Optional.Absent
4
)

您可以有选择地提供或省略如下所示的变量值：

1
// Omit values for both variables
2
val query = GetTodosQuery(Optional.Absent, Optional.Absent)
3
// Provide null for both variables
4
val query = GetTodosQuery(Optional.Present(null), Optional.Present(null))
5
// Send explicit values for both variables
6
val query = GetTodosQuery(Optional.Present(100), Optional.Present(0))

使用输入构建器

对于操作和输入对象，需要将值包裹在Optional包装器可能会很麻烦。

在这种情况下，请使用generateInputBuilders:

1
apollo {
2
  service("service") {
3
    // ...
4
    generateInputBuilders.set(true)
5
  }
6
}

如果你这样做，在上面的GetTodos 查询的情况下，Apollo Kotlin现在为每个操作生成一个Builder:

1
// Omit values for both variables
2
val query = GetTodosQuery.Builder()
3
               .build()
4
// Provide null for both variables
5
val query = GetTodosQuery.Builder()
6
               .first(null)
7
               .offset(null)
8
               .build()
9
// Send explicit values for both variables
10
val query = GetTodosQuery.Builder()
11
               .first(100)
12
               .offset(0)
13
               .build()

错误处理