Apollo Kotlin 代码生成优化实践

在服务端开发中，GraphQL 客户端代码生成是一个常见需求。Apollo Kotlin 作为一款优秀的 GraphQL 客户端库，提供了强大的代码生成能力。但在实际使用中，开发者可能会遇到一些代码风格和命名规范的问题。

代码生成现状分析

在 Kotlin 服务端，我们通常会定义如下的数据模型：

data class Category(
    @BsonId
    @BsonRepresentation(BsonType.OBJECT_ID)
    override val id: String = newObjectIdString,
    val code: String,
    val name: String,
    val description: String,
    val tagging: Set<String> = emptySet(),
    override val createdAt: LocalDateTime = LocalDateTime.now(),
    override val updatedAt: LocalDateTime? = null,
    override val isActive: Boolean = true,
    override val isDeleted: Boolean = false
) : Entity

而 Apollo Kotlin 生成的代码则可能如下：

public data class Data(
    public val getCategories: List<GetCategory>
) : Query.Data

public data class GetCategory(
    public val id: String,
    public val code: String,
    public val name: String,
    public val description: String,
    public val tagging: List<String>,
    public val createdAt: Any,
    public val updatedAt: Any?,
    public val isActive: Boolean,
    public val isDeleted: Boolean
)

这里存在两个主要问题：

1. 不必要的 public 修饰符：Kotlin 中默认就是 public 可见性
2. 命名不够直观：生成的类名 GetCategory 而非直接使用 Category

解决方案探讨

1. 处理 public 修饰符问题

Apollo Kotlin 使用 KotlinPoet 库生成代码，而 KotlinPoet 默认会添加 public 修饰符。虽然这在技术上没有错误，但不符合 Kotlin 的简洁风格。

解决方案是使用 Apollo Compiler Plugin 的 kotlinOutputTransform 功能，可以在代码生成后移除这些多余的修饰符。

2. 优化类名生成

类名生成问题源于 GraphQL 查询的设计。如果 schema 定义如下：

type Query {
  getCategories: [Category]
}

Apollo Kotlin 会基于字段名 getCategories 生成类名 GetCategory。更合理的做法是修改 schema 设计：

type Query {
  categories: [Category]
}

这样生成的代码会更简洁，直接使用 Category 作为类名。

深入理解命名机制

Apollo Kotlin 基于字段名而非类型名生成类名有其合理性。考虑以下情况：

type Query {
  homeAddress: Address
  workAddress: Address
}

如果都使用 Address 作为类名，会导致命名冲突。因此基于字段名生成类名（如 HomeAddress 和 WorkAddress）是必要的设计选择。

最佳实践建议

1. 优化 GraphQL schema 设计：使用简洁的字段名（如 categories 而非 getCategories）
2. 利用编译器插件：通过自定义插件调整生成的代码风格
3. 类型映射：对于日期等特殊类型，可以配置自定义标量类型映射
4. 集合类型处理：Kotlin 中更习惯使用 Set 而非 List，可以通过插件转换

通过这些优化，可以使生成的代码更符合 Kotlin 习惯，提高代码的可读性和维护性。