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文件合并到一个单个文件中。

内联片段

请查看这个使用两个内联query定义的片段：

HeroQuery.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
}

对于此操作，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 支持（实验性）