Kotlin前端编译器插件：能否无需标注即可处理所有方法？

核心结论 #

可以实现。Kotlin前端编译器插件完全能够在不依赖注解标记的前提下，遍历并处理所有方法，核心是利用编译器前端的语法树（PSI）遍历能力和分析阶段的扩展点。

实现思路 #

前端插件的操作层面是Kotlin的语法PSI树，通过注册AnalysisHandlerExtension扩展点，在编译分析阶段获取所有源码文件，再通过PSI遍历器（KtVisitor）扫描所有方法节点，最后修改语法树实现代码插入。

代码示例 #

1. 实现分析阶段扩展 #

import com.intellij.openapi.project.Project
import org.jetbrains.kotlin.analyzer.AnalysisResult
import org.jetbrains.kotlin.descriptors.ModuleDescriptor
import org.jetbrains.kotlin.psi.KtFile
import org.jetbrains.kotlin.psi.KtFunction
import org.jetbrains.kotlin.psi.KtVisitorVoid
import org.jetbrains.kotlin.psi.KtPsiFactory
import org.jetbrains.kotlin.psi.KtBodyBlockExpression
import org.jetbrains.kotlin.resolve.BindingTrace
import org.jetbrains.kotlin.resolve.extensions.AnalysisHandlerExtension

class FunctionInstrumentationExtension : AnalysisHandlerExtension {
    override fun doAnalysis(
        project: Project,
        module: ModuleDescriptor,
        files: Collection<KtFile>,
        bindingTrace: BindingTrace,
        filesToAnalyze: Collection<KtFile>
    ): AnalysisResult {
        // 遍历所有待分析的源码文件
        filesToAnalyze.forEach { file ->
            file.accept(object : KtVisitorVoid() {
                override fun visitFunction(function: KtFunction) {
                    super.visitFunction(function)
                    // 跳过无函数体的抽象方法、接口方法等
                    val body = function.bodyBlockExpression ?: return
                    // 创建要插入的println语句PSI节点
                    val psiFactory = KtPsiFactory(project)
                    val logStatement = psiFactory.createExpressionStatement(
                        "println(\"Entered method: ${function.name}\")"
                    )
                    // 将语句插入到函数体的最开头
                    body.addBefore(logStatement, body.firstChild)
                }
            })
        }
        return AnalysisResult.success()
    }
}

2. 注册插件扩展 #

import com.intellij.openapi.project.Project
import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar
import org.jetbrains.kotlin.config.CompilerConfiguration
import org.jetbrains.kotlin.resolve.extensions.AnalysisHandlerExtension

class FrontendPluginRegistrar : CompilerPluginRegistrar() {
    override val supportsK2 = true // 适配K2编译器

    override fun ExtensionStorage.registerExtensions(project: Project, configuration: CompilerConfiguration) {
        // 注册分析阶段扩展
        AnalysisHandlerExtension.registerExtension(project, FunctionInstrumentationExtension())
    }
}

关键说明 #

• 无需注解触发：通过主动遍历所有KtFunction节点，不需要在源码中添加任何注解标记，完全符合“不修改原始源码”的需求。
• PSI层面操作：前端插件直接修改Kotlin的语法树节点，编译后这些修改会体现在最终的字节码中，和后端IR插件的效果类似，但操作阶段更早（语法分析阶段）。
• 灵活过滤：可以根据需求过滤特定方法，比如跳过抽象方法、系统类方法、特定注解标记的方法等，只处理目标方法。

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