Я пытаюсь переименовать метод в интерфейсе Java и функцию в интерфейсе Kotlin во время сборки согласно переписыванию AST (абстрактного синтаксического дерева). Для этого вопроса мы игнорируем последствия, которые переименование метода / функции приносит для вызовов. Чтобы найти метод / функцию для переименования, я использую пользовательский процессор аннотаций и аннотаций. У меня это работает для интерфейса Java, следуя этим инструкциям.
Я создал новый проект с тремя модулями. Модуль приложения, модуль аннотации и модуль процессора аннотаций.
Модуль приложения представляет собой приложение для Android и содержит два отдельных файла интерфейса Java и Kotlin с одним аннотированным методом / функцией каждый.
RenameJava.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. Указывает, что процессор аннотаций не работал.
Когда вы посмотрите на classes.dex сгенерированного APK, вы увидите следующее:
Вы видите, что метод интерфейса Java был правильно переименован. Пока функции интерфейса Kotlin нет. Даже если это отображается в журнале.
Вы также заметите это предупреждение в журнале:
app: зависимости annotationProcessor не будут распознаваться как процессоры аннотаций kapt. Измените имя конфигурации на «kapt» для этих артефактов: «RenameTest: rename-processor: unspecified» и примените плагин kapt: «apply plugin:« kotlin-kapt »».
Итак, давайте сделаем то, что предлагает предупреждение. Добавьте apply plugin: 'kotlin-kapt' в приложение build.gradle и измените annotationProcessor на kapt. После синхронизации и перестройки вывод будет:
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. Вы думаете, успех? Глядя на classes.dex недавно сгенерированного APK, вы будете думать иначе, так как оба в их первоначальном виде:
Вопрос
Есть ли способ получить желаемый результат в конечном APK? Получив вывод, что и метод в интерфейсе Java, и функция в интерфейсе Kotlin переименованы.
Ссылка на пример проекта: https://github.com/peperzaken/kotlin-annotation-rename-test