模拟 HTTP 响应（实验性）

ℹ️ MockServer 仍然是实验性的，大部分 API 都是针对 Kotlin 设计的。MockServer 是跨平台的，但如果您只使用 Java，我们推荐使用 OkHttp MockWebServer，这将提供惯用的 Java API。

MockServer 实现了一个 HTTP 服务器，您可以使用它来模拟响应。它对于测试特定的服务器行为非常有用，例如错误情况、HTTP 头和超时。使用它需要最小化对生产代码的修改，因为您只需要更改您的 serverUrl。

另请参阅 TestNetworkTransport，它处理在 GraphQL 级别而不是 HTTP 级别进行模拟。

将依赖项添加到项目的 build.gradle 文件中：

build.gradle[.kts]

1
dependencies {
2
  testImplementation("com.apollographql.apollo3:apollo-mockserver:3.8.5")
3
}

以下是如何使用它的方法

1
// Create a mock server
2
val mockServer = MockServer()
3

4
// Provide its URL to your ApolloClient
5
val apolloClient = ApolloClient.Builder().serverUrl(mockServer.url()).store(store).build()
6

7
// Enqueue HTTP responses
8
mockServer.enqueue("""{"data": {"random": 42}}""")
9
mockServer.enqueue(
10
    MockResponse(
11
        body = "Internal server error",
12
        statusCode = 500,
13
        headers = mapOf("X-Test" to "true"),
14
        // Optionally pass a delay to simulate network latency
15
        delayMillis = 1000L,
16
    )
17
)
18

19
// Execute queries
20
val response1 = apolloClient
21
    .query(GetRandomQuery())
22
    .execute()
23

24
val response2 = apolloClient
25
    .query(GetRandomQuery())
26
    .execute()
27

28
// Don't forget to stop the server when you're done
29
mockServer.stop()

默认情况下，enqueue函数通常接受一个MockResponse作为参数，但也支持简写版本，该版本接受一个String（上面都显示了）。

高级用法

默认情况下，MockServer配置了QueueMockServerHandler，它以队列中顺序返回响应。如果你需要更多控制返回响应，可以实现自己的MockServerHandler并将其传递给MockServer：

1
val customHandler = object : MockServerHandler {
2
  override fun handle(request: MockRequest): MockResponse {
3
    return if (/* Your custom logic here */) {
4
      MockResponse(
5
          body = """{"data": {"random": 42}}""",
6
          headers = mapOf("X-Test" to "true"),
7
      )
8
    } else {
9
      MockResponse(
10
          body = "Internal server error",
11
          statusCode = 500,
12
      )
13
    }
14
  }
15
}
16

17
val mockServer = MockServer(customHandler)

注意，如果你使用自定义的MockServerHandler，则无法调用MockServer.enqueue()，因为它期望处理程序是QueueMockServerHandler。

概览

模拟GraphQL响应