如何在Kotlin数据类字段上列出（java）注释？

Question

我使用FireStore的基于Java的注释来标记字段，并使用将文档字段映射到Java类元素的方法：

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
public @interface PropertyName {
  String value();
}

我在Kotlin数据类的一个字段上使用它，它编译得很好：

data class MyDataClass(
    @PropertyName("z") val x: Int
)

public final data class MyDataClass public constructor(x: kotlin.Int) {
    @field:com.google.cloud.firestore.annotation.PropertyName public final val x: kotlin.Int /* compiled code */

    public final operator fun component1(): kotlin.Int { /* compiled code */ }
}

null

data class MyDataClass(
    @get:PropertyName("z") val x: Int
)

注释现在显示在Java类对象的生成getter中。这至少在实践中是可行的，但我很好奇为什么Kotlin让我将注释编译为针对字段的注释，但不允许我在运行时将其返回（除非我在kotlin-reflect API中遗漏了什么？）。

如果我改用这个基于Kotlin的注释：

@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.PROPERTY)
annotation class PropertyName(val value: String)

这样，注释就会在运行时显示在Kotlin字段上。这很奇怪，因为Java的ElementType.Field似乎并没有完全映射到Kotlin的AnnotationTarget.Field。

Log.d("@@@@@", "\n\nDump of $kclass")
val ctor = kclass.constructors.first()
Log.d("@@@@@", "Constructor parameters")
ctor.parameters.forEach { p ->
    Log.d("@@@@@", p.toString())
    Log.d("@@@@@", p.annotations.size.toString())
    p.annotations.forEach { a ->
        Log.d("@@@@@", "  " + a.annotationClass)
    }
}

Log.d("@@@@@", "kotlin functions")
kclass.functions.forEach { f ->
    Log.d("@@@@@", f.toString())
    if (f.annotations.isNotEmpty()) {
        Log.d("@@@@@", "*** " + f.annotations.toString())
    }
}

Log.d("@@@@@", "kotlin members")
kclass.members.forEach { f ->
    Log.d("@@@@@", f.toString())
    if (f.annotations.isNotEmpty()) {
        Log.d("@@@@@", "*** " + f.annotations.toString())
    }
}

Log.d("@@@@@", "kotlin declared functions")
kclass.declaredFunctions.forEach { f ->
    Log.d("@@@@@", f.toString())
    if (f.annotations.isNotEmpty()) {
        Log.d("@@@@@", "*** " + f.annotations.toString())
    }
}

val t = kclass.java
Log.d("@@@@@", "java constructors")
t.constructors.forEach { f ->
    Log.d("@@@@@", f.toString())
}

Log.d("@@@@@", "java methods")
t.methods.forEach { f ->
    Log.d("@@@@@", f.toString())
    if (f.annotations.isNotEmpty()) {
        Log.d("@@@@@", "*** " + f.annotations.toString())
    }
}

Log.d("@@@@@", "java fields")
t.fields.forEach { f ->
    Log.d("@@@@@", f.toString())
    if (f.annotations.isNotEmpty()) {
        Log.d("@@@@@", "*** " + f.annotations.toString())
    }
}

Answer 1

这里的问题是，我的期望（可能还有文档）没有让我准备好Kotlin编译器将如何处理各种类型的注释。我的假设是，Kotlin数据类属性上的字段目标注释目标将直接将注释应用于Kotlin合成属性。这种假设是不正确的。

Kotlin对合成属性的字段注释所做的是将字段注释向下推到生成的类文件中该属性的实际支持字段。这意味着对带注释的Kotlin属性的任何类型的反射都不会找到注释。您必须深入Java类对象才能找到它。

如果您想要注释Kotlin类属性，并通过KClass反射找到它，您必须使用属性类型注释，这是Kotlin独有的。这样，如果您在KClass的members列表中找到该属性，它将具有该注释（但不是基础支持字段！）。

谁来更新一下文件。-）