Apollo Kotlin 代码生成器中的访问修饰符冲突问题解析

问题背景

在 Apollo Kotlin 4.0.1 版本中，当同时启用 generateAsInternal 和 sealedClassesForEnumsMatching 配置时，会导致生成的代码出现访问修饰符冲突问题。这个问题特别影响了枚举类型的 UNKNOWN__ 常量的生成逻辑。

问题现象

开发者在使用 Apollo Kotlin 的代码生成功能时，配置了以下选项：

apollo {
    service("myService") {
        generateAsInternal = true
        sealedClassesForEnumsMatching.set(setOf(".*"))
    }
}

这种配置组合会导致生成的 UNKNOWN__ 常量类同时具有 private 和 internal 两个访问修饰符：

private internal class UNKNOWN__MyModelClass(...)

这种语法在 Kotlin 中是非法的，因为 Kotlin 不允许同时使用多个可见性修饰符。正确的做法应该是只使用其中一个修饰符。

技术原理

这个问题涉及到 Apollo Kotlin 代码生成器的两个重要特性：

1. generateAsInternal：这个选项控制生成的类是否应该具有 internal 可见性。当设置为 true 时，生成的类将仅限于模块内部可见。

2. sealedClassesForEnumsMatching：这个选项允许开发者将匹配特定模式的 GraphQL 枚举类型生成为 Kotlin 的密封类，而不是普通的枚举类。这对于需要处理未知值（UNKNOWN__）的情况特别有用。

问题的根源在于代码生成器在处理这两个选项时没有正确协调它们的可见性修饰符逻辑，导致生成了非法的修饰符组合。

解决方案

Apollo Kotlin 团队已经修复了这个问题，修复方案包含在 PR #6213 中。该修复确保：

1. 当 generateAsInternal 和 sealedClassesForEnumsMatching 同时启用时，生成的 UNKNOWN__ 类只会有一个适当的可见性修饰符。

2. 保持了原有功能的同时，确保了生成的代码符合 Kotlin 语法规范。

这个修复已经包含在 Apollo Kotlin 4.1.0 版本中发布。对于需要立即使用修复的用户，可以使用项目的快照版本进行测试。

最佳实践建议

对于需要使用这两个功能的开发者，建议：

1. 升级到 Apollo Kotlin 4.1.0 或更高版本，以避免这个问题。

2. 如果暂时无法升级，可以暂时禁用 generateAsInternal 选项，这样生成的代码将只保留 private 修饰符，不会出现语法错误。

3. 在配置 sealedClassesForEnumsMatching 时，考虑更精确的模式匹配，而不是简单地使用 ".*"，这样可以更精确地控制哪些枚举应该被生成为密封类。

总结

这个问题展示了代码生成工具在处理多个配置选项时可能出现的边缘情况。Apollo Kotlin 团队及时响应并修复了这个问题，体现了开源项目对代码质量的重视。对于开发者来说，及时更新依赖版本是避免这类问题的最佳实践。