Android Annotation 学习

写在前面的话

之前这块知识是缺失的,趁今天有时间,先补一补。
第一次接触到butterKnife的时候,就发现注解是个很神奇的并且难以理解的东西。现在要终于要踩着前人的脚印一探究竟,下面是一些总结,原文链接请戳这里Android开发你需要知道的注解

什么是注解、注解的作用

java.lang.annotation,接口Annotation,Java 1.5及以后版本引入。
注解是代码里特殊的标记,这些标记可以在编译、类加载、运行时被读取,并执行响应处理。通过使用Annotation,开发人员可以再不改变原有逻辑的情况下,在原文件中嵌入一些补充信息。 代码分析工具、开发工具和部署工具可以通过这些补充进行验证、处理或进行部署。
PS: Annotation不能运行,它只有成员变量,没有方法

注解有哪些

元注解

Java提供4中元注解,专门负责创建新的注解。

  • @target 定义了Annotation所修饰的对象范围,取值:

    • ElementType.CONSTRUCTOR:用于描述构造器
    • ElementType.FIELD :用于描述类变量
    • ElementType.LOCAL_VARIABLE:用于描述局部变量
    • ElementType.METHOD:用于描述方法
    • ElementType.PACKAGE:用于描述包
    • ElementType.PARAMETER:用于描述参数
    • ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明
    • ElementType.ANNOTATION_TYPE:用于描述注解类型
    • TYPE_PARAMETER:类型参数声明(1.8新加入,使用较少)
    • TYPE_USE:类型使用声明(1.8新加入,使用较少)
  • @retention 定义了该Annotation被保留的时间长短,取值:

    • RetentionPoicy.SOURCE :注解只保留在源文件,当Java文件编译成class文件的时候,注解被遗弃;用于做一些检查性的操作,比如 @Override 和 @SuppressWarnings
    • RetentionPoicy.CLASS: 注解被保留到class文件,但jvm加载class文件时候被遗弃,这是默认的生命周期;用于在编译时进行一些预处理操作,比如生成一些辅助代码(如 ButterKnife )
    • RetentionPoicy.RUNTIME :注解不仅被保存到class文件中,jvm加载class文件之后,仍然存在;用于在运行时去动态获取注解信息。
  • @documented : 标记注解,用于描述其它类型的注解应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化,不用赋值。

  • @inherited 标记注解,允许子类继承父类的注解。

JDK中的注解

常见的两种注解: @Override、@Deprecated

Android SDK 中的注解

比较多,所以分类展示:

  • 资源引用限制类:用于限制参数必须为对应的资源类型
    @AnimRes @AnyRes @ArrayRes @AttrRes @BoolRes @ColorRes等
  • 线程执行限制类:用于限制方法或者类必须在指定的线程执行
    @AnyThread @BinderThread @MainThread @UiThread @WorkerThread
  • 参数为空性限制类:用于限制参数是否可以为空
    @NonNull @Nullable
  • 类型范围限制类:用于限制标注值的值范围
    @FloatRang @IntRange
  • 类型定义类:用于限制定义的注解的取值集合
    @IntDef @StringDef
  • 其他的功能性注解:
    @CallSuper @CheckResult @ColorInt @Dimension @Keep @Px @RequiresApi @RequiresPermission @RestrictTo @Size @VisibleForTesting

Android常用的注解库

ButterKnife和Retrofit。
注解信息的获取,需要使用反射获取,反射是一种比较耗时的操作,因此很多第三方的库,选择在编译的时候处理这些信息从而不影响程序的运行加载速度。
ButterKnife几乎是每个项目都使用得到的库,我尤其好奇的是使用了BindView(R.id.XXX)后,编译期间会在同一个包生成的辅助文件。下面我们就尝试自定义注解,并且实现在编译器生成辅助类。

自定义注解

简单注解的使用

定义简单注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME) //指定运行时可以被读取
public @interface Star {
   long radius();    //描述行星半径
}

运行时获取注解信息

@AnnotationList.Star(radius = 6371000)
public class Earth {
    public long getRadius() {
        AnnotationList.Star annotation = getClass().getAnnotation(AnnotationList.Star.class);
        return annotation.radius();
    }
}

---MainActivity.jvava--
private void testStarAnnotation() {
    Earth earth = new Earth();
    Toast.makeText(this, "earth.getRadius():" + earth.getRadius(), Toast.LENGTH_SHORT).show();
}

结果如下

D/MainActivity: earth.getRadius():6371000

自定义注解进阶

上面的Demo尝试了自定义注解,并在运行时获取值,实际应用的时候,应该会有更广泛的用途。下面尝试使用自定义注解,结合AndroidStudio在编译期生成辅助类文件。
首先介绍两个工具:

  • annotationProcessor 和 Android-apt.
    这两者是Gradle插件,协助Android Studio 处理processors。它有两个目的:
    1. 允许配置只在编译时作为注解处理器的依赖,而不添加到最后的APK或library
    2. 设置源路径,使注解处理器生成的代码能被Android Studio正确的引用
      PS: Android Gradle 插件 2.2 版本的发布后,apt作者宣布不再维护,推荐使用官方的
  • Processor
    负责具体的注解处理工作,比如生成类文件并且可以被javadoc编译。后面就不赘述了,关于这两个工具更详细的信息,有兴趣的点这里的链接

具体代码也不一一铺开,已经上传到github,欢迎自取,链接如下:https://github.com/Drolmen/AnnotationStudy

总结

注解是一个很灵活、强大的工具。根据自己的需求自定义注解,自动生成代码,用于提升软件的质量和生产效率,是一件很有意义的事。

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

推荐阅读更多精彩内容