使用 TreeTranslator 重命名不适用于 Kotlin 的函数

android java abstract-syntax-tree kotlin gradle

2022-09-03 08:06:04

我正在尝试根据AST（抽象语法树）重写在构建期间重命名Java接口中的方法和Kotlin接口中的函数。对于这个问题，我们忽略了重命名方法/函数对调用的影响。为了找到重命名的方法/函数，我正在使用自定义注释和注释处理器。我按照这些说明让它适用于Java接口。

我创建了一个包含三个模块的新项目。应用模块、注释模块和注释处理器模块。

该应用程序模块是一个Android应用程序，包含两个单独的Java和Kotlin接口文件，每个文件都有一个带注释的方法/函数。

重命名Java.java

package nl.peperzaken.renametest;

import nl.peperzaken.renameannotation.Rename;

public interface RenameJava {
    @Rename
    void methodToRename();
}

RenameKotlin.kt

package nl.peperzaken.renametest

import nl.peperzaken.renameannotation.Rename

interface RenameKotlin {
    @Rename
    fun functionToRename()
}

注释模块是一个Java库，它只包含注释，我们指定只允许在函数上使用它，我们说它可能只在源代码中可见。@Rename

Rename.kt

package nl.peperzaken.renameannotation

@Target(AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.SOURCE)
annotation class Rename

注释处理器模块是一个 Java 库，它仅包含迭代具有注释的元素并对其执行转换的处理器。

RenameProcessor.kt

package nl.peperzaken.renameprocessor

import com.google.auto.service.AutoService
import com.sun.source.util.Trees
import com.sun.tools.javac.processing.JavacProcessingEnvironment
import com.sun.tools.javac.tree.JCTree
import com.sun.tools.javac.tree.TreeTranslator
import com.sun.tools.javac.util.Names
import nl.peperzaken.renameannotation.Rename
import javax.annotation.processing.*
import javax.lang.model.SourceVersion
import javax.lang.model.element.TypeElement
import javax.tools.Diagnostic

@AutoService(Processor::class)
@SupportedSourceVersion(SourceVersion.RELEASE_8)
@SupportedAnnotationTypes("nl.peperzaken.renameannotation.Rename")
class RenameProcessor : AbstractProcessor() {

    private lateinit var trees: Trees
    private lateinit var names: Names

    private val visitor = object : TreeTranslator() {
        override fun visitMethodDef(jcMethodDecl: JCTree.JCMethodDecl) {
            super.visitMethodDef(jcMethodDecl)

            // print original declaration
            processingEnv.messager.printMessage(
                Diagnostic.Kind.NOTE,
                jcMethodDecl.toString()
            )

            // Rename declaration
            jcMethodDecl.name = names.fromString("renamed")

            // print renamed declaration
            processingEnv.messager.printMessage(
                Diagnostic.Kind.NOTE,
                jcMethodDecl.toString()
            )

            // commit changes
            result = jcMethodDecl
        }
    }

    @Synchronized
    override fun init(processingEnvironment: ProcessingEnvironment) {
        super.init(processingEnvironment)
        trees = Trees.instance(processingEnvironment)
        val context = (processingEnvironment as JavacProcessingEnvironment).context
        names = Names.instance(context)
    }

    override fun process(set: Set<TypeElement>, roundEnvironment: RoundEnvironment): Boolean {
        // Find elements that are annotated with @Rename
        for (element in roundEnvironment.getElementsAnnotatedWith(Rename::class.java)) {
            val tree = trees.getTree(element) as JCTree
            tree.accept(visitor)
        }
        return true
    }
}

Gradle 文件

我在注释处理器中添加了以下内容：build.gradle

// Add annotation dependency
implementation project(':rename-annotation')
// Used to generate META-INF so the processor can run
compile 'com.google.auto.service:auto-service:1.0-rc4'
kapt "com.google.auto.service:auto-service:1.0-rc4"
// To prevent unresolved references during building. You might not need this dependency.
implementation files("${System.getProperty('java.home')}/../lib/tools.jar")

我在应用程序中添加了以下内容：build.gradle

compileOnly project(':rename-annotation')
annotationProcessor project(':rename-processor')

注释除了默认生成的依赖项外，没有其他依赖项。build.gradle

我们之所以有不同的模块，是因为我们可以防止注释和处理器被构建到最终的APK中，因为我们只需要在构建过程中使用它们。

输出

日志显示 Java 接口中的方法已重命名：

Note: 
  @Rename()
  void methodToRename();
Note: 
  @Rename()
  void renamed();

没有为 Kotlin 接口生成日志。指示注释处理器未运行。

当您查看生成的APK时，您将看到以下内容：classes.dex

您可以看到 Java 接口的方法已正确重命名。虽然 Kotlin 接口的功能没有。即使它显示在日志中。

您还将在日志中注意到此警告：

app：'annotationProcessor'依赖项不会被识别为 kapt 注释处理器。请将这些项目的配置名称更改为“kapt”：'RenameTest：rename-processor：unspecified'，然后应用kapt插件：“应用插件：'kotlin-kapt'”。

因此，让我们按照警告的建议去做。添加到应用程序并更改为。同步并重新生成后，输出为：apply plugin: 'kotlin-kapt'build.gradleannotationProcessorkapt

Note: 
  @Rename()
  void methodToRename();
Note: 
  @Rename()
  void renamed();
Note: 
  @nl.peperzaken.renameannotation.Rename()
  public abstract void functionToRename();
Note: 
  @nl.peperzaken.renameannotation.Rename()
  public abstract void renamed();

Java 和 Kotlin 文件的日志都出现了。你认为成功了吗？查看新生成的APK会让您不这么认为，因为两者都是原始形式：classes.dex