Apollo Kotlin 中实现 Schema 类型树摇优化的探索

在 Apollo Kotlin 这个 GraphQL 客户端库的使用过程中，开发者经常会遇到需要处理接口(interface)和联合类型(union)的场景。特别是在 Android 平台上，如何在不牺牲功能的前提下优化应用体积，成为了一个值得探讨的技术话题。

问题背景

当开发者使用 Apollo Kotlin 生成类型安全的 GraphQL 查询代码时，经常会配置 alwaysGenerateTypesMatching 选项来确保所有类型都被生成，即使某些类型在查询中没有显式引用。这种做法特别适用于需要通过 __typename 进行类型匹配的场景。

然而，当同时启用 generateSchema = true 时，生成的 __Schema.possibleTypes() 方法会保留所有可能的类型信息。由于这个方法在运行时操作，导致 R8 或 ProGuard 无法移除未使用的类型，从而增加了最终 APK 的体积。

技术挑战

核心问题在于如何平衡两个需求：

1. 保留运行时类型检查的能力
2. 允许构建工具移除未使用的代码

传统的 __Schema.possibleTypes() 实现方式将所有类型硬编码在方法中，这使得构建工具难以判断哪些类型是真正需要的。

解决方案探索

Apollo Kotlin 团队提出了几种可能的改进方向：

1. 按接口分组的方法：为每个接口或联合类型生成独立的 possibleTypes 方法，如 videoPossibleTypes()、gamePossibleTypes() 等。这样构建工具可以更精确地分析哪些方法被使用。

2. 字符串替代对象：返回类型名称字符串列表而非对象类型引用，减少对实际类型类的依赖。

3. 利用类型继承关系：通过检查类型的 implements 列表来判断其所属的接口，而不是维护一个可能的类型列表。

实际应用场景

在缓存键生成和类型分发处理中，开发者通常需要根据 __typename 判断对象的实际类型。例如：

// 缓存键生成示例
override fun cacheKeyForObject(obj: Map<String, Any?>, context: CacheKeyGeneratorContext): CacheKey? {
    val typename = obj["__typename"] as? String ?: return null
    val type = __Schema.object(typename)
    
    if (type.implements.any { it.name == "Video" }) {
        // 处理视频类型
    }
    // 其他类型处理...
}

// 类型分发示例
fun getEntityId(entity: Entity): String {
    val typename = entity.unifiedEntity?.__typename ?: return ""
    val superTypes = __Schema.object(typename).implements.map { it.name }.toSet()
    
    return when {
        superTypes.contains("Video") -> entity.unifiedEntity?.onVideo?.videoSummary?.videoId?.toString().orEmpty()
        superTypes.contains("Game") -> entity.unifiedEntity?.onGame?.gameSummary?.gameId?.toString().orEmpty()
        else -> ""
    }
}

树摇优化考量

真正的挑战在于如何让构建工具能够移除未使用的类型。即使采用了按接口分组的方法，只要类型被引用，构建工具可能仍然会保留它们。使用字符串表示类型名称可以部分缓解这个问题，因为字符串常量比类引用更容易被优化。

最佳实践建议

1. 优先使用类型继承信息：相比维护可能的类型列表，检查类型的 implements 关系更加灵活和精确。

2. 谨慎使用全局类型查询：避免在性能关键路径上频繁查询完整类型信息。

3. 考虑混合方案：对于明确知道所有可能类型的场景，可以使用预定义的字符串列表；对于需要灵活性的场景，使用运行时类型检查。

4. 测试构建结果：始终检查最终 APK 或 bundle 的内容，确认未使用的类型确实被移除。

结论

Apollo Kotlin 的类型系统提供了多种处理接口和联合类型的方式。在追求应用体积优化的同时，开发者需要根据具体场景选择最适合的方法。通过合理利用类型继承关系和构建工具的能力，可以在保持功能完整性的同时实现有效的代码优化。