Kotlin注解(1)元注解

  • @Target
  • @Retention
  • @Repeatable
  • @MustBeDocumented

  Kotlin 中的注解本质上是一种接口类型。Kotlin 标准库中提供一些基本注解和元注解。基本注解会影响编译器的行为,如@JvmName@JvmFieldJvmStatic@JvmOverloads@Throws 等,这些基本注解主要用于 Kotlin 与 Java 的混合编程中。元注解是负责注解其他的注解,自定义注解会用到元注解。

  Kotlin 元注解有 4 个,其中包括 TargetRetentionRepeatableMustBeDocumented,它们都位于 kotlin.annotation 包中。元注解是为其他注解进行说明的注解,当自定义一个新的注解类型时,其中可以使用元注解。

@Target

  @Target 使用于目标注解,它用来指定一个新注解的使用目标。@Target 注解有一个 allowedTargets 属性,该属性用来设置使用目标,allowedTargetskotlin.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 属性,该属性用来设置保留期,valuekotlin.annotation.AnnotationRetention 枚举类型,AnnotationRetention 描述注解保留期种类,它有 3 个常量,如下:

常量 保留期
SOURCE 只适用于源代码文件中,此范围最小
BINARY 编译器把注解信息记录在编译之后的二进制文件中,对于反射是不可见的,此范围居中
RUNTIME 编译器把注解信息记录在编译之后的二进制文件中,对于反射是可见的,此范围最大,这是默认保留期

@Repeatable

  @Repeatable 适用于可重复注解,它允许在相同的程序元素中重复注解,可重复的注解必须使用 @Repeatable 进行注解。

@MustBeDucomented

  @MustBeDucomented 适用于文档注解,该注解可以修饰代码元素(类、接口、函数 和 属性等),文档生成工具可以提取这些注解信息。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容