在java的世界里面,不管是我们自己写代码,亦或是看一些开源框架的代码,我们经常会看到作者使用注解,注解是定义一些额外的信息或者是操作处理的手段,这就是注解的全部意义
注解的分类
Java 1.5中开始引入的Annotation,类似于注释解释的一种技术,我们常常使用它在代码中来做一些注释,并且在适当(编译代码或运行代码等时机)的时候,对其进行解释,并且做一些额外的操作
我们先来了解一下java中已经存在的那些注解和使用方式,然后我们再进行自定义注解操作和使用。
内置注解
我们在开发中,用得最多的Annotation莫过于@Override了。大家天天用,可能很多人却没有关注过其背后的细节,我们看一下它的定义:
// 方法注解,表示此注解修饰的方法覆盖了父类或是接口的方法
// 如果不是这样,则输出警告
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
// 对于此注解所修饰的对象(类、域、方法等)
// 当你使用了它们时编译器将输出“已废弃”警告
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}
// 关闭警告,通过给此注解的元素赋值
// 可以关闭特定警告
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
String[] value();
}
元注解
@Documented // 标志将此注解包含至javadoc中
// 定义注解保存级别
// 1.SOURCE 源代码注解,被编译器丢弃
// 2.CLASS 类注解,被编译器记录在class文件中,运行时被VM丢弃,在编译时使用,属于默认配置
// 3.RUNTIME 被编译器记录在class文件中,运行时可用,被VM保留,所以可以在运行时搭配反射使用
@Retention(RetentionPolicy.RUNTIME)
// 定义注解适用的目标
// 1.TYPE Class类,接口(包括注解类型或者enum类型)
// 2.FIELD 属性(包括enum实例)
// 3.METHOD 方法
// 4.PARAMETER 方法参数
// 5.CONSTRUCTOR 类构造器
// 6.LOCAL_VARIABLE 本地变量
// 7.ANNOTATION_TYPE 注解类型
// 8.PACKAGE 包
@Target(ElementType.METHOD)
// 定义继承类型,注解也允许继承
@Inherited
在定义元注解的时候,@Target的值都是定义为ElementType.ANNOTATION_TYPE,例如:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE) // 目标定义为注解类型
public @interface Retention {
RetentionPolicy value();
}
自定义注解
// 定义运行时使用策略
@Retention(RetentionPolicy.RUNTIME)
// 适用目标是类的成员变量
@Target(ElementType.FIELD)
public @interface DBField {
String value() default ""; // default定义了默认值,此处为""
}
那么我们如何使用以上3种类型的注解呢?
举几个栗子
栗子1
public class ApplicantResult {
@DBField(DBConstants.sign.SHEET_ID)
long sheetId;
}
解释:由于我们上面定义的DBField注解,使用是在成员变量使用,所以这里我们在ApplicantResult
类的属性sheetId
中使用,我们发现为什么不是使用@DBField(value=DBConstants.sign.SHEET_ID)
呢?
这里使用注解的过程中有几个隐晦的使用规则
- 如果注解中定义了value元素
- 如果在使用注解时value是惟一需要赋值的元素
- 那么只需在括号内给出value的值即可
- 如果没有给相应的注解赋值,那么将使用注解中的默认值,类似于@DBField(),value值默认被赋予空值(即default "")
所以这里才有了我们简写的注解使用
栗子2
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Deprecated {
}
对于元注解@Target,如果你希望一个注解可以作用于ElementType中的所有类型,那么就可以不使用@Target——@Deprecated就是这样做的。
注解的使用
注解的使用,主要是依据@Retention的分类,可以在源码,编译时,运行时,结合不同的@Target配合使用,我们下面主要讲解一下注解有哪几种使用场景
- 基于运行时反射方式使用
@Retention(RetentionPolicy.RUNTIME)
参考我的另外一篇文章ButterKnife使用和原理 - 基于APT的注解处理工具(Java Annotation Processing Tools)