Apollo Kotlin 中的片段

ⓘ 注意

本文描述了在 Apollo Kotlin 中使用默认的片段时的行为operationBased代码生成器在 Apollo Kotlin 中的使用。对于responseBased代码生成器，请参阅此页面。

Apollo Kotlin 支持GraphQL 片段两种形式：

命名片段，允许您在多个操作中重用一组字段。
内联片段，允许您访问多态类型的字段。

命名片段

以下是一些GraphQL定义的例子：

Launch.graphql

1
# Declaration of named fragment
2
fragment LaunchFragment on Launch {
3
  id
4
  site
5
  mission {
6
    name
7
  }
8
}
9

10
query LaunchDetails($id:ID!) {
11
  launch(id: $id) {
12
    # Usage of named fragment
13
    ...LaunchFragment
14
  }
15
}

根据 fragment 定义，Apollo Kotlin 生成以下 LaunchFragment 类，您可以在不同的查询中重复使用：

LaunchFragment.kt

1
data class LaunchFragment(
2
  val id: String,
3
  val site: String?,
4
  val mission: Mission?
5
)

使用此 fragment 的操作所生成的 operations 模型有一个 .launchFragment 属性来访问 fragment 的字段：

1
println("Mission site: ${launch.launchFragment?.site}")

如果返回的对象不是不是一个 Launch，.launchFragment 属性将是 null。

您可以在任何数量的操作中重复使用 fragment：

Launch.graphql

1
# ...previous definitions...
2

3
query LaunchList {
4
  launches {
5
    launches {
6
      ...LaunchFragment
7
    }
8
  }
9
}

您甚至可以在定义于不同 .graphql 文件的操作中使用 fragment。这是由于 Apollo Kotlin codegen 在生成模型之前将所有 .graphql 文件合并到一个单个文件中。

内联 fragments

看看这个使用两个内联 query 定义的示例：

HeroForEpisode.graphql

1
query HeroForEpisode($ep: Episode!) {
2
  hero(episode: $ep) {
3
    name
4
    ... on Droid {
5
      primaryFunction
6
    }
7
    ... on Human {
8
      height
9
    }
10
  }
11
}

对于这个 operation，Apollo Kotlin 生成一个 Hero 类，该类包含 OnDroid 和 OnHuman 内嵌类。 Hero 还包括 onDroid 和 onHuman 字段，使您能够访问特定于 Droid 和 Human 的字段：

1
println("Droid primaryFunction: ${hero.onDroid?.primaryFunction}")
2
println("Human height: ${hero.onHuman?.height}")

这些 on<ShapeName> 字段（onDroid 和 onHuman）若返回的对象不是对应类型时将 null。

自定义标量

@defer 支持