如何使用Kotlin Symbol Processing(KSP)填充现有列表

核心认知纠正 #

你的判断是对的：KSP是编译期代码生成工具，仅在你本地构建打包的阶段运行，既不能修改你已有的手写源文件，也不可能实现你设想的「直接填充运行时列表」的效果——原因很简单：你创建类实例需要的Context是App在用户设备上运行时才存在的组件，编译阶段根本不存在合法的Context实例，更不可能把编译阶段创建的对象塞到最终运行的App内存里。这个方案从原理上就不成立。

你顾虑的「修改已有文件带来性能损耗」完全是多余的：KSP不会改动你手写的任何代码，正确的实现思路是编译期收集全所有被标记的类，生成无反射的实例注册代码，你只需要在App启动时调用一次生成的注册方法即可，运行时性能和你手写逐行添加实例完全一致，没有任何额外开销。

具体实现步骤 #

1. 调整聚合类的代码 #

你原来写的const val修饰可变列表的写法本身就无法编译，const仅能修饰编译期常量，调整成对外暴露不可变视图、对内支持添加实例的实现：

object MyListAgregator {
    private val _classList = mutableListOf<SomeBaseClass>()
    val classList: List<SomeBaseClass> = _classList

    fun register(instance: SomeBaseClass) {
        _classList.add(instance)
    }
}

2. 在KSP处理器中生成注册代码 #

你已经实现了被注解类的收集逻辑，接下来只需要在处理流程里生成一个独立的初始化文件即可，不需要修改任何已有文件：

• 遍历收集到的类符号时，先校验类是否为SomeBaseClass的子类、主构造函数是否存在唯一的Context类型参数，不符合要求直接抛编译期错误，提前把问题拦在编译阶段
• 按固定模板生成初始化代码，举个最终生成的代码示例：

// 这个文件完全由KSP自动生成，存放在build目录下，不会污染你的手写代码
package com.yourapp.autogen

import android.content.Context
import com.yourapp.MyListAgregator
import com.yourapp.business.ClassA
import com.yourapp.business.ClassB

object MyListAutoRegistry {
    fun registerAll(context: Context) {
        // 下面的注册行由KSP遍历类时逐行生成，有多少个被标记类就生成多少行
        MyListAgregator.register(ClassA(context))
        MyListAgregator.register(ClassB(context))
    }
}

KSP生成代码时用CodeGenerator创建新文件即可，不要尝试去读取修改你手写的MyListAgregator.kt，既不符合KSP的设计，也会带来增量编译失效的问题。

3. 启动时触发注册 #

在应用启动的合适时机（比如Application.onCreate）调用一次生成的注册方法即可：

class MyApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        MyListAutoRegistry.registerAll(this)
        // 执行完后MyListAgregator.classList就包含了所有被注解标记的类实例
    }
}

方案优势 #

• 零反射：所有实例都是直接调用构造函数创建，没有运行时扫描、反射的耗时，性能和手写代码完全一致
• 编译期安全：类不符合构造要求、继承关系错误都会直接在编译阶段报错，不会留到运行时崩溃
• 增量编译友好：KSP可以按文件变更增量生成代码，不会拖慢编译速度
• 无侵入：所有自动生成的逻辑都在独立的生成文件中，不需要改动业务手写代码

不要采用运行时扫描类路径、反射查找注解类的实现，这类方案才会带来明显的启动耗时，还会受混淆、系统隐藏API限制影响，稳定性极差。

内容的提问来源于stack exchange，提问作者Shadow