数据构建器

数据构建器当前正处于 Apollo Kotlin 的 experimental 阶段。如果您对它们有反馈，请通过 GitHub issue或Kotlin Slack 社区联系我们。

Apollo Kotlin 为您的操作生成模型和解析器，这些解析器可以从您的网络响应中创建这些模型的实例。但是，在某些情况下，例如在测试或其他场景中，手动使用已知值创建模型可能很有用。

这样做并不像看起来那么简单，尤其是当使用了片段时。operationBased 模型需要实例化每一个片段，并为每个复合类型选择一个合适的 __typename。

数据构建器通过提供与 Json 文档结构相匹配的构建器，使这一过程更为简便。

启用数据构建器

要启用数据构建器，将 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字段是一个具有指定值的Human对象（firstName和age）。lastName和height的值会自动使用模拟值填充。ship的速度、第一位朋友的姓氏和第二位朋友的名字的值也将自动填充。

您可以用buildHuman代替上面的buildDroid来创建一个Droid对象。

别名

由于数据构建器是基于架构的，并且别名是在您的查询中定义的，所以代码生成无法为它们生成构建器字段。相反，您需要明确指定它们。

给定一个Query，如下所示：

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`指令

默认情况下，数据构建器与您的架构中定义的类型匹配。如果字段是非空的，您必须提供值或让默认解析器提供值。这对于@skip和@include指令是一个问题，其中字段可能是非空的，甚至是可选的。为了处理这种情况，使用与别名相同的语法，并设置值为Optional.Absent。

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字段增加计数。它为其他类型定义了类似的默认行为。

您可以创建自己的自定义 FakeResolver实现（可以选择先委托给DefaultFakeResolver以获得快速入门）。然后，像这样将实现作为参数传递给Data函数：

1
// A FakeResolver 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 Int
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 = MyFakeResolver()) {
31
    hero = buildHuman {
32
      firstName = "John"
33
    }
34
  }
35

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

使用代码片段

由于片段片段可以定义在接口和联合体中，因此您需要明确您想要建模的具体类型。例如，如果您有一个Animal接口，请使用以下方式创建一个Lion片段数据：

1
val data = AnimalDetailsImpl.Data(Lion) {
2
  // you can access roar here
3
  roar = "Grrrrr"
4
}

有时，您可能想测试服务端上定义的未知于客户端的新类型。为了做到这一点，请使用抽象类型（Animal在此处）作为Data构造函数的第一参数。

在这些情况下，您需要显式指定返回的对象类型的__typename:

1
val data = AnimalDetailsImpl.Data(Animal) {
2
  // the client doesn't know about this type yet, and you need to specify it explicitly
3
  __typename = "Brontaroc"
4
  species = "alien"
5
}