注解(Annotation) 概述
注解目前非常的流行,很多主流框架都支持注解,而且自己编写代码的时候也会尽量的去用注解,一时方便,而是代码更加简洁。
从JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解),目前非常的流行,很多主流框架都支持注解,而且自己编写尽量的去用注解,代码更加简洁。
Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的“name=value” 对中。
在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE / Android 中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说:框架= 注解+ 反射+ 设计模式。
注解的原理:
注解本质是一个继承了Annotation 的特殊接口,其具体实现类是Java 运行时生成的动态代理类。而我们通过反射获取注解时,返回的是Java 运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解(接口)的方法,会最终调用AnnotationInvocationHandler 的invoke 方法。该方法会从memberValues 这个Map 中索引出对应的值。而memberValues 的来源是Java 常量池。
常见的Annotation
使用Annotation 时要在其前面增加@ 符号, 并把该Annotation 当成一个修饰符使用。用于修饰它支持的程序元素
生成文档相关的注解
@author标明开发该类模块的作者,多个作者之间使用,分割
@version标明该类模块的版本
@see参考转向,也就是相关主题
@since从哪个版本开始增加的
@param对方法中某参数的说明,如果没有参数就不能写
@return对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception对方法可能抛出的异常进行说明,方法没有用throws显式抛出的异常就不能写
@param@return和@exception这三个标记都是只用于方法的。
@param的格式要求:@param 形参名 形参类型 形参说明
@return的格式要求:@return 返回值类型 返回值说明
@exception的格式要求:@exception 异常类型 异常说明
@param和@exception可以并列多个
JDK内置的三个基本注解
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings: 关闭不当编译器警告信息。
跟踪代码依赖性,实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。spring框架中关于“事务”的管理
自定义Annotation
定义新的Annotation类型使用@interface关键字,自定义注解自动继承了java.lang.annotation.Annotation接口。Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
可以在定义Annotation的成员变量时为其指定初始值,指定成员变量的初始值可使用default关键字。如果只有一个参数成员,建议使用参数名为value。如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名=参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”。没有成员定义的Annotation称为标记;包含成员变量的Annotation称为元数据Annotation
import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@MyAnnotation(value = "牛大圣")
public class MyAnnotationTest {
public static void main (String[] args) {
Class c = MyAnnotationTest.class;
Annotation annotation = c.getAnnotation(MyAnnotation.class);
MyAnnotation m = (MyAnnotation) annotation;
String value = m.value();
System.out.println(value);
}
}
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation {
String value () default "niudasheng";
}
注意:自定义注解必须配上注解的信息处理流程才有意义。
JDK 中的元注解
JDK 的元Annotation用于修饰其他Annotation定义,JDK5提供了4个标准的meta-annotation 类型,分别是:
Retention,Target,Documented, Inherited
元数据的理解:
String name = “atguigu”;
@Retention:
只能用于修饰一个Annotation 定义, 用于指定该Annotation 的生命周期, @Rentention包含一个RetentionPolicy类型的成员变量, 使用@Rentention时必须为该value 成员变量指定值:
RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS:在class文件中有效(即class保留),当运行Java 程序时, JVM 不会保留注解。这是默认值
RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。
@Target:
用于修饰Annotation 定义, 用于指定被修饰的Annotation 能用于修饰哪些程序元素。@Target 也包含一个名为value 的成员变量。
表示该注解可以用于什么地方,可能的ElementType参数有:
CONSTRUCTOR:构造器的声明
FIELD:域声明(包括enum实例)
LOCAL_VARIABLE:局部变量声明
METHOD:方法声明
PACKAGE:包声明
PARAMETER:参数声明
TYPE:类、接口(包括注解类型)或enum声明
@Documented:
用于指定被该元Annotation 修饰的Annotation 类将被javadoc工具提取成文档。默认情况下,javadoc是不包括注解的。定义为Documented的注解必须设置Retention值为RUNTIME。
@Inherited:
被它修饰的Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的Annotation, 则其子类将自动具有该注解。
比如:如果把标有@Inherited注解的自定义的注解标注在类级别上,子类则可以继承父类类级别的注解,实际应用中,使用较少
利用反射获取注解信息
JDK 5.0 在java.lang.reflect包下新增了AnnotatedElement接口, 该接口代表程序中可以接受注解的程序元素
当一个Annotation 类型被定义为运行时Annotation 后, 该注解才是运行时可见, 当class 文件被载入时保存在class 文件中的Annotation 才会被虚拟机读取
程序可以调用AnnotatedElement对象的如下方法来访问Annotation 信息
Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。此外,反射也得到了加强,在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解。
可重复注解示例:
import java.lang.annotation.Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.LOCAL_VARIABLE;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PACKAGE;
import static java.lang.annotation.ElementType.TYPE_PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
@MyAnnotation(value = "牛大圣一号")
@MyAnnotation(value = "牛大圣二号")
public class MyAnnotationTest {
public static void main (String[] args) {
Class c = MyAnnotationTest.class;
Annotation annotation = c.getAnnotation(MyAnnotations.class);
MyAnnotations m = (MyAnnotations) annotation;
MyAnnotation[] value = m.value();
for (int i = 0; i < value.length; i++) {
System.out.println(value[i].value() + " ");
}
}
}
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, FIELD, METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE, PACKAGE, TYPE_PARAMETER, TYPE_USE })
@interface MyAnnotation {
String value () default "niudasheng";
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, FIELD, METHOD, ElementType.PARAMETER, ElementType.CONSTRUCTOR, LOCAL_VARIABLE, ANNOTATION_TYPE, PACKAGE, TYPE_PARAMETER, TYPE_USE })
@interface MyAnnotations {
MyAnnotation[] value ();
}
类型注解:
JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:TYPE_PARAMETER,TYPE_USE。
在Java8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。
ElementType.TYPE_PARAMETER表示该注解能写在类型变量的声明语句中(如:泛型声明)。
ElementType.TYPE_USE表示该注解能写在使用类型的语句中。
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.TYPE_PARAMETER;
public class MyAnnotationTest<@TypeParameterAnnotation() U> {
private U u;
public <@TypeParameterAnnotation() T> void test (T t) {
}
}
@Retention(RetentionPolicy.RUNTIME)
@Target({ TYPE_PARAMETER })
@interface TypeParameterAnnotation {
String value () default "niudasheng";
}