Apollo Kotlin 中自定义 GraphQL 请求扩展的实现方案

在 GraphQL 请求中，有时我们需要在请求体中添加自定义的扩展字段（extensions），用于传递额外的元数据或签名信息。本文将详细介绍在 Apollo Kotlin 客户端中实现这一需求的完整方案。

背景需求

Apollo Kotlin 是一个强大的 GraphQL 客户端库，默认情况下它会自动构建 HTTP 请求体，包含 query、operationName 和 variables 等标准字段。但在某些场景下，开发者需要在请求体中添加额外的扩展信息：

1. 查询签名验证
2. 传递额外的元数据
3. 实现自定义的持久化查询机制

解决方案演进

初始方案的限制

最初，开发者尝试使用 ByteStringHttpBody 直接构建请求体，但遇到了以下限制：

1. 无法复用 Apollo 内部的变量序列化逻辑
2. FileUploadAwareJsonWriter 是内部类，无法直接使用

官方改进方案

Apollo Kotlin 团队在 3.8.2 版本后提供了更优雅的解决方案，通过扩展 buildPostBody 方法支持自定义扩展字段：

val request = HttpRequest.Builder(HttpMethod.Post, serverUrl)
    .body(
        DefaultHttpRequestComposer.buildPostBody(
            operation = operation,
            customScalarAdapters = customScalarAdapters,
            query = operation.document()
        ) {
            name("extensions")
            writeObject {
                name("signature")
                value("your_signature_here")
            }
        }
    )
    .build()

这个方案有以下优势：

1. 完全复用 Apollo 内部的序列化逻辑
2. 支持文件上传等高级功能
3. 保持与未来版本的兼容性

完整实现示例

下面是一个完整的自定义 HttpRequestComposer 实现示例：

class CustomHttpRequestComposer(
    private val serverUrl: String,
) : HttpRequestComposer {

    override fun <D : Operation.Data> compose(apolloRequest: ApolloRequest<D>): HttpRequest {
        val operation = apolloRequest.operation
        val customScalarAdapters = apolloRequest.executionContext[CustomScalarAdapters] 
            ?: CustomScalarAdapters.Empty

        return HttpRequest.Builder(
            method = HttpMethod.Post,
            url = serverUrl,
        ).body(
            DefaultHttpRequestComposer.buildPostBody(
                operation = operation,
                customScalarAdapters = customScalarAdapters,
                query = operation.document()
            ) {
                name("extensions")
                writeObject {
                    name("customField")
                    value("customValue")
                }
            }
        ).build()
    }
}

最佳实践建议

1. 复用现有逻辑：尽可能使用 Apollo 提供的构建方法，而不是完全重写
2. 考虑兼容性：注意检查使用的 Apollo 版本，确保 API 可用性
3. 性能考量：对于高频请求，可以考虑缓存序列化结果
4. 错误处理：添加适当的异常捕获和处理逻辑

总结

通过 Apollo Kotlin 提供的扩展点，开发者可以灵活地在 GraphQL 请求中添加自定义扩展字段，同时保持与库核心功能的完整集成。这种方案既满足了定制化需求，又确保了代码的健壮性和可维护性。

对于更复杂的场景，如需要完全控制请求头的构建，开发者可以进一步扩展 HttpRequest.Builder 的功能，但需要注意遵循 GraphQL 规范和服务端的兼容性要求。