Kotlin注解详解

注解声明
注解是将元数据附加到代码的方法。要声明注解，请将 annotation 修饰符放在类的前面：

annotation class MyAnnotation

注解的附加属性可以通过用元注解标注注解类来指定：

• @Target指定可以用该注解标注的元素的可能的类型（类、函数、属性、表达式等）；
• @Retention指定该注解是否存储在编译后的 class 文件中，以及它在运行时能否通过反射可见 （默认都是 true）；
• @Repeatable 允许在单个元素上多次使用相同的该注解；
• @MustBeDocumented指定该注解是公有 API 的一部分，并且应该包含在生成的 API 文档中显示的类或方法的签名中。

@Target(AnnotationTarget.CLASS,AnnotationTarget.FUNCTION,AnnotationTarget.VALUE_PARAMETER,AnnotationTarget.EXPRESSION,
        AnnotationTarget.CONSTRUCTOR,AnnotationTarget.PROPERTY_SETTER,AnnotationTarget.FIELD,AnnotationTarget.PROPERTY_GETTER)
@Retention(AnnotationRetention.SOURCE)
@MustBeDocumented
annotation class MyAnnotation

使用

class MyClass {
    @MyAnnotation
    fun myMethod(@MyAnnotation a: Int): Int {
        return (@MyAnnotation 10)
    }
}
//对类的主构造函数进行标注
class MyClass2 @MyAnnotation constructor(a: Int) {

}
//标注属性访问器
class MyClass3 {
    var a: Int? = null
        @MyAnnotation set
}

注解也可以拥有自己的构造方法，并且构造方法也可以接受参数

annotation class MyAnnotation2(val str: String)

@MyAnnotation2("hello")
class MyClass4

注解构造方法所允许的参数类型:

• 与Java原生类型所对应的类型（Int,Long..)
• 字符串：string
• classes（MyClass::class)
• 枚举：enums
• 其他的注解
• 上述类型的数组类型

Kotlin的注解参数是不允许为空类型的，因为JVM不支持以null的形式存储注解属性值的。

如果某个注解被用作其他注解的参数，那么其名字就不需要以@字符开头

示例

annotation class MyAnnotation3(val str:String,val myAnnotation:MyAnnotation2)

@MyAnnotation3("test", MyAnnotation2("welcome"))
class MyClass5

如果需要将某个class作为注解的参数，那么请使用Kotlin class(KClass),Kotlin编译器会自动将其转换为Java Class,这样，Java代码就可以正常看到注解及参数了。

示例

annotation class MyAnnotation4(val arg1: KClass<*>, val arg2: KClass<out Any>)

@MyAnnotation4(String::class, Int::class)
class MyClass6

注解使用处目标（use-site target）

在对类的属性或者是主构造方法的参数声明注解时，会存在多个Java元素都可以通过对应的Kotlin元素生成出来，因此，在所生成的Java字节码中，就会存在多个可能的位置来生成相应的注解。若想要精确指定如何来生成注解，那么可以使用注解的使用处目标方式来实现。

示例

class MyClass7(@field:MyAnnotation val arg1: String, //注解 Java field
               @get:MyAnnotation val arg2: String,   //注解 Java getter
               @param:MyAnnotation val arg3: String) //注解 Java构造方法参数

可以使用相同的语法来标注整个文件。 要做到这一点，把带有目标 file 的注解放在文件的顶层、package 指令之前或者在所有导入之前（如果文件在默认包中的话）：

@file:JvmName("MyAnnotation")
package com.leofight.kotlin9

如果你对同一目标有多个注解，那么可以这样来避免目标重复——在目标后面添加方括号并将所有注解放在方括号内：

class Example {
    @set:[Inject VisibleForTesting]
    var collaborator: Collaborator
}

支持的使用处目标的完整列表为：

• file；
• property（具有此目标的注解对 Java 不可见）；
• field；
• get（属性 getter）；
• set（属性 setter）；
• receiver（扩展函数或属性的接收者参数）；
• param（构造函数参数）；
• setparam（属性 setter 参数）；
• delegate（为委托属性存储其委托实例的字段）。