数据构建者（实验性）

⚠️ 数据构建者是实验性的，可能发生变化。如果您对它们有任何反馈，请通过GitHub问题或Kotlin Slack社区提出。

Apollo Kotlin 为您生成模型和解析器，以从您的网络响应中创建这些模型的实例。然而，在测试或其他场合，有时手动使用已知值实例化模型非常有用。这样做并不像看上去那么简单，尤其是当使用片段时。operationBased 模型需要实例化每个片段，以及为每个复合类型选择一个合适的 __typename。数据构建器通过提供与 Json 文档结构匹配的构建器，使这个过程变得更简单。

注意：Apollo Kotlin 的早期版本使用了测试构建器。数据构建器是测试构建器的一个简化版本，同时与自定义标量也更兼容。如果您正在寻找测试构建器的文档，它仍然可以在这里找到。

启用数据构建器

要启用数据，将 generateDataBuilders 选项设置为 true：

build.gradle[.kts]

1
apollo {
2
  service("service") {
3
    // ...
4

5
    // Enable data builder generation
6
    generateDataBuilders.set(true)
7
  }
8
}

这将为您模式中的每个复合类型生成构建器，以及为您的每个操作生成一个辅助函数 Data {}。

示例用法

假设我们正在构建一个使用以下查询的模拟结果的测试：

1
query HeroForEpisode($ep: Episode!) {
2
  hero(episode: $ep) {
3
    firstName
4
    lastName
5
    age
6
    
7
    ship {
8
      model
9
      speed
10
    }
11

12
    friends {
13
      firstName
14
      lastName
15
    }
16

17
    ... on Droid {
18
      primaryFunction
19
    }
20

21
    ... on Human {
22
      height
23
    }
24
  }
25
}

以下是如何使用对应的模拟结果数据构建器：

1
@Test
2
fun test() {
3
  val data = HeroForEpisodeQuery.Data {
4
    // Set values for particular fields of the query
5
    hero = buildHuman {
6
      firstName = "John"
7
      age = 42
8
      friends = listOf(
9
        buildHuman {
10
          firstName = "Jane"
11
        }, 
12
        buildHuman {
13
          lastName = "Doe"
14
        }
15
      )
16
      ship = buildStarship {
17
        model = "X-Wing"
18
      }
19
    }
20
  }
21

22
  assertEquals("John", data.hero.firstName)
23
  assertEquals(42, data.hero.age)
24
}

在这个例子中，hero 字段是一个具有指定 firstName 和 age 值的 Human 对象。对于 lastName和 height，将自动填充模拟值。同样，飞船的速度、第一位朋友的姓氏和第二位朋友的名字的值也将自动填充。

您可以将上面的 buildHuman 替换为 buildDroid 来创建一个 Droid 对象。

别名

由于数据生成器是 schema-based，而别名在您的查询中定义，因此代码生成器无法生成针对这些字段的字段。相反，您需要显式指定它们。

给定如下查询：)

1
query GetHeroes {
2
  luke: hero(id: "1002") {
3
    name
4
  }
5
  leia: hero(id: "1003") {
6
    name
7
  }
8
}

您可以这样生成一个模拟数据模型

1
val data = GetHeroes.Data {
2
  this["luke"] = buildHumanHero {
3
    name = "Luke"
4
  }
5
  this["leia"] = buildHumanHero {
6
    name = "Leia"
7
  }
8
}

`@skip` 和 `@include` 指令

默认情况下，数据生成器与您的 schema 中的类型匹配。如果一个字段是非空白的，您将不得不提供一个值或将默认解析器提供的一个值。对于 @skip 和 @include 指令来说这是一个问题，因为即使在非空的情况下，字段也可能不存在。为了考虑这种情况，使用与别名相同的语法。

1
query Skip($skip: Boolean!) {
2
  nonNullableInt @skip(if: $skip)
3
}

您可以这样生成一个模拟数据模型

1
val data = SkipQuery.Data {
2
  this["nonNullableInt"] = Optional.Absent
3
}
4

5
assertNull(data.nonNullableInt)

配置默认字段值

为了将默认值分配给字段，数据生成器使用 FakeResolver 接口的某个实现。默认情况下，它们使用 DefaultFakeResolver 的一个实例。

DefaultFakeResolver 给每个 String 字段的默认值是该字段的名称，并在分配默认值给 Int 字段时递增计数器。它为其他类型定义了类似的行为。

您可以使用自己的 own FakeResolver 实现（可选地委托给 DefaultTestResolver 以获得先行优势）。然后，您可以将这个实现作为参数传递给 Data 函数，如下所示：

1
// A TestResolver implementation that assigns -1 to all Int fields
2
class MyFakeResolver : FakeResolver {
3
  private val delegate = DefaultFakeResolver(__Schema.all)
4
  
5
  override fun resolveLeaf(context: FakeResolverContext): Any {
6
    return when (context.mergedField.type.leafType().name) {
7
      "Int" -> -1 // Always use -1 for Ints
8
      else -> delegate.resolveLeaf(context) 
9
    }
10
  }
11

12
  override fun resolveListSize(context: FakeResolverContext): Int {
13
    // Delegate to the default behaviour
14
    return delegate.resolveListSize(context)
15
  }
16

17
  override fun resolveMaybeNull(context: FakeResolverContext): Boolean {
18
    // Never 
19
    return false
20
  }
21

22
  override fun resolveTypename(context: FakeResolverContext): String {
23
    // Delegate to the default behaviour
24
    return delegate.resolveTypename(context)
25
  }
26
}
27

28
@Test
29
fun test() {
30
  val data = HeroForEpisodeQuery.Data(resolver = myTestResolver) {
31
    hero = buildHuman {
32
      firstName = "John"
33
    }
34
  }
35

36
  // Unspecified Int field is -1
37
  assertEquals(-1, data.hero.age)
38
}

模拟 GraphQL 响应

UI 测试

数据构建者（实验性）

启用数据构建器

示例用法

别名

@skip 和 @include 指令

配置默认字段值

`@skip` 和 `@include` 指令