写在前面的话
之前这块知识是缺失的,趁今天有时间,先补一补。
第一次接触到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。它有两个目的:- 允许配置只在编译时作为注解处理器的依赖,而不添加到最后的APK或library
- 设置源路径,使注解处理器生成的代码能被Android Studio正确的引用
PS: Android Gradle 插件 2.2 版本的发布后,apt作者宣布不再维护,推荐使用官方的
- Processor
负责具体的注解处理工作,比如生成类文件并且可以被javadoc编译。后面就不赘述了,关于这两个工具更详细的信息,有兴趣的点这里的链接。
具体代码也不一一铺开,已经上传到github,欢迎自取,链接如下:https://github.com/Drolmen/AnnotationStudy。
总结
注解是一个很灵活、强大的工具。根据自己的需求自定义注解,自动生成代码,用于提升软件的质量和生产效率,是一件很有意义的事。