Android Kotlin Compose函数自定义注解处理与动态调用问题

核心问题分析 #

• 你的@CustomComponent注解使用AnnotationRetention.SOURCE，编译后注解信息会被完全丢弃，注解处理器和反射都无法获取到它，这是首要问题。
• Compose函数编译后会被编译器重写，函数签名、内部结构都会发生变化，直接用反射调用会因为缺失隐式的Composable上下文参数（Composer、Int）而崩溃。
• 注解处理器未运行通常是项目配置遗漏，比如未开启kapt/annotationProcessor、未正确注册处理器。

解决方案步骤 #

1. 修改自定义注解的Retention策略 #

将注解Retention改为CLASS，确保编译后注解信息保留在字节码中，供注解处理器读取：

@Retention(AnnotationRetention.CLASS)
@Target(AnnotationTarget.FUNCTION)
annotation class CustomComponent

2. 实现注解处理器收集Composable函数 #

创建注解处理器类，继承AbstractProcessor，收集所有带@CustomComponent的Composable函数，生成注册表类保存这些函数的引用。

处理器核心代码示例

@SupportedAnnotationTypes("com.yourpackage.CustomComponent")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
class CustomComponentProcessor : AbstractProcessor() {

    override fun process(annotations: MutableSet<out TypeElement>?, roundEnv: RoundEnvironment?): Boolean {
        roundEnv ?: return false
        // 筛选带@CustomComponent的Composable函数
        val composableFunctions = roundEnv.getElementsAnnotatedWith(CustomComponent::class.java)
            .filterIsInstance<ExecutableElement>()
            .filter { it.getAnnotation(Composable::class.java) != null }

        if (composableFunctions.isEmpty()) return true

        // 生成注册表类代码
        val packageName = processingEnv.elementUtils.getPackageOf(composableFunctions.first()).toString()
        val className = "ComposableComponentRegistry"
        val sourceBuilder = StringBuilder()
            .append("package $packageName\n\n")
            .append("import androidx.compose.runtime.Composable\n")
            .append("import androidx.compose.runtime.ComposableFunction0\n\n")
            .append("object $className {\n")
            .append("    val allComponents: List<@Composable () -> Unit> = listOf(\n")

        composableFunctions.forEach { function ->
            val functionName = function.simpleName.toString()
            val enclosingClass = function.enclosingElement
            // 处理顶层函数与类内成员函数的引用格式
            val functionRef = if (enclosingClass is TypeElement) {
                "${enclosingClass.qualifiedName}::$functionName"
            } else {
                functionName
            }
            sourceBuilder.append("        ::$functionRef,\n")
        }

        sourceBuilder.append("    )\n")
            .append("}\n")

        // 写入生成的Java文件
        val fileObject = processingEnv.filer.createSourceFile("$packageName.$className")
        fileObject.openWriter().use { it.write(sourceBuilder.toString()) }

        return true
    }
}

3. 配置注解处理器到Android项目 #

在模块的build.gradle.kts（或build.gradle）中添加插件与依赖：

Kotlin项目（使用kapt）

plugins {
    id("com.android.application")
    id("org.jetbrains.kotlin.android")
    id("kotlin-kapt") // 必须添加此插件启用注解处理
}

dependencies {
    // 依赖注解处理器模块（如果处理器是单独模块）
    kapt(project(":your-processor-module"))
    // 若处理器在当前模块，可使用本地依赖
    // kapt compileOnly files("path/to/processor-classes.jar")
}

注册注解处理器

在src/main/resources/META-INF/services/javax.annotation.processing.Processor文件中添加处理器全类名：

com.yourpackage.CustomComponentProcessor

4. 实现getAllComposablesWithAnnotation函数 #

直接调用生成的注册表类获取目标函数列表：

@Composable
fun getAllComposablesWithAnnotation(annotationClass: Class<CustomComponent>): List<@Composable () -> Unit> {
    return ComposableComponentRegistry.allComponents
}

5. 验证调用逻辑 #

你的Components函数可保持原有逻辑，现在能正常获取并调用带注解的Composable函数：

@Composable
fun Components() {
    val components = remember { getAllComposablesWithAnnotation(CustomComponent::class.java) }
    LazyColumn {
        items(components) { composable ->
            composable.invoke()
        }
    }
}

注解处理器未运行的排查要点 #

• 确认已添加kotlin-kapt或annotationProcessor插件。
• 检查处理器依赖是否正确配置到dependencies中。
• 验证META-INF/services下的处理器注册文件是否存在，且全类名无误。
• 清理并重新编译项目（Build -> Clean Project -> Rebuild Project），避免缓存导致处理器不执行。

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