Apollo Kotlin 多风味构建中如何按需启用 GraphQL 代码生成

在 Android 多风味（Flavor）开发中，我们经常会遇到不同风味需要不同技术栈的场景。本文将以 Apollo Kotlin 为例，详细介绍如何在项目中实现仅针对特定风味启用 GraphQL 代码生成功能。

问题背景

假设我们有一个 Android 项目包含两种 API 连接方式：

• rest 风味：使用 Ktor 实现 REST API
• graphql 风味：使用 Apollo Kotlin 实现 GraphQL API

我们希望只在 graphql 风味中启用 Apollo 的代码生成功能，而在 rest 风味中完全跳过这一步骤，以避免不必要的构建时间和依赖。

解决方案

1. 基础配置

首先在模块级 build.gradle.kts 中进行基本配置：

plugins {
    alias(libs.plugins.apollo)
    // 其他插件...
}

flavorDimensions += "apiType"
productFlavors {
    create("rest") {
        dimension = "apiType"
    }
    create("graphql") {
        dimension = "apiType"
    }
}

// 仅对 graphql 风味添加运行时依赖
"graphqlImplementation"(libs.apollo.runtime)

2. 关键配置：按风味连接代码生成

Apollo Kotlin 提供了 outputDirConnection 配置项，允许我们将生成的代码连接到特定的源集：

apollo {
    service("service") {
        packageNamesFromFilePaths()
        srcDir("src/graphql/apollo")
        generateKotlinModels.set(true)
        
        outputDirConnection {
            connectToAndroidSourceSet("graphql")
        }
    }
}

原理分析

这种配置方式利用了 Gradle 的任务依赖机制：

1. 通过 connectToAndroidSourceSet("graphql") 将生成的代码显式关联到 graphql 风味
2. 构建系统会自动识别这种关联关系
3. 当构建 rest 风味时，Gradle 会跳过所有 Apollo 相关的代码生成任务
4. 只有当构建 graphql 风味时，才会执行完整的代码生成流程

进阶建议

1. 目录结构优化：建议将 GraphQL 相关文件（如 .graphql 查询文件和 schema.json）放在 src/graphql/apollo 目录下，保持清晰的代码结构

2. 依赖管理：使用版本目录（version catalogs）管理 Apollo 相关依赖，确保版本一致性

3. 构建性能：这种按风味连接的方式不仅能解决功能需求，还能显著提升 rest 风味的构建速度

常见问题

Q: 为什么不能直接条件化应用插件？ A: Gradle 插件应用是全局性的，无法在配置阶段根据风味条件化应用。我们的解决方案是在任务执行层面进行优化。

Q: 如果我有更多风味需要处理怎么办？ A: 同样的原理可以扩展到任意数量的风味，只需确保每个使用 Apollo 的风味都有对应的 connectToAndroidSourceSet 配置。

通过这种配置方式，我们实现了 Apollo Kotlin 在多风味项目中的精细化控制，既满足了不同风味的技术需求，又保持了构建系统的高效性。