码迷,mamicode.com
首页 > 其他好文 > 详细

注解Annotation

时间:2015-05-19 18:41:21      阅读:217      评论:0      收藏:0      [点我收藏+]

标签:

Annotation(注解),Annotation是代码里的特殊标记,这些标记可以在编译、类加载、运行时被读取,并执行相应的处理。

Annotation提供了一种为程序元素(包、类、构造器、方法、成员变量、参数、局域变量)设置元数据的方法。
Annotation不能运行,它只有成员变量,没有方法。Annotation跟public、final等修饰符的地位一样,都是程序
元素的一部分,Annotation不能作为一个程序元素使用。

通过使用Annotation,开发人员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充的信息

1、定义Annotation
使用@interface关键字(在原有interface关键字前增加@符号)。定义一个新的Annotation类型与定义一个接口很像。
  1. public @interface Test{
  2. }
定义完该Annotation后,就可以在程序中使用该Annotation。
使用Annotation,非常类似于public、final这样的修饰符,通常,会把Annotation另放一行,并且放在所有修饰符之前。
  1. @Test
  2. public class MyClass{
  3. ....
  4. }
1.1 成员变量
Annotationa只有成员变量!没有方法,Annotation的成员变量在Annotation定义中以“无形参的方法”形式来声明,
成员变量以方法的形式来定义,其返回值定义了该成员变量的类型。
  1. public @interface MyTag{
  2. string name();
  3. int age();
  4. }
在Annotation里定义了成员变量后,使用该Annotation时就应该为该Annotation的成员变量指定值
  1. public class Test{
  2. @MyTag(name="红薯"age=30)
  3. public void info(){
  4. ......
  5. }
  6. }
也可以在定义Annotation的成员变量时,为其指定默认值,指定成员变量默认值使用default关键字。
  1. public @interface MyTag{
  2. string name() default "我兰";
  3. int age() default 18;
  4. }
Annotation的成员变量已经指定了默认值,使用该Annotation时可以不为这些成员变量指定值,而是直接使用默认值。
  1. public class Test{
  2. @MyTag
  3. public void info(){
  4. ......
  5. }
  6. }
根据Annotation是否包含成员变量,可以把Annotation分为如下两类:
标记Annotation:没有成员变量的Annotation被称为标记。这种Annotation仅用自身的存在与否来为我们提供信息,例如  
                              @override等。
元数据Annotation:包含成员变量的Annotation。因为它们可以接受更多的元数据,因此被称为元数据Annotation。

1.2 元注解
JDK提供的元注解来修饰Annotation定义
@Retention:用于指定Annotation可以保留多长时间,包含一个名为“value”的成员变量
value:
RetentionPolicy.SOURCE:Annotation只保留在源代码中,编译器编译时,直接丢弃这种Annotation。
RetentionPolicy.CLASS:编译器把Annotation记录在class文件中。当运行Java程序时,JVM中不再保留该Annotation。RetentionPolicy.RUNTIME:编译器把Annotation记录在class文件中。当运行Java程序时,JVM会保留该Annotation,
                                               程序可以通过反射获取该Annotation的信息
  1. //直接指定
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface MyTag{
  4. String name() default "我兰";
  5. }
如果Annotation里有一个名为“value“的成员变量,使用该Annotation时,可以直接使用XXX(val)形式为value成员变量赋值,无须使用name=val形式。
比如:xUtils里面的

@Target:指定Annotation用于修饰哪些程序元素。
ElementType.TYPE:能修饰类、接口或枚举类型
ElementType.FIELD:能修饰成员变量
ElementType.METHOD:能修饰方法
ElementType.PARAMETER:能修饰参数
ElementType.CONSTRUCTOR:能修饰构造器
ElementType.LOCAL_VARIABLE:能修饰局部变量
ElementType.ANNOTATION_TYPE:能修饰注解
ElementType.PACKAGE:能修饰包
  1. @Target({ ElementType.FIELD, ElementType.METHOD })
  2. public @interface AnnTest {
  3. String name() default "sunchp";
  4. }
@Documented:如果定义注解A时,使用了@Documented修饰定义,则在用javadoc命令生成API文档后,
所有使用注解A修饰的程序元素,将会包含注解A的说明。
  1. @Documented
  2. public @interface Testable {
  3. }
  4. public class Test {
  5. @Testable
  6. public void info() {
  7. }
  8. }
@Inherited:指定Annotation具有继承性。

1.3 基本Annotation
JDK默认提供了如下几个基本Annotation:

@Override 限定重写父类方法。对于子类中被@Override 修饰的方法,如果存在对应的被重写的父类方法,则正确;如果不存在,则报错。@Override 只能作用于方法,不能作用于其他程序元素。 

@Deprecated 用于表示某个程序元素(类、方法等)已过时。如果使用被@Deprecated修饰的类或方法等,编译器会发出警告

@SuppressWarning 抑制编译器警告。指示被@SuppressWarning修饰的程序元素(以及该程序元素中的所有子元素,例如类以及该类中的方法.....)取消显示指定的编译器警告。例如,常见的@SuppressWarning(value="unchecked") ;

@SafeVarargs @SafeVarargs是JDK 7 专门为抑制“堆污染”警告提供的。

2、提取Annotation信息(反射)
当开发者使用了Annotation修饰了类、方法、Field等成员之后,这些Annotation不会自己生效,
必须由开发者提供相应的代码来提取并处理Annotation信息

PS:如果想要在运行时提取注解信息,在定义注解时,该注解必须使用@Retention(RetentionPolicy.RUNTIME)修饰。

JDK主要提供了两个类,来完成Annotation的提取:
java.lang.annotation.Annotation接口:这个接口是所有Annotation类型的父接口(后面会分析Annotation的本质,
                                                                Annotation本质是接口,而java.lang.annotation.Annotation接口是这些接
                                                                口的父接口)。
  1. //java.lang.annotation.Annotation接口源码:
  2. package java.lang.annotation;
  3. public interface Annotation {
  4. boolean equals(Object obj);
  5. int hashCode();
  6. String toString();
  7. Class<? extends Annotation> annotationType();
  8. }
annotationType( ),用于返回该注解的java.lang.Class。

java.lang.reflect.AnnotatedElement接口:该接口代表程序中可以被注解的程序元素。
  1. //java.lang.reflect.AnnotatedElement接口源码:
  2. package java.lang.reflect;
  3. import java.lang.annotation.Annotation;
  4. public interface AnnotatedElement {
  5. boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
  6. <T extends Annotation> T getAnnotation(Class<T> annotationClass);
  7. Annotation[] getAnnotations();
  8. Annotation[] getDeclaredAnnotations();
  9. }
技术分享
所以程序通过反射获取了某个类的AnnotatedElement对象(例如,A类method1()方法的java.lang.reflect.Method对象)后,
就可以调用该对象的isAnnotationPresent( )、getAnnotation( )等方法来访问注解信息。

在编译器编译注解定义时,自动在class文件中,添加与成员变量同名的抽象方法,用于反射时获取成员变量的值。通过上面的示例
可以看出,其实Annotation十分简单,它是对源代码增加的一些特殊标记,这些特殊标记可通过反射获取,当程序获取这些特殊标
记后,程序可以做出相应的处理。


Demo:AnnotationTest












注解Annotation

标签:

原文地址:http://www.cnblogs.com/fruitbolgs/p/4515170.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!