Kotlin注解使用

Kotlin的注解和java的基本一致, 具体的细节可以看官方文档

https://kotlinlang.org/docs/reference/annotations.html

比较大的区别是Kotlin不支持@Inherited元注解,虽然一般情况下从父类使用注解的情况是非常少的。但总有人会碰到这样的问题。已经有人提出这个问题了,详见:https://youtrack.jetbrains.com/issue/KT-22265

注解的使用

注解一般用来在编译时处理代码,例如编译时进行格式检查,生成文档等
Kotlin的注解和Java的注解使用方式基本一致。获取注解相关信息的方式也基本一致
都需要实现AbstractProcessor来获取带指定的注解的元素的信息

public class AProcessor extends AbstractProcessor {

    @Override
    public synchronized void init(ProcessingEnvironment env){ }

    @Override
    public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { }

    @Override
    public Set<String> getSupportedAnnotationTypes() { }

    @Override
    public SourceVersion getSupportedSourceVersion() { }

}
  • init Processor初始化的时候会调用此方法, ProcessingEnvironment是Processor所处的环境. ProcessingEnvironment有一个Options字段,用来存放一些特定的选项,例如可以从gradle插件中传递Project的一些信息进来.
android.defaultConfig.javaCompileOptions.annotationProcessorOptions.argument(“moduleName”, project.name)
  • process 是处理注解的主要方法,annoations中包含注解和使用注解的元素的信息,RoundEnvironment包含当前注解环境的上下文信息。return true表示该注解已处理完成,不再需要其他Processor处理

  • getSupportedAnnotationTypes 告诉Processor要扫面那些注解,返回的是包含指定注解类名的set

  • getSupportedSourceVersion 指定支持的version, 不同的Version支持的内容不一样,

1.1: nested classes
1.2: strictfp
1.3: no changes
1.4: assert
1.5: annotations, generics, autoboxing, var-args...
1.6: no changes
1.7: diamond syntax, try-with-resources, etc.
1.8: lambda expressions and default methods

一般传入SourceVersion.latest()即可

获取注解的信息

在process方法中可以获取到指定注解的信息。annoations 中的对象是TypeElement, TypeElement 是Element的子类,里面包含着注解的信息.

通过roundEnvironment.getElementsAnnotatedWith(注解类的Class)来获取当前注解的信息

Element的关键属性:

  • name: 使用注解的元素的名称。如果是CLASS就是类全名,如果是方法就是方法名,其他类推
  • getKind(): 使用注解的元素类型,如CLASS, PACKAGE, INTERFACE,FIELD等,对应注解的Target
  • getModifiers(): 使用注解的元素的修饰符,如class的private, static, final等
  • TypeMirror:对应Java 编程语言中的类型。 如ArrayType,DeclaredType,NullType等。主要用来判断使用者和注解参数的类型,通过typeMirror可以获取注解中Class参数的类名

注册Processor

AbstractProcessor实现之后不能直接使用,需要注册之后才能运行,有两种方式:

  1. 手动注册

在实现AbstractProcessor的项目中添加resources/META-INF文件夹,并在META-INF下添加一个名称为javax.annotation.processing.Processor的文本文件,在里面写入实现AbstractProcessor类的全名

  1. 自动注册

使用google提供的AutoService主动注册。在AbstractProcessor实现类上加上注解:

@AutoService(Processor::class)

就可以了。

AutoService也是通过注解的形式自动生成对应的文件和文件夹。

打印日志

由于AbstractProcessor的执行在编译器,所以不能直接使用android和java的日志输出方式,需要使用

processingEnv.messager.printMessage(Diagnostic.Kind, msg)

来打印日志

注意: 若使用Diagnostic.Kind.ERROR打印,则会导致编译失败。

生成代码

注解的信息收集完成之后是不能直接使用的,因为是在编译期间,无法直接保存信息到运行期。所以需要生成对应的代码老保存需要的信息和功能

AbstractProcessor中提供了生成代码的辅助类:Filer, 在ProcessingEnvironment中。生成代码就是一个简单的创建文件,写入文本内容的过程。生成java源码有很著名的javapoet框架,不再赘述。

在kotlin中运行Processor时kapt, 来替代annotationProcessor。 也有KotlinPoet来对应javapoet。
生成代码还是比较方便的

当然,如果需要生成的源码文件比较简单,可以直接使用拼接字符串的形式生成代码,然后写入到文件中。

自动生成的源码文件在build文件夹下面,kotlin生成的文件的文件夹路径可以在options中获取到:

val path = processingEnv.options[“kapt.kotlin.generated”]

文件生成之后,在开发期间就可以直接使用该类了

由于通过注解能获取的信息的类型是非常有限的,而且最终都是以写入文件的形式保存,所以能保存的信息比较有限,用的最多的也就是来获取类名,写入到文件中,反射使用。当然,生成的代码要实现的功能还是可以更加丰富的,如ButterKnife,Router, dagger等

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

推荐阅读更多精彩内容