一、元数据
要想理解注解(Annotation)的作用,就要先理解Java中元数据的概念。
1.元数据概念
元数据是关于数据的数据。在编程语言上下文中,元数据是添加到程序元素如方法、字段、类和包上的额外信息。对数据进行说明描述的数据。
2.元数据的作用
一般来说,元数据可以用于创建文档(根据程序元素上的注释创建文档),跟踪代码中的依赖性(可声明方法是重载,依赖父类的方法),执行编译时检查(可声明是否编译期检测),代码分析。
如下:
1) 编写文档:通过代码里标识的元数据生成文档
2)代码分析:通过代码里标识的元数据对代码进行分析
3)编译检查:通过代码里标识的元数据让编译器能实现基本的编译检查
3.Java平台元数据
注解Annotation就是java平台的元数据,是 J2SE5.0新增加的功能,该机制允许在Java 代码中添加自定义注释,并允许通过反射(reflection),以编程方式访问元数据注释。通过提供为程序元素(类、方法等)附加额外数据的标准方法,元数据功能具有简化和改进许多应用程序开发领域的潜在能力,其中包括配置管理、框架实现和代码生成。
二、注解(Annotation)
1.注解(Annotation)的概念
注解(Annotation)在JDK1.5之后增加的一个新特性,注解的引入意义很大,有很多非常有名的框架,比如Hibernate、Spring等框架中都大量使用注解。注解作为程序的元数据嵌入到程序。注解可以被解析工具或编译工具解析。
关于注解(Annotation)的作用,其实就是上述元数据的作用。
注意:Annotation能被用来为程序元素(类、方法、成员变量等)设置元素据。Annotaion不影响程序代码的执行,无论增加、删除Annotation,代码都始终如一地执行。如果希望让程序中的Annotation起一定的作用,只有通过解析工具或编译工具对Annotation中的信息进行解析和处理。
2.内建注解
Java提供了多种内建的注解,下面接下几个比较常用的注解:@Override、@Deprecated、@SuppressWarnings以及@FunctionalInterface这4个注解。内建注解主要实现了元数据的第二个作用:编译检查。
@Override
用途:用于告知编译器,我们需要覆写超类的当前方法。如果某个方法带有该注解但并没有覆写超类相应的方法,则编译器会生成一条错误信息。如果父类没有这个要覆写的方法,则编译器也会生成一条错误信息。
@Override可适用元素为方法,仅仅保留在java源文件中。
@Deprecated
用途:使用这个注解,用于告知编译器,某一程序元素(比如方法,成员变量)不建议使用了(即过时了)。
例如:
Person类中的info()方法使用@Deprecated
表示该方法过时了。
public class Person {
@Deprecated
public void info(){
}
}
调用info()方法会编译器会出现警告,告知该方法已过时。
注解类型分析:@Deprecated
可适合用于除注解类型声明之外的所有元素,保留时长为运行时。
@SuppressWarnings
用途:用于告知编译器忽略特定的警告信息,例在泛型中使用原生数据类型,编译器会发出警告,当使用该注解后,则不会发出警告。
注解类型分析: @SuppressWarnings
可适合用于除注解类型声明和包名之外的所有元素,仅仅保留在java源文件中。
该注解有方法value(),可支持多个字符串参数,用户指定忽略哪种警告,例如:
@SupressWarning(value={"uncheck","deprecation"})
@FunctionalInterface
用途:用户告知编译器,检查这个接口,保证该接口是函数式接口,即只能包含一个抽象方法,否则就会编译出错。
注解类型分析: @FunctionalInterface
可适合用于注解类型声明,保留时长为运行时。
3.元Annotation
JDK除了在java.lang提供了上述内建注解外,还在java.lang。annotation包下提供了6个Meta Annotation(元Annotataion),其中有5个元Annotation都用于修饰其他的Annotation定义。其中@Repeatable专门用户定义Java 8 新增的可重复注解。
我们先介绍其中4个常用的修饰其他Annotation的元Annotation。在此之前,我们先了解如何自定义Annotation。
当一个接口直接继承java.lang.annotation.Annotation接口时,仍是接口,而并非注解。要想自定义注解类型,只能通过@interface关键字的方式,其实通过该方式会隐含地继承.Annotation接口。
@Documented
@Documented
用户指定被该元Annotation修饰的Annotation类将会被javadoc工具提取成文档,如果定义Annotation类时使用了@Documented
修饰,则所有使用该Annotation修饰的程序元素的API文档中将会包含该Annotation说明。
例如:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}
定义@Deprecated
时使用了@Documented
,则任何元素使用@Deprecated修饰时,在生成API文档时,将会包含@Deprecated
的说明
以下是String的一个过时的构造方法:
@Deprecated
public String(byte[] ascii,int hibyte,int offset, int count)
该注解实现了元数据的第一个功能:编写文档。
@Inherited
@Inherited
指定被它修饰的Annotation将具有继承性——如果某个类使用了@Xxx注解(定义该Annotation时使用了@Inherited
修饰)修饰,则其子类将自动被@Xxx修饰。
@Retention
@Retention
:表示该注解类型的注解保留的时长。当注解类型声明中没有@Retention
元注解,则默认保留策略为RetentionPolicy.CLASS。关于保留策略(RetentionPolicy)是枚举类型,共定义3种保留策略,如下表:
@Target
@Target
:表示该注解类型的所适用的程序元素类型。当注解类型声明中没有@Target
元注解,则默认为可适用所有的程序元素。如果存在指定的@Target
元注解,则编译器强制实施相应的使用限制。关于程序元素(ElementType)是枚举类型,共定义8种程序元素,如下表:
三、自定义注解(Annotation)
创建自定义注解,与创建接口有几分相似,但注解需要以@开头。
@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotataion{
String name();
String website() default "hello";
int revision() default 1;
}
自定义注解中定义成员变量的规则:
其定义是以无形参的方法形式来声明的。即:
注解方法不带参数,比如name(),website();
注解方法返回值类型:基本类型、String、Enums、Annotation以及前面这些类型的数组类型
注解方法可有默认值,比如default "hello",默认website=”hello”
当然注解中也可以不存在成员变量,在使用解析注解进行操作时,仅以是否包含该注解来进行操作。当注解中有成员变量时,若没有默认值,需要在使用注解时,指定成员变量的值。
public class AnnotationDemo {
@MyAnnotataion(name="lvr", website="hello", revision=1)
public static void main(String[] args) {
System.out.println("I am main method");
}
@SuppressWarnings({ "unchecked", "deprecation" })
@MyAnnotataion(name="lvr", website="hello", revision=2)
public void demo(){
System.out.println("I am demo method");
}
}
由于该注解的保留策略为RetentionPolicy.RUNTIME
,故可在运行期通过反射机制来使用,否则无法通过反射机制来获取。这时候注解实现的就是元数据的第二个作用:代码分析。
下面来具体介绍如何通过反射机制来进行注解解析。
四、注解解析
接下来,通过反射技术来解析自定义注解。关于反射类位于包java.lang.reflect,其中有一个接口AnnotatedElement,该接口主要有如下几个实现类:Class,Constructor,Field,Method,Package。除此之外,该接口定义了注释相关的几个核心方法,如下:
因此,当获取了某个类的Class对象,然后获取其Field,Method等对象,通过上述4个方法提取其中的注解,然后获得注解的详细信息。
public class AnnotationParser {
public static void main(String[] args) throws SecurityException, ClassNotFoundException {
String clazz = "com.lvr.annotation.AnnotationDemo";
Method[] demoMethod = AnnotationParser.class
.getClassLoader().loadClass(clazz).getMethods();
for (Method method : demoMethod) {
if (method.isAnnotationPresent(MyAnnotataion.class)) {
MyAnnotataion annotationInfo = method.getAnnotation(MyAnnotataion.class);
System.out.println("method: "+ method);
System.out.println("name= "+ annotationInfo.name() +
" , website= "+ annotationInfo.website()
+ " , revision= "+annotationInfo.revision());
}
}
}
}
以上仅是一个示例,其实可以根据拿到的注解信息做更多有意义的事。