- @Target
- @Retention
- @Repeatable
- @MustBeDocumented
Kotlin 中的注解本质上是一种接口类型。Kotlin 标准库中提供一些基本注解和元注解。基本注解会影响编译器的行为,如@JvmName
、@JvmField
、JvmStatic
、@JvmOverloads
和 @Throws
等,这些基本注解主要用于 Kotlin 与 Java 的混合编程中。元注解是负责注解其他的注解,自定义注解会用到元注解。
Kotlin 元注解有 4 个,其中包括 Target
、Retention
、Repeatable
和 MustBeDocumented
,它们都位于 kotlin.annotation
包中。元注解是为其他注解进行说明的注解,当自定义一个新的注解类型时,其中可以使用元注解。
@Target
@Target
使用于目标注解,它用来指定一个新注解的使用目标。@Target
注解有一个 allowedTargets
属性,该属性用来设置使用目标,allowedTargets
是 kotlin.annotation.AnnotationTarget
枚举类型的数组,AnnotationTarget
描述 Kotlin 代码中可以被注解的元素类型,它有 15 个枚举常量。如下:
常量 | 使用目标 |
---|---|
CLASS | 类、接口、对象声明和注解类声明 |
ANNOTATION_CLASS | 其他注解类型声明 |
TYPE_PARAMERTER | 用于泛型中类型参数声明 |
PROPERTY | 属性声明 |
FIELD | 字段声明,包括属性的支持字段 |
LOCAL_VARIABLE | 局部变量声明 |
VALUE_PARAMETER | 用于函数或构造函数参数值声明 |
CONSTRUCTOR | 用于构造函数声明 |
FUNCTION | 用于函数声明,不包括构造函数 |
PROPERTY_GETTER | 只用于属性的getter访问器声明 |
PROPERTY_SETTER | 只用于属性的setter访问器声明 |
TYPE | 类型使用 |
EXPRESSION | 任何表达式 |
FILE | 文件 |
TYPEALIAS | 类型别名 |
@Retention
@Retention
使用于保留期注解,它用来指定一个新注解的有效范围,@Retention
注解有一个 value
属性,该属性用来设置保留期,value
是 kotlin.annotation.AnnotationRetention
枚举类型,AnnotationRetention
描述注解保留期种类,它有 3 个常量,如下:
常量 | 保留期 |
---|---|
SOURCE | 只适用于源代码文件中,此范围最小 |
BINARY | 编译器把注解信息记录在编译之后的二进制文件中,对于反射是不可见的,此范围居中 |
RUNTIME | 编译器把注解信息记录在编译之后的二进制文件中,对于反射是可见的,此范围最大,这是默认保留期 |
@Repeatable
@Repeatable
适用于可重复注解,它允许在相同的程序元素中重复注解,可重复的注解必须使用 @Repeatable
进行注解。
@MustBeDucomented
@MustBeDucomented
适用于文档注解,该注解可以修饰代码元素(类、接口、函数 和 属性等),文档生成工具可以提取这些注解信息。